BiRD
A toolbox to simulate and analyze different designs of bioreactors in OpenFOAM.
https://github.com/NatLabRockies/BioReactorDesign
Category: Renewable Energy
Sub Category: Bioenergy
Keywords
bioreactor inverse-modelling meshing openfoam postprocessing
Last synced: about 4 hours ago
JSON representation
Repository metadata
Bio Reactor Design (BiRD): a toolbox to simulate and analyze different designs of bioreactors in OpenFOAM
- Host: GitHub
- URL: https://github.com/NatLabRockies/BioReactorDesign
- Owner: NatLabRockies
- License: bsd-3-clause
- Created: 2023-05-17T00:21:33.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-19T16:43:59.000Z (14 days ago)
- Last Synced: 2026-02-24T05:36:22.568Z (9 days ago)
- Topics: bioreactor, inverse-modelling, meshing, openfoam, postprocessing
- Language: Liquid
- Homepage: https://natlabrockies.github.io/BioReactorDesign/
- Size: 120 MB
- Stars: 34
- Watchers: 9
- Forks: 14
- Open Issues: 9
- Releases: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
README.md
Bio Reactor Design (BiRD)

Quick start
- Follow the steps to install the python package (see
Installation of python package for developersorInstallation of python package for usersbelow) - Follow the steps to install the BiRD OpenFOAM solver (see
Installation of BiRD OpenFOAM solver (for developers and users)below) - 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)
- Activate your OpenFOAM-9 environment (
source <OpenFOAM-9 installation directory>/etc/<your-shell>rc) cd OFsolvers/birdmultiphaseEulerFoam/- 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.
Owner metadata
- Name: National Laboratory of the Rockies
- Login: NatLabRockies
- Email:
- Kind: organization
- Description:
- Website: http://www.nrel.gov
- Location: Golden, CO
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/1906800?v=4
- Repositories: 599
- Last ynced at: 2026-01-22T09:57:55.744Z
- Profile URL: https://github.com/NatLabRockies
GitHub Events
Total
- Pull request event: 4
- Push event: 6
- Pull request review event: 1
- Pull request review comment event: 2
- Create event: 1
Last Year
- Pull request event: 4
- Push event: 6
- Pull request review event: 1
- Pull request review comment event: 2
- Create event: 1
Committers metadata
Last synced: 3 days ago
Total Commits: 759
Total Committers: 12
Avg Commits per committer: 63.25
Development Distribution Score (DDS): 0.049
Commits in past year: 278
Committers in past year: 4
Avg Commits per committer in past year: 69.5
Development Distribution Score (DDS) in past year: 0.022
| Name | Commits | |
|---|---|---|
| Malik | m****y@g****m | 722 |
| fmuni | f****i@g****m | 17 |
| Rahimi | m****i@n****v | 4 |
| jainprana | P****n@n****v | 2 |
| hsitaram | h****n@g****m | 2 |
| Mohammad Rahimi | m****i@k****v | 2 |
| Malik Hassanaly | m****a@x****v | 2 |
| Malik Hassanaly | m****a@k****v | 2 |
| Malik Hassanaly | m****a@e****v | 2 |
| Hariswaran Sitaraman | h****m@k****v | 2 |
| Malik Hassanaly | m****a@e****v | 1 |
| Malik Hassanaly | m****a@e****v | 1 |
Committer domains:
- kl3.head.cm.kestrel.hpc.nrel.gov: 2
- nrel.gov: 2
- el2.ib0.cm.hpc.nrel.gov: 1
- el3.ib0.cm.hpc.nrel.gov: 1
- el1.ib0.cm.hpc.nrel.gov: 1
- x3100c0s5b0n0.head.cm.kestrel.hpc.nrel.gov: 1
- kd5.head.cm.kestrel.hpc.nrel.gov: 1
Issue and Pull Request metadata
Last synced: 7 days ago
Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull request: 0
Bot issues: 0
Bot pull requests: 0
Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
Top Pull Request Authors
Top Issue Labels
Top Pull Request Labels
Package metadata
- Total packages: 1
-
Total downloads:
- pypi: 129 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 2
- Total maintainers: 1
pypi.org: nlr-bird
Bio Reactor Design (BiRD): a toolbox to simulate and analyze different designs of bioreactors in OpenFOAM
- Homepage: https://github.com/NatLabRockies/BioReactorDesign
- Documentation: https://natlabrockies.github.io/BioReactorDesign
- Licenses: BSD 3-Clause License Copyright (c) 2024, Alliance for Energy Innovation, LLC Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- Latest release: 0.0.53 (published 16 days ago)
- Last Synced: 2026-03-02T04:00:36.909Z (3 days ago)
- Versions: 2
- Dependent Packages: 0
- Dependent Repositories: 0
- Downloads: 129 Last month
-
Rankings:
- Dependent packages count: 8.19%
- Average: 27.243%
- Dependent repos count: 46.296%
- Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite
- black *
- imageio *
- isort *
- matplotlib ==3.2.2
- numpy *
- numpy-stl *
- scipy *
Score: 11.113641215937145