biosteam


Namebiosteam JSON
Version 2.49.4 PyPI version JSON
download
home_pagehttps://github.com/BioSTEAMDevelopmentGroup/biosteam
SummaryThe Biorefinery Simulation and Techno-Economic Analysis Modules
upload_time2024-12-21 05:20:21
maintainerNone
docs_urlNone
authorYoel Cortes-Pena
requires_python>=3.9
licenseMIT
keywords chemical process simulation bioprocess engineering mass and energy balance material properties phase equilibrium cabbi biorefinery biofuel bioproducts
VCS
bugtrack_url
requirements sphinx pydata_sphinx_theme sphinxcontrib-jquery sphinx_multitoc_numbering sphinx_autodoc_typehints biorefineries sphinx_design pyyaml ipykernel nbsphinx nbsphinx-link myst_parser
Travis-CI
coveralls test coverage No coveralls.
            =========================================================================
BioSTEAM: The Biorefinery Simulation and Techno-Economic Analysis Modules
=========================================================================

.. image:: http://img.shields.io/pypi/v/biosteam.svg?style=flat
   :target: https://pypi.python.org/pypi/biosteam
   :alt: Version_status
.. image:: http://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
   :target: https://biosteam.readthedocs.io/en/latest/
   :alt: Documentation
.. image:: http://img.shields.io/badge/license-UIUC-blue.svg?style=flat
   :target: https://github.com/BioSTEAMDevelopmentGroup/biosteam/blob/master/LICENSE.txt
   :alt: license
.. image:: https://img.shields.io/pypi/pyversions/biosteam.svg
   :target: https://pypi.python.org/pypi/biosteam
   :alt: Supported_versions
.. image:: https://zenodo.org/badge/164639830.svg
   :target: https://zenodo.org/badge/latestdoi/164639830
.. image:: https://coveralls.io/repos/github/BioSTEAMDevelopmentGroup/biosteam/badge.svg?branch=master
   :target: https://coveralls.io/github/BioSTEAMDevelopmentGroup/biosteam?branch=master
.. image:: https://badges.gitter.im/BioSTEAM-users/BioSTEAM.svg
   :alt: Join the chat at https://gitter.im/BioSTEAM-users/community
   :target: https://gitter.im/BioSTEAM-users/community

**Read in:** `Español <README.es.rst>`_

.. 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 BioSTEAM?
-----------------

BioSTEAM is a fast and flexible package for the design, simulation, 
techno-economic analysis, and life cycle assessment of biorefineries under uncertainty [1]_. 
BioSTEAM is built to streamline and automate early-stage technology evaluations 
and to enable rigorous sensitivity and uncertainty analyses. Complete 
biorefinery configurations are available at the `Bioindustrial-Park 
<https://github.com/BioSTEAMDevelopmentGroup/Bioindustrial-Park>`_ GitHub repository, 
BioSTEAM's premier repository for biorefinery models and results. The long-term 
growth and maintenance of BioSTEAM is supported through both community-led 
development and the research institutions invested in BioSTEAM, including the 
`Center for Advanced Bioenergy and Bioproducts Innovations (CABBI) <https://cabbi.bio/>`_. 
Through its open-source and community-lead platform, BioSTEAM aims to foster 
communication and transparency within the biorefinery research community for an 
integrated effort to expedite the evaluation of candidate biofuels and 
bioproducts.

Data on chemicals and algorithms to estimate thermodynamic properties are 
imported from `chemicals <https://github.com/CalebBell/chemicals>`_
and `thermo <https://github.com/CalebBell/chemicals>`_,
community-driven open-source libraries developed by Caleb Bell. BioSTEAM's 
premire thermodynamic engine, `ThermoSTEAM <https://github.com/BioSTEAMDevelopmentGroup/thermosteam>`_, 
builds upon these libraries to facilitate the creation of thermodynamic property packages.

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

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

    $ pip install biosteam

To get the git version, run:

    $ git clone git://github.com/BioSTEAMDevelopmentGroup/biosteam

For help on common installation issues, please visit the `documentation <https://biosteam.readthedocs.io/en/latest/#installation>`__.

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

BioSTEAM's documentation is available on the web:

    http://biosteam.readthedocs.io/

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

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

    https://github.com/BioSTEAMDevelopmentGroup/biosteam

Contributing
------------
For guidelines on how to contribute, visit:

    https://biosteam.readthedocs.io/en/latest/contributing/index.html


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 BioSTEAM license, if it is convenient for you,
please cite BioSTEAM if used in your work. Please also consider contributing
any changes you make back, and benefit the community.


About the authors
-----------------

BioSTEAM was created and developed by `Yoel Cortés-Peña <https://yoelcortes.github.io/me/>`__ as part of the `Guest Group <http://engineeringforsustainability.com/yoelcortespena>`__ and the `Center for Advanced Bioenergy and Bioproducts Innovation (CABBI) <https://cabbi.bio/>`__ at the `University of Illinois at Urbana-Champaign (UIUC) <https://illinois.edu/>`__. 

References
----------
.. [1] `Cortés-Peña et al. BioSTEAM: A Fast and Flexible Platform for the Design, Simulation, and Techno-Economic Analysis of Biorefineries under Uncertainty. ACS Sustainable Chem. Eng. 2020. <https://doi.org/10.1021/acssuschemeng.9b07040>`__.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/BioSTEAMDevelopmentGroup/biosteam",
    "name": "biosteam",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "chemical process simulation, bioprocess engineering, mass and energy balance, material properties, phase equilibrium, CABBI, biorefinery, biofuel, bioproducts",
    "author": "Yoel Cortes-Pena",
    "author_email": "yoelcortes@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/98/80/1b10ec786251354fb2c26718c5f52fe11c87b964c54e781313ed173b38d9/biosteam-2.49.4.tar.gz",
    "platform": "Windows",
    "description": "=========================================================================\r\nBioSTEAM: The Biorefinery Simulation and Techno-Economic Analysis Modules\r\n=========================================================================\r\n\r\n.. image:: http://img.shields.io/pypi/v/biosteam.svg?style=flat\r\n   :target: https://pypi.python.org/pypi/biosteam\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/\r\n   :alt: Documentation\r\n.. image:: http://img.shields.io/badge/license-UIUC-blue.svg?style=flat\r\n   :target: https://github.com/BioSTEAMDevelopmentGroup/biosteam/blob/master/LICENSE.txt\r\n   :alt: license\r\n.. image:: https://img.shields.io/pypi/pyversions/biosteam.svg\r\n   :target: https://pypi.python.org/pypi/biosteam\r\n   :alt: Supported_versions\r\n.. image:: https://zenodo.org/badge/164639830.svg\r\n   :target: https://zenodo.org/badge/latestdoi/164639830\r\n.. image:: https://coveralls.io/repos/github/BioSTEAMDevelopmentGroup/biosteam/badge.svg?branch=master\r\n   :target: https://coveralls.io/github/BioSTEAMDevelopmentGroup/biosteam?branch=master\r\n.. image:: https://badges.gitter.im/BioSTEAM-users/BioSTEAM.svg\r\n   :alt: Join the chat at https://gitter.im/BioSTEAM-users/community\r\n   :target: https://gitter.im/BioSTEAM-users/community\r\n\r\n**Read in:** `Espa\u00f1ol <README.es.rst>`_\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 BioSTEAM?\r\n-----------------\r\n\r\nBioSTEAM is a fast and flexible package for the design, simulation, \r\ntechno-economic analysis, and life cycle assessment of biorefineries under uncertainty [1]_. \r\nBioSTEAM is built to streamline and automate early-stage technology evaluations \r\nand to enable rigorous sensitivity and uncertainty analyses. Complete \r\nbiorefinery configurations are available at the `Bioindustrial-Park \r\n<https://github.com/BioSTEAMDevelopmentGroup/Bioindustrial-Park>`_ GitHub repository, \r\nBioSTEAM's premier repository for biorefinery models and results. The long-term \r\ngrowth and maintenance of BioSTEAM is supported through both community-led \r\ndevelopment and the research institutions invested in BioSTEAM, including the \r\n`Center for Advanced Bioenergy and Bioproducts Innovations (CABBI) <https://cabbi.bio/>`_. \r\nThrough its open-source and community-lead platform, BioSTEAM aims to foster \r\ncommunication and transparency within the biorefinery research community for an \r\nintegrated effort to expedite the evaluation of candidate biofuels and \r\nbioproducts.\r\n\r\nData on chemicals and algorithms to estimate thermodynamic properties are \r\nimported from `chemicals <https://github.com/CalebBell/chemicals>`_\r\nand `thermo <https://github.com/CalebBell/chemicals>`_,\r\ncommunity-driven open-source libraries developed by Caleb Bell. BioSTEAM's \r\npremire thermodynamic engine, `ThermoSTEAM <https://github.com/BioSTEAMDevelopmentGroup/thermosteam>`_, \r\nbuilds upon these libraries to facilitate the creation of thermodynamic property packages.\r\n\r\nInstallation\r\n------------\r\n\r\nGet the latest version of BioSTEAM from `PyPI <https://pypi.python.org/pypi/biosteam/>`__. If you have an installation of Python with pip, simple install it with:\r\n\r\n    $ pip install biosteam\r\n\r\nTo get the git version, run:\r\n\r\n    $ git clone git://github.com/BioSTEAMDevelopmentGroup/biosteam\r\n\r\nFor help on common installation issues, please visit the `documentation <https://biosteam.readthedocs.io/en/latest/#installation>`__.\r\n\r\nDocumentation\r\n-------------\r\n\r\nBioSTEAM's documentation is available on the web:\r\n\r\n    http://biosteam.readthedocs.io/\r\n\r\nBug reports\r\n-----------\r\n\r\nTo report bugs, please use the BioSTEAM's Bug Tracker at:\r\n\r\n    https://github.com/BioSTEAMDevelopmentGroup/biosteam\r\n\r\nContributing\r\n------------\r\nFor guidelines on how to contribute, visit:\r\n\r\n    https://biosteam.readthedocs.io/en/latest/contributing/index.html\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 BioSTEAM license, if it is convenient for you,\r\nplease cite BioSTEAM if used in your work. Please also consider contributing\r\nany changes you make back, and benefit the community.\r\n\r\n\r\nAbout the authors\r\n-----------------\r\n\r\nBioSTEAM was created and developed by `Yoel Cort\u00e9s-Pe\u00f1a <https://yoelcortes.github.io/me/>`__ as part of the `Guest Group <http://engineeringforsustainability.com/yoelcortespena>`__ and the `Center for Advanced Bioenergy and Bioproducts Innovation (CABBI) <https://cabbi.bio/>`__ at the `University of Illinois at Urbana-Champaign (UIUC) <https://illinois.edu/>`__. \r\n\r\nReferences\r\n----------\r\n.. [1] `Cort\u00e9s-Pe\u00f1a et al. BioSTEAM: A Fast and Flexible Platform for the Design, Simulation, and Techno-Economic Analysis of Biorefineries under Uncertainty. ACS Sustainable Chem. Eng. 2020. <https://doi.org/10.1021/acssuschemeng.9b07040>`__.\r\n\r\n\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "The Biorefinery Simulation and Techno-Economic Analysis Modules",
    "version": "2.49.4",
    "project_urls": {
        "Download": "https://github.com/BioSTEAMDevelopmentGroup/biosteam.git",
        "Homepage": "https://github.com/BioSTEAMDevelopmentGroup/biosteam"
    },
    "split_keywords": [
        "chemical process simulation",
        " bioprocess engineering",
        " mass and energy balance",
        " material properties",
        " phase equilibrium",
        " cabbi",
        " biorefinery",
        " biofuel",
        " bioproducts"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "98801b10ec786251354fb2c26718c5f52fe11c87b964c54e781313ed173b38d9",
                "md5": "8d4c00dda7e7a107546847d9c27d6b12",
                "sha256": "8f9397db3a1c03d381176e6433e8c831d72377546ee9cc67eba42d9e92c77eee"
            },
            "downloads": -1,
            "filename": "biosteam-2.49.4.tar.gz",
            "has_sig": false,
            "md5_digest": "8d4c00dda7e7a107546847d9c27d6b12",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 588582,
            "upload_time": "2024-12-21T05:20:21",
            "upload_time_iso_8601": "2024-12-21T05:20:21.510131Z",
            "url": "https://files.pythonhosted.org/packages/98/80/1b10ec786251354fb2c26718c5f52fe11c87b964c54e781313ed173b38d9/biosteam-2.49.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-21 05:20:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "BioSTEAMDevelopmentGroup",
    "github_project": "biosteam",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "sphinx",
            "specs": [
                [
                    ">=",
                    "7.3.7"
                ]
            ]
        },
        {
            "name": "pydata_sphinx_theme",
            "specs": [
                [
                    "==",
                    "0.15.4"
                ]
            ]
        },
        {
            "name": "sphinxcontrib-jquery",
            "specs": []
        },
        {
            "name": "sphinx_multitoc_numbering",
            "specs": []
        },
        {
            "name": "sphinx_autodoc_typehints",
            "specs": []
        },
        {
            "name": "biorefineries",
            "specs": [
                [
                    ">=",
                    "2.30.0"
                ]
            ]
        },
        {
            "name": "sphinx_design",
            "specs": []
        },
        {
            "name": "pyyaml",
            "specs": []
        },
        {
            "name": "ipykernel",
            "specs": []
        },
        {
            "name": "nbsphinx",
            "specs": []
        },
        {
            "name": "nbsphinx-link",
            "specs": []
        },
        {
            "name": "myst_parser",
            "specs": []
        }
    ],
    "lcname": "biosteam"
}
        
Elapsed time: 0.75239s