Difference between revisions of "OpenStudio/Building Component Library"
(5 intermediate revisions by the same user not shown) | |||
Line 6: | Line 6: | ||
The BCL currently contains more than 30,000 components and measures. A search API has been implemented on the BCL that allows users to filter through the search results using various facets. Facet categories include component and measure types, data source, and energy modeling software type. All attributes of a component or measure can also be used to filter the results. Visit the NREL BCL [https://bcl.nrel.gov/tags tags and attributes page] for a complete list of tags used to categories the content and attributes that can be used to narrow down search results. The [https://bcl.nrel.gov/documentation API Documentation page] has API syntax guidance as well as search and download examples. | The BCL currently contains more than 30,000 components and measures. A search API has been implemented on the BCL that allows users to filter through the search results using various facets. Facet categories include component and measure types, data source, and energy modeling software type. All attributes of a component or measure can also be used to filter the results. Visit the NREL BCL [https://bcl.nrel.gov/tags tags and attributes page] for a complete list of tags used to categories the content and attributes that can be used to narrow down search results. The [https://bcl.nrel.gov/documentation API Documentation page] has API syntax guidance as well as search and download examples. | ||
+ | |||
+ | = Contributing = | ||
+ | The BCL uses [https://github.com/BuildingComponentLibrary GitHub repositories] to manage component and measure content from various users. The Contribute Data page guides users through the process of: | ||
+ | # creating components and measures, | ||
+ | # gathering them into a GitHub repository, | ||
+ | # registering the repository with the BCL Manifest, and | ||
+ | # configuring a webhook to automatically send content to the BCL when a release is made on the repository. | ||
+ | |||
+ | = Miscellaneous Guides = | ||
+ | * [[OpenStudio/Building Component Library/Creating New BCL Repository|Creating New BCL Repository]] | ||
+ | |||
+ | = Important Repositories = | ||
+ | While there are 8 total repositories on the [https://github.com/BuildingComponentLibrary Building Component Library GitHub page], 5 of these repositories contain data, and measures that provide utility for OpenStudio and EnergyPlus simulations. | ||
+ | |||
+ | * [https://github.com/BuildingComponentLibrary/bcl-manifest bcl-manifest] | ||
+ | ** This repository contains a manifest of all GitHub repositories that provide content to the BCL. Repositories can either be ''component'' or ''measure'' type repositories. Attributed repositories must be public and are hosted on GitHub.com. | ||
+ | * [https://github.com/BuildingComponentLibrary/nrel-components nrel-components] | ||
+ | ** Contains the bulk of the BCL components generated by NREL. Location-Dependent Components such as weather files and design days are stored in separate repositories. Components generated during the TPEx to BCL conversion are stored in the TPEX Components repository. | ||
+ | * [https://github.com/BuildingComponentLibrary/design-day-components-1 design-day-components-1] | ||
+ | * [https://github.com/BuildingComponentLibrary/design-day-components-2 design-day-components-2] | ||
+ | * [https://github.com/BuildingComponentLibrary/nrel-components location-dependent-components] | ||
= OpenStudio = | = OpenStudio = |
Latest revision as of 01:42, 29 April 2025
The Building Component Library (BCL) is the U.S. Department of Energy's comprehensive online searchable library of energy modeling building blocks and descriptive metadata. Novice users and seasoned practitioners can use the freely available and uniquely identifiable components to create energy models and cite the sources of input data, which will increase the credibility and reproducibility of their simulations[1].
The BCL contains components which are the building blocks of an energy model. They can represent physical characteristics of the building such as roofs, walls, and windows, or can refer to related operational information such as occupancy and equipment schedules and weather information. Each component is identified through a set of attributes that are specific to its type, as well as other metadata such as provenance information and associated files.
The BCL also contains energy conservation measures (ECM), referred to as measures, which describe a change to a building and its associated model. For the BCL, this description attempts to define a measure for reproducible application, either to compare it to a baseline model, to estimate potential energy savings, or to examine the effects of a particular implementation.
The BCL currently contains more than 30,000 components and measures. A search API has been implemented on the BCL that allows users to filter through the search results using various facets. Facet categories include component and measure types, data source, and energy modeling software type. All attributes of a component or measure can also be used to filter the results. Visit the NREL BCL tags and attributes page for a complete list of tags used to categories the content and attributes that can be used to narrow down search results. The API Documentation page has API syntax guidance as well as search and download examples.
Contributing[edit]
The BCL uses GitHub repositories to manage component and measure content from various users. The Contribute Data page guides users through the process of:
- creating components and measures,
- gathering them into a GitHub repository,
- registering the repository with the BCL Manifest, and
- configuring a webhook to automatically send content to the BCL when a release is made on the repository.
Miscellaneous Guides[edit]
Important Repositories[edit]
While there are 8 total repositories on the Building Component Library GitHub page, 5 of these repositories contain data, and measures that provide utility for OpenStudio and EnergyPlus simulations.
- bcl-manifest
- This repository contains a manifest of all GitHub repositories that provide content to the BCL. Repositories can either be component or measure type repositories. Attributed repositories must be public and are hosted on GitHub.com.
- nrel-components
- Contains the bulk of the BCL components generated by NREL. Location-Dependent Components such as weather files and design days are stored in separate repositories. Components generated during the TPEx to BCL conversion are stored in the TPEX Components repository.
- design-day-components-1
- design-day-components-2
- location-dependent-components
OpenStudio[edit]
The BCL provides users of OpenStudio with a wealth of schedules, building materials. Generally speaking, the BCL provides both measures (see OpenStudio/OpenStudio Measure) and components in .idf and .osm file formats.
External References[edit]
Notes[edit]
- ↑ The National Renewable Energy Laboratory. (2025). About - BCL. Nrel.gov; Alliance for Sustainable Energy LLC. https://bcl.nrel.gov/about
![]() |
This page is OpenStudio documentation. Full documentation is available at the OpenStudio website. All articles in the OSArch wiki related to OpenStudio can be seen in the OpenStudio Category |