Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

Modelica Buildings library

A free and open source library with dynamic simulation models for building energy and control systems.
https://github.com/lbl-srg/modelica-buildings

Category: Consumption
Sub Category: Buildings and Heating

Keywords

buildings control energy-efficiency modelica

Keywords from Contributors

ernergy modelica-library mpc energyplus bim maintained award-winning ibpsa transforms mechanics

Last synced: about 19 hours ago
JSON representation

Repository metadata

Modelica Buildings library

README.md

Modelica Buildings library

Build Status

This is the development site for the Modelica Buildings library and its user guide.

Stable releases including all previous releases are available from the main project site
at http://simulationresearch.lbl.gov/modelica.

Instructions for developers are available on the wiki.

Library description

The Modelica Buildings library is a free open-source library with dynamic simulation models for building energy and control systems. The library contains models for

  • HVAC systems for buildings, district energy systems, and data centers,
  • components and systems with energy storage,
  • controls, including a reference implementation of ASHRAE Standard 231P,
  • heat transfer among rooms and the outside, either
    • natively in Modelica with a detailed or a reduced order model, or
    • integrated run-time coupling with EnergyPlus, aka, Spawn of EnergyPlus
  • multizone airflow, including natural ventilation and contaminant transport,
  • single-zone computational fluid dynamics coupled to heat transfer and HVAC systems,
  • data-driven load prediction for demand response applications, and
  • electrical DC and AC systems with two- or three-phases that can be balanced and unbalanced.

The main project site is http://simulationresearch.lbl.gov/modelica.

Current release

Download Buildings Library 12.1.0 (2025-05-29)

License

The Modelica Buildings Library is available under a 3-clause BSD-license.
See Modelica Buildings Library license.

Python modules are available under a 3-clause BSD-license. See BuildingsPy license.

Development and contribution

You may report any issues with using the Issues button.

Contributions in the form of Pull Requests are always welcome.
Prior to issuing a pull request, make sure your code follows the style guide and coding conventions.

Building binaries

The distribution at https://simulationresearch.lbl.gov/modelica/download.html
contains all binaries, and users need not do any other step.

Developers may install or build these binaries individually.

There are three different binaries:

  1. The Spawn of EnergyPlus library that contains a special version of EnergyPlus.
  2. The Modelica to EnergyPlus library that provides a layer to link
    Modelica with EnergyPlus.
  3. The fmi-library that provides the API functions that communicate
    with EnergyPlus.

To install or build these libraries, proceed as described below.

Spawn of EnergyPlus library

If the Buildings library is cloned from github, then the EnergyPlus
libraries need to be installed by running

Buildings/Resources/src/ThermalZones/install.py --binaries-for-os-only

To install the binaries for all operating systems, omit the flag --binaries-for-os-only

Modelica to EnergyPlus

Rebuilding this library requires CMake to be installed.

To rebuild the library, run

cd modelica-buildings
rm -rf build && mkdir build && cd build && \
  cmake ../ && cmake --build . --target install && \
  cd .. && rm -rf build

fmi-library

Rebuilding this library requires CMake to be installed.

To rebuild the library, run

cd Buildings/Resources/src/fmi-library
rm -rf build && mkdir build && \
  cd build && cmake .. && cmake --build . && \
  cd .. && rm -rf build

Citation

To cite the library, use

Michael Wetter, Wangda Zuo, Thierry S. Nouidui and Xiufeng Pang.
Modelica Buildings library.
Journal of Building Performance Simulation, 7(4):253-270, 2014.

@Article{WetterZuoNouiduiPang2014,
  author  =  {Michael Wetter and Wangda Zuo and Thierry S. Nouidui and Xiufeng Pang},
  title   =  {Modelica {Buildings} library},
  journal =  {Journal of Building Performance Simulation},
  volume  =  {7},
  number  =  {4},
  pages   =  {253--270},
  year    =  {2014},
  doi     =  {10.1080/19401493.2013.765506},
  url     = "https://doi.org/10.1080/19401493.2013.765506"
}

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: about 22 hours ago

Total Commits: 12,257
Total Committers: 63
Avg Commits per committer: 194.556
Development Distribution Score (DDS): 0.484

Commits in past year: 171
Committers in past year: 7
Avg Commits per committer in past year: 24.429
Development Distribution Score (DDS) in past year: 0.316

Name Email Commits
Michael Wetter m****r@l****v 6319
mwetter m****r@d****a 1028
JayHuLBL J****u@l****v 748
AntoineGautier a****r@l****v 688
Milica Grahovac m****c@l****v 621
YangyangFu y****3@m****u 580
mbonvini m****i@l****v 412
Peter Grant p****t@l****v 321
Thierry Nouidui t****i@l****v 318
kuzha k****g@l****v 208
David Blum d****m@l****v 176
Filip Jorissen f****n@k****e 99
wzuo w****o@d****a 89
Massimo Cimmino m****o@p****a 68
Casper Fu 9****u 54
tianwei1989 t****3@g****m 52
Dre Helmns a****s@b****u 48
Katy Hinkelman k****n@c****u 46
zuowangda w****o@g****m 35
tsnouidui t****i@d****a 26
Helarga h****a@l****v 23
dependabot[bot] 4****] 23
thorade m****e@g****m 21
Thierry Nouidui t****y@s****) 21
Yangyang Fu y****u@c****u 20
Kyle Benne k****e@n****v 20
xuhan425 x****6@c****u 20
Wei Tian w****n@s****m 19
Walter Z Wang z****4@g****m 19
tbeu tc@t****e 12
and 33 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 1,744
Total pull requests: 2,584
Average time to close issues: 3 months
Average time to close pull requests: 12 days
Total issue authors: 171
Total pull request authors: 65
Average comments per issue: 1.68
Average comments per pull request: 0.76
Merged pull request: 2,306
Bot issues: 0
Bot pull requests: 24

Past year issues: 165
Past year pull requests: 298
Past year average time to close issues: 19 days
Past year average time to close pull requests: 6 days
Past year issue authors: 39
Past year pull request authors: 15
Past year average comments per issue: 1.87
Past year average comments per pull request: 0.4
Past year merged pull request: 241
Past year bot issues: 0
Past year bot pull requests: 4

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/lbl-srg/modelica-buildings

Top Issue Authors

  • mwetter (818)
  • JayHuLBL (150)
  • AntoineGautier (102)
  • milicag (77)
  • dhblum (36)
  • Mathadon (34)
  • hcasperfu (32)
  • tsnouidui (31)
  • karthikeyad-pnnl (30)
  • AndreaBartolini (27)
  • casella (26)
  • kbenne (20)
  • khinkelman (14)
  • justnielsen (14)
  • mbonvini (12)

Top Pull Request Authors

  • mwetter (1,549)
  • JayHuLBL (238)
  • AntoineGautier (91)
  • hcasperfu (73)
  • milicag (63)
  • karthikeyad-pnnl (56)
  • tsnouidui (50)
  • kuzha (46)
  • SenHuang19 (42)
  • dhblum (37)
  • Helarga (34)
  • YangyangFu (27)
  • khinkelman (27)
  • Mathadon (26)
  • dependabot[bot] (24)

Top Issue Labels

  • OpenBuildingControl (118)
  • spawn (116)
  • URBANopt (64)
  • bug (46)
  • enhancement (39)
  • Fluid (32)
  • Electrical (30)
  • Rooms (17)
  • BoundaryConditions (16)
  • HeatTransfer (16)
  • non-backward compatible (15)
  • PrimarySequences (13)
  • ffd (11)
  • Unspecified (10)
  • OCT (9)
  • Controls (6)
  • ctrl-flow (6)
  • OpenModelica (5)
  • Utilities (3)
  • Linkage (3)
  • wontfix (2)
  • Airflow (2)
  • Openstudio to Modelica (1)
  • Media (1)
  • component1 (1)

Top Pull Request Labels

  • spawn (46)
  • dependencies (24)
  • python (24)
  • URBANopt (23)
  • non-backward compatible (23)
  • OpenBuildingControl (20)
  • bug (11)
  • PrimarySequences (11)
  • Electrical (4)
  • Linkage (2)
  • OpenModelica (1)
  • wontfix (1)

Package metadata

proxy.golang.org: github.com/lbl-srg/modelica-buildings

Dependencies

.github/workflows/formatting.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
Buildings/Resources/Documentation/userGuide/requirements.txt pypi
  • Babel ==2.9.1
  • Jinja2 ==3.0.3
  • MarkupSafe ==2.1.0
  • PyYAML ==6.0
  • Pygments ==2.11.2
  • Sphinx ==4.3.2
  • alabaster ==0.7.12
  • certifi ==2022.12.7
  • charset-normalizer ==2.0.12
  • docutils ==0.17.1
  • idna ==3.3
  • imagesize ==1.3.0
  • latexcodec ==2.0.1
  • packaging ==21.3
  • pybtex ==0.24.0
  • pybtex-docutils ==1.0.1
  • pyparsing ==3.0.7
  • pytz ==2021.3
  • requests ==2.27.1
  • six ==1.16.0
  • snowballstemmer ==2.2.0
  • sphinx-bootstrap-theme ==0.8.0
  • sphinxcontrib-applehelp ==1.0.2
  • sphinxcontrib-bibtex ==2.4.1
  • sphinxcontrib-devhelp ==1.0.2
  • sphinxcontrib-htmlhelp ==2.0.0
  • sphinxcontrib-jsmath ==1.0.1
  • sphinxcontrib-plantuml ==0.22
  • sphinxcontrib-qthelp ==1.0.3
  • sphinxcontrib-serializinghtml ==1.1.5
  • urllib3 ==1.26.8
Buildings/Resources/src/fluid/heatpumps/calibration/doc/requirements.txt pypi
  • Babel ==2.9.1
  • Jinja2 ==3.0.3
  • MarkupSafe ==2.1.0
  • PyYAML ==6.0
  • Pygments ==2.15.0
  • Sphinx ==4.3.2
  • alabaster ==0.7.12
  • certifi ==2023.7.22
  • charset-normalizer ==2.0.12
  • docutils ==0.17.1
  • idna ==3.3
  • imagesize ==1.3.0
  • latexcodec ==2.0.1
  • packaging ==21.3
  • pybtex ==0.24.0
  • pybtex-docutils ==1.0.1
  • pyparsing ==3.0.7
  • pytz ==2021.3
  • requests ==2.31.0
  • six ==1.16.0
  • snowballstemmer ==2.2.0
  • sphinx-bootstrap-theme ==0.8.0
  • sphinxcontrib-applehelp ==1.0.2
  • sphinxcontrib-bibtex ==2.4.1
  • sphinxcontrib-devhelp ==1.0.2
  • sphinxcontrib-htmlhelp ==2.0.0
  • sphinxcontrib-jsmath ==1.0.1
  • sphinxcontrib-plantuml ==0.22
  • sphinxcontrib-qthelp ==1.0.3
  • sphinxcontrib-serializinghtml ==1.1.5
  • urllib3 ==1.26.8

Score: -Infinity