thermosteam


Namethermosteam JSON
Version 0.41.0 PyPI version JSON
download
home_pagehttps://github.com/BioSTEAMDevelopmentGroup/thermosteam
SummaryBioSTEAM's Premier Thermodynamic Engine
upload_time2024-02-24 05:36:36
maintainer
docs_urlNone
authorYoel Cortes-Pena
requires_python>=3.9
licenseMIT
keywords thermodynamics chemical engineering mass and energy balance material properties phase equilibrium
VCS
bugtrack_url
requirements sphinx-reredirects
Travis-CI
coveralls test coverage No coveralls.
            ====================================================
ThermoSTEAM: BioSTEAM's Premier Thermodynamic Engine 
====================================================

.. image:: http://img.shields.io/pypi/v/thermosteam.svg?style=flat
   :target: https://pypi.python.org/pypi/thermosteam
   :alt: Version_status
.. image:: http://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
   :target: https://biosteam.readthedocs.io/en/latest/API/thermosteam/index.html
   :alt: Documentation
.. image:: https://img.shields.io/pypi/pyversions/thermosteam.svg
   :target: https://pypi.python.org/pypi/thermosteam
   :alt: Supported_versions
.. image:: http://img.shields.io/badge/license-UIUC-blue.svg?style=flat
   :target: https://github.com/BioSTEAMDevelopmentGroup/thermosteam/blob/master/LICENSE.txt
   :alt: license
.. image:: https://coveralls.io/repos/github/BioSTEAMDevelopmentGroup/thermosteam/badge.svg?branch=master
   :target: https://coveralls.io/github/BioSTEAMDevelopmentGroup/thermosteam?branch=master
   :alt: Coverage
.. image:: https://joss.theoj.org/papers/10.21105/joss.02814/status.svg
   :target: https://doi.org/10.21105/joss.02814

.. contents::

Workshops
---------
Join us on Friday, Jan 20, 9:15-10:15am CST, for a BioSTEAM workshop! 
Email biosteamdevelopmentgroup@gmail.com for details.

What is ThermoSTEAM?
--------------------

ThermoSTEAM is a standalone thermodynamic engine capable of estimating mixture 
properties, solving thermodynamic phase equilibria, and modeling stoichiometric 
reactions. ThermoSTEAM builds upon `chemicals <https://github.com/CalebBell/chemicals>`_, 
the chemical properties component of the Chemical Engineering Design Library, 
with a robust and flexible framework that facilitates the creation of property packages.  
`The Biorefinery Simulation and Techno-Economic Analysis Modules (BioSTEAM) <https://biosteam.readthedocs.io/en/latest/>`_ 
is dependent on ThermoSTEAM for the simulation of unit operations.

Installation
------------

Get the latest version of ThermoSTEAM from `PyPI <https://pypi.python.org/pypi/thermosteam/>`_.
If you have an installation of Python with pip, simple install it with::

    $ pip install thermosteam

To get the git version and install it, run::

    $ git clone --depth 100 git://github.com/BioSTEAMDevelopmentGroup/thermosteam
    $ cd thermosteam
    $ pip install .

We use the `depth` option to clone only the last 100 commits. Thermosteam has a 
long history, so cloning the whole repository (without using the depth option)
may take over 30 min.

If you would like to clone all branches, add the "--no-single-branch" flag as such::

    $ git clone --depth 100 --no-single-branch git://github.com/BioSTEAMDevelopmentGroup/thermosteam

Documentation
-------------

ThermoSTEAM's documentation is available on the web:

    https://biosteam.readthedocs.io/en/latest/API/thermosteam/index.html

Bug reports
-----------

To report bugs, please use the ThermoSTEAM's Bug Tracker at:

    https://github.com/BioSTEAMDevelopmentGroup/thermosteam


License information
-------------------

See ``LICENSE.txt`` for information on the terms & conditions for usage
of this software, and a DISCLAIMER OF ALL WARRANTIES.

Although not required by the ThermoSTEAM license, if it is convenient for you,
please cite ThermoSTEAM if used in your work. Please also consider contributing
any changes you make back, and benefit the community.


Citation
--------

To cite ThermoSTEAM in publications use::

    Cortes-Pena, Y., (2020). ThermoSTEAM: BioSTEAM's Premier Thermodynamic Engine. 
    Journal of Open Source Software, 5(56), 2814. doi.org/10.21105/joss.02814

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/BioSTEAMDevelopmentGroup/thermosteam",
    "name": "thermosteam",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "thermodynamics,chemical engineering,mass and energy balance,material properties,phase equilibrium",
    "author": "Yoel Cortes-Pena",
    "author_email": "yoelcortes@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/a5/22/cf4cabbbb5433b61de732d4f9dc3b4d13b90833871d9deae6e12a4d4c85e/thermosteam-0.41.0.tar.gz",
    "platform": "Windows",
    "description": "====================================================\r\nThermoSTEAM: BioSTEAM's Premier Thermodynamic Engine \r\n====================================================\r\n\r\n.. image:: http://img.shields.io/pypi/v/thermosteam.svg?style=flat\r\n   :target: https://pypi.python.org/pypi/thermosteam\r\n   :alt: Version_status\r\n.. image:: http://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat\r\n   :target: https://biosteam.readthedocs.io/en/latest/API/thermosteam/index.html\r\n   :alt: Documentation\r\n.. image:: https://img.shields.io/pypi/pyversions/thermosteam.svg\r\n   :target: https://pypi.python.org/pypi/thermosteam\r\n   :alt: Supported_versions\r\n.. image:: http://img.shields.io/badge/license-UIUC-blue.svg?style=flat\r\n   :target: https://github.com/BioSTEAMDevelopmentGroup/thermosteam/blob/master/LICENSE.txt\r\n   :alt: license\r\n.. image:: https://coveralls.io/repos/github/BioSTEAMDevelopmentGroup/thermosteam/badge.svg?branch=master\r\n   :target: https://coveralls.io/github/BioSTEAMDevelopmentGroup/thermosteam?branch=master\r\n   :alt: Coverage\r\n.. image:: https://joss.theoj.org/papers/10.21105/joss.02814/status.svg\r\n   :target: https://doi.org/10.21105/joss.02814\r\n\r\n.. contents::\r\n\r\nWorkshops\r\n---------\r\nJoin us on Friday, Jan 20, 9:15-10:15am CST, for a BioSTEAM workshop! \r\nEmail biosteamdevelopmentgroup@gmail.com for details.\r\n\r\nWhat is ThermoSTEAM?\r\n--------------------\r\n\r\nThermoSTEAM is a standalone thermodynamic engine capable of estimating mixture \r\nproperties, solving thermodynamic phase equilibria, and modeling stoichiometric \r\nreactions. ThermoSTEAM builds upon `chemicals <https://github.com/CalebBell/chemicals>`_, \r\nthe chemical properties component of the Chemical Engineering Design Library, \r\nwith a robust and flexible framework that facilitates the creation of property packages.  \r\n`The Biorefinery Simulation and Techno-Economic Analysis Modules (BioSTEAM) <https://biosteam.readthedocs.io/en/latest/>`_ \r\nis dependent on ThermoSTEAM for the simulation of unit operations.\r\n\r\nInstallation\r\n------------\r\n\r\nGet the latest version of ThermoSTEAM from `PyPI <https://pypi.python.org/pypi/thermosteam/>`_.\r\nIf you have an installation of Python with pip, simple install it with::\r\n\r\n    $ pip install thermosteam\r\n\r\nTo get the git version and install it, run::\r\n\r\n    $ git clone --depth 100 git://github.com/BioSTEAMDevelopmentGroup/thermosteam\r\n    $ cd thermosteam\r\n    $ pip install .\r\n\r\nWe use the `depth` option to clone only the last 100 commits. Thermosteam has a \r\nlong history, so cloning the whole repository (without using the depth option)\r\nmay take over 30 min.\r\n\r\nIf you would like to clone all branches, add the \"--no-single-branch\" flag as such::\r\n\r\n    $ git clone --depth 100 --no-single-branch git://github.com/BioSTEAMDevelopmentGroup/thermosteam\r\n\r\nDocumentation\r\n-------------\r\n\r\nThermoSTEAM's documentation is available on the web:\r\n\r\n    https://biosteam.readthedocs.io/en/latest/API/thermosteam/index.html\r\n\r\nBug reports\r\n-----------\r\n\r\nTo report bugs, please use the ThermoSTEAM's Bug Tracker at:\r\n\r\n    https://github.com/BioSTEAMDevelopmentGroup/thermosteam\r\n\r\n\r\nLicense information\r\n-------------------\r\n\r\nSee ``LICENSE.txt`` for information on the terms & conditions for usage\r\nof this software, and a DISCLAIMER OF ALL WARRANTIES.\r\n\r\nAlthough not required by the ThermoSTEAM license, if it is convenient for you,\r\nplease cite ThermoSTEAM if used in your work. Please also consider contributing\r\nany changes you make back, and benefit the community.\r\n\r\n\r\nCitation\r\n--------\r\n\r\nTo cite ThermoSTEAM in publications use::\r\n\r\n    Cortes-Pena, Y., (2020). ThermoSTEAM: BioSTEAM's Premier Thermodynamic Engine. \r\n    Journal of Open Source Software, 5(56), 2814. doi.org/10.21105/joss.02814\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "BioSTEAM's Premier Thermodynamic Engine",
    "version": "0.41.0",
    "project_urls": {
        "Download": "https://github.com/BioSTEAMDevelopmentGroup/thermosteam.git",
        "Homepage": "https://github.com/BioSTEAMDevelopmentGroup/thermosteam"
    },
    "split_keywords": [
        "thermodynamics",
        "chemical engineering",
        "mass and energy balance",
        "material properties",
        "phase equilibrium"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a522cf4cabbbb5433b61de732d4f9dc3b4d13b90833871d9deae6e12a4d4c85e",
                "md5": "632d86eafe4a94f9d7aaa0f6f089226d",
                "sha256": "8ab4682839ddbe12e243a9d892cf9994af299b286c32a701471bb7b0ac502a5b"
            },
            "downloads": -1,
            "filename": "thermosteam-0.41.0.tar.gz",
            "has_sig": false,
            "md5_digest": "632d86eafe4a94f9d7aaa0f6f089226d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 1885342,
            "upload_time": "2024-02-24T05:36:36",
            "upload_time_iso_8601": "2024-02-24T05:36:36.518793Z",
            "url": "https://files.pythonhosted.org/packages/a5/22/cf4cabbbb5433b61de732d4f9dc3b4d13b90833871d9deae6e12a4d4c85e/thermosteam-0.41.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-24 05:36:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "BioSTEAMDevelopmentGroup",
    "github_project": "thermosteam",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "appveyor": true,
    "requirements": [
        {
            "name": "sphinx-reredirects",
            "specs": []
        }
    ],
    "lcname": "thermosteam"
}
        
Elapsed time: 0.29677s