The raw data used by the library. Files in this directory should not contain code.
These files contain information on construction and material costs. Not used by most Standards.
These files contain 3D building geometry that is often used as a starting point for typical models. It also contains JSON files that describe the HVAC systems to be used with the geometry.
These files contain information from energy codes/standards, as well as typical building characteristics. Examples include HVAC efficiency values, performance curves, construction U-values, and schedules. The code accesses this information when applying a standard or creating a typical building.
Rather than editing the JSON files directly, developers should edit The OpenStudio_Standards Google Spreadsheet or make a pull request to the building energy standards database.
- To get edit access to this spreadsheet, contact mailto:[email protected].
These files contain weather information for representative locations. The .epw files contain typical annual weather data, the .ddy files contain design day information, and the .stat files contain a summary of the weather in that location.
This is where the documentation (like this very page) lives. Note that the code documentation is not here. Those pages are generated on-the-fly from the source code, and are not committed to the repository. The scorecards directory contains model information for the SmallOfficeDetailed, MediumOfficeDetailed, LargeOfficeDetailed, Laboratory, DataCenter, Tall, SuperTall, and Supermarket prototypes.
The functional code that makes up the openstudio-standards library.
These files contain methods to apply the Canadian energy code (NECB) to models, as well as code to create the typical Canadian prototype models. Many of the methods in here are duplicative of methods in the /standards directory, and will be migrated there over time.
The Constructions module provides methods create, modify, and get information about model Constructions
The CreateTypical module provides methods to create and modify an entire building energy model of a typical building
The Daylighting module provides methods to add daylighting to a Space
The Geometry module provides methods to create, modify, and get information about model geometry
The HVAC module provides methods create, modify, and get information about HVAC systems in the model
The Infiltration module provides methods create, modify, and get information about model infiltration
These files apply typical assumptions that are not governed by a standard, and for which reasonable values exist. For example, the configuration of the HVAC systems, assumptions for fan pressure drops, etc. These assumptions come from sources like the DOE Prototype, the DOE Reference Buildings, and the Canadian Archetype Buildings.
The QAQC module provides method to check model validity
This file contains a list of codes, standards, technical reports, and other documents that are referenced in the documentation for methods in the library.
The Schedules module provides methods to create, modify, and get information about Schedule objects
The ServiceWaterHeating module provides methods to create, modify, and get information about service water heating
The Space module provides methods get information about model spaces
The SqlFile module provides methods to get information from the EnergyPlus .sql file after a run
These files modify model inputs to meet a specific standard. For example, there is a method that modifies a Chiller:Electric:EIR and sets its COP and performance curves based on the selected standard, the capacity, and the compressor type. These methods rely on the information in the /data/standards directory for lookups.
Each subdirectory contains methods for a specific standard. Methods that are defined higher up in the directory structure may be re-implemented (and therefore overwritten) by methods further down in the structure.
The ThermalZone module provides methods get information about model thermal zones
These files contain methods to perform common tasks such as runnning simulations, logging errors, etc.
The Weather module provides methods to set and get information for model weather files
This directory contains unit tests which run various portions of the code and ensure that it is working. When new functionality is added to this library, corresponding unit tests should be added as well.