Science Score: 57.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
○Academic publication links
-
✓Committers with academic emails
19 of 63 committers (30.2%) from academic institutions -
✓Institutional organization owner
Organization lbl-srg has institutional domain (buildings.lbl.gov) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (16.3%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Modelica Buildings library
Basic Info
- Host: GitHub
- Owner: lbl-srg
- Language: Modelica
- Default Branch: master
- Size: 448 MB
Statistics
- Stars: 289
- Watchers: 42
- Forks: 169
- Open Issues: 198
- Releases: 28
Topics
Metadata Files
README.md
Modelica Buildings library
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
- Name: Berkeley Lab - Modeling & Simulation
- Login: lbl-srg
- Kind: organization
- Website: https://buildings.lbl.gov/modeling-simulation
- Repositories: 18
- Profile: https://github.com/lbl-srg
GitHub Events
Total
- Fork event: 11
- Create event: 149
- Commit comment event: 1
- Release event: 4
- Issues event: 129
- Watch event: 35
- Delete event: 126
- Issue comment event: 314
- Push event: 686
- Gollum event: 2
- Pull request review event: 272
- Pull request review comment event: 210
- Pull request event: 331
Last Year
- Fork event: 11
- Create event: 149
- Commit comment event: 1
- Release event: 4
- Issues event: 129
- Watch event: 35
- Delete event: 126
- Issue comment event: 314
- Push event: 686
- Gollum event: 2
- Pull request review event: 272
- Pull request review comment event: 210
- Pull request event: 331
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Michael Wetter | m****r@l****v | 6,320 |
| mwetter | m****r@d****a | 1,028 |
| JayHuLBL | J****u@l****v | 755 |
| AntoineGautier | a****r@l****v | 689 |
| 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 | 57 |
| 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 |
| xuhan425 | x****6@c****u | 20 |
| Kyle Benne | k****e@n****v | 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 (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 1,706
- Total pull requests: 2,938
- Average time to close issues: 3 months
- Average time to close pull requests: 12 days
- Total issue authors: 173
- Total pull request authors: 65
- Average comments per issue: 1.62
- Average comments per pull request: 0.75
- Merged pull requests: 2,589
- Bot issues: 0
- Bot pull requests: 34
Past Year
- Issues: 104
- Pull requests: 382
- Average time to close issues: 13 days
- Average time to close pull requests: 4 days
- Issue authors: 34
- Pull request authors: 16
- Average comments per issue: 0.96
- Average comments per pull request: 0.38
- Merged pull requests: 297
- Bot issues: 0
- Bot pull requests: 2
Top Authors
Issue Authors
- mwetter (806)
- JayHuLBL (148)
- AntoineGautier (92)
- milicag (77)
- dhblum (34)
- Mathadon (33)
- AndreaBartolini (32)
- tsnouidui (31)
- hcasperfu (30)
- karthikeyad-pnnl (28)
- casella (24)
- kbenne (19)
- justnielsen (14)
- khinkelman (14)
- mbonvini (12)
Pull Request Authors
- mwetter (1,742)
- JayHuLBL (270)
- AntoineGautier (112)
- hcasperfu (96)
- karthikeyad-pnnl (82)
- milicag (63)
- SenHuang19 (62)
- tsnouidui (50)
- dhblum (48)
- kuzha (46)
- dependabot[bot] (34)
- Helarga (34)
- khinkelman (28)
- YangyangFu (27)
- Mathadon (26)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 28
proxy.golang.org: github.com/lbl-srg/modelica-buildings
- Documentation: https://pkg.go.dev/github.com/lbl-srg/modelica-buildings#section-documentation
-
Latest release: v12.1.0+incompatible
published 9 months ago
Rankings
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite
- 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
- 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