Skip to main content

Bio Reactor Design (BiRD): a toolbox to simulate and analyze different designs of bioreactors in OpenFOAM

Project description

Bio Reactor Design (BiRD) bird-CI bird-pyversion coverage bird-pypi

Quick start

  1. Follow the steps to install the python package (see Installation of python package for developers or Installation of python package for users below)
  2. Follow the steps to install the BiRD OpenFOAM solver (see Installation of BiRD OpenFOAM solver (for developers and users) below)
  3. Check that you can run any of the tutorial cases, for ex:
cd tutorial_cases/bubble_column_20L
bash run.sh

Installation of python package for developers

conda create -c conda-forge --name bird python=3.10 paraview
conda activate bird
git clone https://github.com/NatLabRockies/BioReactorDesign.git
cd BioReactorDesign
pip install -e .

Installation of python package for users

conda create -c conda-forge --name bird python=3.10 paraview
conda activate bird
pip install nlr-bird=={version}

We highly recommend that you specify the version explicitly as the library is still rapidly changing.

Installation of BiRD OpenFOAM solver (for developers and users)

  1. Activate your OpenFOAM-9 environment (source <OpenFOAM-9 installation directory>/etc/<your-shell>rc)
  2. cd OFsolvers/birdmultiphaseEulerFoam/
  3. Compile ./Allwmake

Documentation

See the natlabrockies.github.io/BioReactorDesign.

References

Software record SWR 24-35

To cite BiRD, please use these articles on CO2 interphase mass transfer (open access link ) on aerobic bioreactors and on butanediol synthesis

@article{hassanaly2025bayesian,
  title={Bayesian calibration of bubble size dynamics applied to CO2 gas fermenters},
  author={Hassanaly, Malik and Parra-Alvarez, John M and Rahimi, Mohammad J and Municchi, Federico and Sitaraman, Hariswaran},
  journal={Chemical Engineering Research and Design},
  volume={215},
  pages={312--328},
  year={2025},
  publisher={Elsevier}
}

@article{rahimi2018computational,
  title={Computational fluid dynamics study of full-scale aerobic bioreactors: Evaluation of gas--liquid mass transfer, oxygen uptake, and dynamic oxygen distribution},
  author={Rahimi, Mohammad J and Sitaraman, Hariswaran and Humbird, David and Stickel, Jonathan J},
  journal={Chemical Engineering Research and Design},
  volume={139},
  pages={283--295},
  year={2018},
  publisher={Elsevier}
}

@article{sitaraman2023reacting,
  title={A reacting multiphase computational flow model for 2, 3-butanediol synthesis in industrial-scale bioreactors},
  author={Sitaraman, Hariswaran and Lischeske, James and Lu, Yimin and Stickel, Jonathan},
  journal={Chemical Engineering Research and Design},
  volume={197},
  pages={38--52},
  year={2023},
  publisher={Elsevier}
}

Acknowledgments

This work was authored in part by the National Laboratory of the Rockies (NLR) for the U.S. Department of Energy (DOE) under Contract No. DE-AC36-08GO28308. This work was supported by funding from DOE Bioenergy Technologies Office (BETO) CO2RUe consortium. The research was performed using computational resources sponsored by the Department of Energy's Office of Critical Minerals and Energy Innovation (CMEI) and located at the National Laboratory of the Rockies. The views expressed in the article do not necessarily represent the views of the DOE or the U.S. Government. The U.S. Government retains and the publisher, by accepting the article for publication, acknowledges that the U.S. Government retains a nonexclusive, paid-up, irrevocable, worldwide license to publish or reproduce the published form of this work, or allow others to do so, for U.S. Government purposes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nlr_bird-0.0.53.tar.gz (157.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nlr_bird-0.0.53-py3-none-any.whl (224.2 kB view details)

Uploaded Python 3

File details

Details for the file nlr_bird-0.0.53.tar.gz.

File metadata

  • Download URL: nlr_bird-0.0.53.tar.gz
  • Upload date:
  • Size: 157.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for nlr_bird-0.0.53.tar.gz
Algorithm Hash digest
SHA256 2feb7bb39f1ed6cbb283607e604843e1c3bd0ec2b875d313f2279167a9334a5b
MD5 c6053f520566e4fd3153ba7568432816
BLAKE2b-256 9218376c0b462821b8933bf8865a9b5272d58804f3be89b11ba6e841d86b23e0

See more details on using hashes here.

File details

Details for the file nlr_bird-0.0.53-py3-none-any.whl.

File metadata

  • Download URL: nlr_bird-0.0.53-py3-none-any.whl
  • Upload date:
  • Size: 224.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for nlr_bird-0.0.53-py3-none-any.whl
Algorithm Hash digest
SHA256 5a29b98b56ce2dca6e72ae5318ad9986dcd5b05dbbfb703451a3c6b16e914b64
MD5 8bfaf03c4b573f560a8fcf23ef392cd8
BLAKE2b-256 6dee72ea9d3cb3b7c08f41986450c53fb9ff7d04acc0b05f694fa75f64d1ace5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page