Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

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/NREL/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 nrel-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 nrel.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 by the National Renewable Energy Laboratory (NREL), operated by Alliance for Sustainable Energy, LLC, 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 Energy Efficiency and Renewable Energy and located at the National Renewable Energy Laboratory. 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.

Metadata

Release files for nrel-bird 0.0.51

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nrel-bird 0.0.51
File Size Uploaded
nrel_bird-0.0.51.tar.gz 77.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nrel-bird 0.0.51
File Interpreter ABI Platform
nrel_bird-0.0.51-py3-none-any.whl Python 3 none any Details

Total release size: 172.6 kB

Release files / nrel_bird-0.0.51.tar.gz

Download URL nrel_bird-0.0.51.tar.gz
Size 77.3 kB
Tags Source
SHA-256 checksum
How to use checksums
eaad6cfe827cf113e5a16d769788dd49192e73d68e007e0ab3e185818a121190
BLAKE2b-256 checksum
How to use checksums
1028fcca853b31e17505a8cad69be9395894a4de2cd6b3c05de67bca1571ff21
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.10.16

Release files / nrel_bird-0.0.51-py3-none-any.whl

Download URL nrel_bird-0.0.51-py3-none-any.whl
Size 95.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
855489f773ad929114d5375e33a7eb9f6e02353379c8d7c0d202ebf9466cfc7a
BLAKE2b-256 checksum
How to use checksums
fef9b950387b28c06853565e4955c715d024fab31b75fc070ed1d83cf64101f4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.10.16
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page