========================================================================= 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::

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.

Workshops

Join us for Yoel's Fall 2022 kick-off workshops! Yoel, the lead developer, will be going over the tutorial in detail, answer any questions, and provide help with related issues.

• Aug 8 [10-11am CST]: Thermodynamics

• Aug 10 [10-11am CST]: Beginner's Guide

• Aug 15 [10-11am CST]: Process Development

• Aug 17 [10-11am CST]: Automation

For details on how to join (virtually or in-person), please email [email protected]

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>__.