A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

BiRD

A toolbox to simulate and analyze different designs of bioreactors in OpenFOAM.
https://github.com/nrel/bioreactordesign

Category: Renewable Energy
Sub Category: Bioenergy

Keywords

bioreactor inverse-modelling meshing openfoam postprocessing

Last synced: about 12 hours ago
JSON representation

Repository metadata

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

README.md

Bio Reactor Design (BiRD) bird-CI bird-pyversion 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 --name bird python=3.10
conda activate bird
git clone https://github.com/NREL/BioReactorDesign.git
cd BioReactorDesign
pip install -e .

Installation of python package for users

conda create --name bird python=3.10
conda activate bird
pip install nrel-bird

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{hassanaly2025inverse,
    title={Bayesian calibration of bubble size dynamics applied to \ce{CO2} gas fermenters},
    author={Hassanaly, Malik and Parra-Alvarez, John M. and Rahimi, Mohammad J., Municchi, Federico and Sitaraman, Hariswaran},
    journal={Chemical Engineering Research and Design},
    year={2025},
  }

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


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 481
Total Committers: 9
Avg Commits per committer: 53.444
Development Distribution Score (DDS): 0.064

Commits in past year: 232
Committers in past year: 6
Avg Commits per committer in past year: 38.667
Development Distribution Score (DDS) in past year: 0.112

Name Email Commits
Malik m****y@g****m 450
fmuni f****i@g****m 17
Rahimi m****i@n****v 4
hsitaram h****n@g****m 2
Mohammad Rahimi m****i@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:


Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 49
Total pull requests: 87
Average time to close issues: 2 months
Average time to close pull requests: 1 day
Total issue authors: 6
Total pull request authors: 4
Average comments per issue: 0.69
Average comments per pull request: 0.17
Merged pull request: 78
Bot issues: 0
Bot pull requests: 0

Past year issues: 28
Past year pull requests: 65
Past year average time to close issues: 17 days
Past year average time to close pull requests: 2 days
Past year issue authors: 6
Past year pull request authors: 4
Past year average comments per issue: 1.11
Past year average comments per pull request: 0.23
Past year merged pull request: 56
Past year bot issues: 0
Past year bot pull requests: 0

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

Top Issue Authors

  • malihass (42)
  • asela326 (2)
  • fmuni (2)
  • sustainapower (1)
  • MoritzImendoerffer (1)
  • djinnome (1)

Top Pull Request Authors

  • malihass (83)
  • fmuni (2)
  • mjrahimi (1)
  • sabinala (1)

Top Issue Labels

  • good first issue (2)
  • documentation (1)
  • enhancement (1)
  • help wanted (1)

Top Pull Request Labels


Package metadata

pypi.org: nrel-bird

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

  • Homepage: https://github.com/NREL/BioReactorDesign
  • Documentation: https://nrel.github.io/BioReactorDesign/
  • Licenses: BSD 3-Clause
  • Latest release: 0.0.18 (published 3 months ago)
  • Last Synced: 2025-04-26T02:30:50.877Z (1 day ago)
  • Versions: 14
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 195 Last month
  • Rankings:
    • Dependent packages count: 9.811%
    • Average: 37.272%
    • Dependent repos count: 64.733%
  • Maintainers (1)

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
requirements.txt pypi
  • black *
  • imageio *
  • isort *
  • matplotlib ==3.2.2
  • numpy *
  • numpy-stl *
  • scipy *

Score: 11.001699761182898