Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

biosteam

The Biorefinery Simulation and Techno-Economic Analysis Modules.
https://github.com/biosteamdevelopmentgroup/biosteam

Category: Renewable Energy
Sub Category: Bioenergy

Keywords

biochemical-process bioprocess biorefinery centrifuge chemical-engineering distillation fermentation flash heat-exchanger life-cycle-assessment monte-carlo process-simulation pump reactor sensitivity-analysis techno-economic-analysis thermodynamics unit-operation

Keywords from Contributors

vapor-liquid-equilibrium reaction properties mixture material-and-energy-balance liquid-liquid-equilibrium equations-of-state chemical uncertainty sensitivity

Last synced: about 21 hours ago
JSON representation

Repository metadata

The Biorefinery Simulation and Techno-Economic Analysis Modules

README.rst 

          =========================================================================
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 `_

.. contents::

What is BioSTEAM?
-----------------

BioSTEAM is a fast and flexible package for the design, simulation, 
techno-economic analysis, and life cycle assessment of chemical processes under uncertainty [1]_. 
BioSTEAM is built to streamline and automate early-stage technology evaluations 
and to enable rigorous sensitivity and uncertainty analyses. BioSTEAM has been 
used to model a range of fermentation-based bioproduct pathways
going from conventional/cellulosic crops, municipal solid waste, and flue gas all
the way to diols, organic acids, oleochemicals, and biofuels. Complete 
biorefinery configurations are available at the `Bioindustrial-Park 
`_ GitHub repository, 
BioSTEAM's premier repository for biorefinery models and results. Newer applications
for BioSTEAM include thermochemical upcycling of waste plastics through
pyrolysis and solvent-based dissolution and precipitation. 

The long-term growth and maintenance of BioSTEAM is supported through both community-led 
development and the research institutions invested in BioSTEAM. 
Through its open-source and community-lead platform, BioSTEAM aims to foster 
communication and transparency within the process systems research community for an 
integrated effort to expedite the development of sustainable processes.

Data on chemicals and algorithms to estimate thermodynamic properties are 
imported from `chemicals `__
and `thermo `__,
community-driven open-source libraries developed by Caleb Bell. BioSTEAM's 
premire thermodynamic engine, `ThermoSTEAM `__, 
builds upon these libraries to facilitate the creation of thermodynamic property packages.

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

Get the latest version of BioSTEAM from `PyPI `__. 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 `__.

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 originally created and developed by `Yoel Cortés-Peña `__ 
as part of the `Guest Group `__ 
and the `Center for Advanced Bioenergy and Bioproducts Innovation (CABBI) `__ 
at the `University of Illinois at Urbana-Champaign (UIUC) `__. 
Yoel is now an Assistant Professor at the National University of Singapore,
where he and his `lab group `__ 
continue to develop BioSTEAM's core simulation capabilities. 

BioSTEAM features contributons from numerous other lab groups and 
individuals. Here is the list of other core contributers who have committed significant
resources, expertise, and other impactful efforts:

* `Jeremy Guest `__ led efforts to found, develop, coordinate, and expand the software.

* `Sarang Sunil Bhagwat `__ led the development of the heat exchanger network and contributed enhancements to unit operations.

* `Yalin Li `__ contributed wastewater treatment models and general enhancements.

* `Rui Shi `__ contributed kinetic fermentation model.

BioSTEAM has also received numerous contributions from the community. You can view
direct contributions and developers through this 
`GitHub link `__.

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

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 2 days ago

Total Commits: 2,898
Total Committers: 17
Avg Commits per committer: 170.471
Development Distribution Score (DDS): 0.164

Commits in past year: 335
Committers in past year: 4
Avg Commits per committer in past year: 83.75
Development Distribution Score (DDS) in past year: 0.17

Name Email Commits
Yoel y****s@g****m 2423
cortespea c****a@a****u 139
Yalin Li m****i@g****m 94
Benjamin W. Portner b****r@b****t 87
sarangbhagwat 5****t 74
Joy Cheung j****4@g****m 42
Isaac i****e@u****s 16
Gabriel Miranda g****a@u****l 8
lkudli2 9****2 5
Brenda b****o@o****m 3
Arun Prasad a****n@e****m 1
Rupert Brandstaetter r****r@g****m 1
cansinobl c****l@g****m 1
kilavvy 1****y 1
leopardracer 1****r 1
Siddhartha Bagaria s****b@x****m 1
omahs 7****s 1

Committer domains:

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 133
Total pull requests: 130
Average time to close issues: about 2 months
Average time to close pull requests: 19 days
Total issue authors: 30
Total pull request authors: 18
Average comments per issue: 3.39
Average comments per pull request: 1.41
Merged pull request: 108
Bot issues: 0
Bot pull requests: 0

Past year issues: 11
Past year pull requests: 22
Past year average time to close issues: 19 days
Past year average time to close pull requests: 2 days
Past year issue authors: 6
Past year pull request authors: 3
Past year average comments per issue: 2.91
Past year average comments per pull request: 0.95
Past year merged pull request: 22
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/biosteamdevelopmentgroup/biosteam

Top Issue Authors

  • yalinli2 (50)
  • yoelcortes (15)
  • DmitryBachin (13)
  • sarangbhagwat (8)
  • BenPortner (6)
  • iilard (5)
  • siddharthab (3)
  • luizmartinocosta (3)
  • Omotola94 (3)
  • mretier (3)
  • adilsal33m (2)
  • Kheeley (2)
  • ard3051997 (2)
  • gaorkl (2)
  • 1226Wang1226 (1)

Top Pull Request Authors

  • yalinli2 (32)
  • yoelcortes (29)
  • sarangbhagwat (27)
  • BenPortner (13)
  • ggmirandac (4)
  • cansinobl (3)
  • IsaacLeis (3)
  • kilavvy (2)
  • omahs (2)
  • bravesasha (2)
  • brawncode (2)
  • joyxyz1994 (2)
  • omarbay (2)
  • leopardracer (2)
  • siddharthab (2)

Top Issue Labels

  • question (12)
  • enhancement (9)
  • bug (8)
  • good first issue (2)
  • documentation (2)
  • notification (2)

Top Pull Request Labels

  • enhancement (6)
  • documentation (1)

Package metadata

pypi.org: biosteam

The Biorefinery Simulation and Techno-Economic Analysis Modules

  • Homepage: https://github.com/BioSTEAMDevelopmentGroup/biosteam
  • Documentation: https://biosteam.readthedocs.io/
  • Licenses: MIT
  • Latest release: 2.54.0 (published about 2 months ago)
  • Last Synced: 2026-11-06T11:06:12.276Z (2 days ago)
  • Versions: 477
  • Dependent Packages: 2
  • Dependent Repositories: 3
  • Downloads: 16,375 Last month
  • Rankings:
    • Dependent packages count: 2.156%
    • Stargazers count: 6.085%
    • Average: 6.182%
    • Downloads: 6.193%
    • Forks count: 7.305%
    • Dependent repos count: 9.173%
  • Maintainers (1)

Dependencies

.github/workflows/build.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/publish-release.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
docs/requirements.txt pypi
  • biorefineries *
  • biosteam *
requirements.txt pypi
  • biorefineries >=2.34.1
  • cuwp >=0.0.3
  • ipykernel *
  • myst_parser *
  • nbsphinx *
  • nbsphinx-link *
  • pydata_sphinx_theme ==0.15.4
  • pyyaml *
  • sphinx ==8.1.3
  • sphinx_autodoc_typehints *
  • sphinx_design *
  • sphinx_multitoc_numbering *
  • sphinxcontrib-jquery *
setup.py pypi
  • IPython >=7.9.0
  • chaospy >=4.3.21
  • graphviz >=0.17
  • hensmith >=0.1.2
  • pyyaml *
  • thermosteam >=0.54.1
requirements_test.txt pypi
  • CoolProp * test
  • SALib * test
  • coveralls * test
  • ipykernel * test
  • myst_parser * test
  • nbsphinx * test
  • nbsphinx_link * test
  • nbval * test
  • pydata_sphinx_theme * test
  • pyglet * test
  • pytest-cov * test
  • sphinx_autodoc_typehints * test
  • sphinx_design * test
  • sphinx_multitoc_numbering * test
  • sphinxcontrib-jquery * test

Score: 18.20351743777328