URBANopt Workflows
In this section you can find out more details about each of the workflows supported by URBANopt. Check out the sections below for more information on the OpenStudio measures currently used in URBANopt workflows as well as a functionality lookup table.
Measure Compatibility Details
URBANopt™ workflows use OpenStudio® measures to create building models, apply different energy conservation measures (ECMs) for different Scenarios, perform quality checks, and report results back to URBANopt. The sequence of measures is specified in an OpenStudio workflow (osw) file found in the project directory. To enable/disable a measure, modify its SKIP variable in the base_workflow.osw file either directly or via the scenario mapper file.
The table below lists the measures that are used in URBANopt workflows, what types of buildings they are compatible with, and whether they are enabled or disabled by default in the workflow file.
| Measure | Building Types | Required to Run Baseline Workflow? | Enabled by default? | Description |
|---|---|---|---|---|
| Build Residential Model | Residential | Yes | Yes | Builds the OpenStudio Model for an existing residential building |
| Set Run Period | Commercial | Yes | Yes | OpenStudio Measure used to define the number of timesteps per hour and specify the begin and end date for running the simulation |
| Change Building Location | Commercial | Yes | Yes | An OpenStudio Measure used to specify and load the EPW (weather) file. |
| Create Bar From Building Type Ratios | Commercial | Yes (unless using a detailed model) | Yes | An OpenStudio Model Articulation Measure used to create a core and perimeter bar sliced by space type. It takes in one or more building types as user arguments to create space type collections. |
| Create Typical Building From Model (1st application) | Commercial | Yes (unless using a detailed model) | Yes | An OpenStudio Model Articulation Measure that creates a custom prototype building with user-defined geometry and assigns constructions, schedules, internal loads, HVAC and other loads such as exterior lights and service water heating based on the space and sub space types. The `add_hvac` is set to `false` by default in this measure because it gets handled later in the process to account for blended space types. |
| Blended Space Type From Model | Commercial | Yes (unless using a detailed model OR CreateBar geometry workflow) | Yes | An OpenStudio Model Articulation Measure that is used to create a single space type that represents the loads and schedules of a collection of space types. It removes all previous space type assignments and hard assigns internal loads from spaces included in the building floor area. A blended space type will be created from the original internal loads and assigned at the building level. |
| Add EV Load | Commercial | No | Enabled in the EV Charging Scenario | An OpenStudio Model Articulation Measure that is used to create a single space type that represents the loads and schedules of a collection of space types. It removes all previous space type assignments and hard assigns internal loads from spaces included in the building floor area. A blended space type will be created from the original internal loads and assigned at the building level. |
| Add EMS to Control EV Charging | Commercial | No | Enabled in the EV Charging Scenario | An OpenStudio measure that implements a control system to curtail an electric vehicle (EV) charging load to better align EV charging with expected energy production from a solar PV system. |
| Urban Geometry Creation | Commercial | Yes in FloorSpace geometry workflow (unless using a detailed model) | Yes | This measure reads an URBANopt GeoJSON and creates geometry for a particular building. Surrounding buildings are included as shading structures. |
| Urban Geometry Creation Zoning | Commercial | Yes in Default and CreateBar geometry workflows (unless using a detailed model) | Yes | An URBANopt GeoJSON measure that is used to create extruded geometry for building features from GeoJSON coordinates with core and perimeter zoning, it can also account for shading from surrounding buildings. |
| Create Typical Building From Model (2nd application) | Commercial | Yes in Default and FloorSpace geometry workflows (unless using a detailed model) | Yes | A second instance of this OpenStudio Measure, which is added in the workflow after urban geometry creation and the add_hvac argument is now set to true, to add HVAC system for the blended space types. The rest of the arguments for adding constructions, space type, loads, etc. are set to false. |
| Add Chilled Water Storage Tank | Commercial | No | Enabled in the Chilled Water Storage Scenario | This measure adds a chilled water storage tank to a chilled water loop for the purpose of thermal energy storage. |
| Predicted Mean Vote | Commercial | No | Yes | An OpenStudio measure used to add the necessary data to people objects to support Predicted Mean Vote output data. |
| Add EMS Emissions Reporting | Commercial and Residential | No | No | An OpenStudio measure used to report emissions based on user-provided future and historical years as well as future, historical hourly, and historical annual subregions. |
| Reduce EPD by Percentage For Peak Hours | Commercial and Residential | No | Enabled in the Peak Hours MELs Shedding Scenario | This measure reduces electric equipment loads by a user-specified percentage for a user-specified time period (usually the peak hours). The reduction can be applied to at most three periods throughout out the year specified by the user. This is applied throughout the entire building. |
| Adjust Thermostat Setpoint by Degrees for Peak Hours | Commercial and Residential | No | Enabled in the Peak Hours Thermostat Adjust Scenario | This measure adjusts heating and cooling setpoints by a user-specified number of degrees and a user-specified time period. This is applied throughout the entire building. |
| Increase Insulation RValue for Exterior Walls | Commercial | No | Enabled in High Efficiency Scenario | An OpenStudio measure that is used to increase the R-Value of insulation for exterior walls by a specific value. This measure is skipped in the baseline Scenario and is added for all `MidRiseApartment` OpenStudio building types in the high efficiency Scenario. |
| Reduce Electric Equipment Loads By Percentage | Commercial | No | Enabled in High Efficiency Scenario | An OpenStudio Measure that is used to reduce the equipment load by a certain amount. The Measure is skipped for the baseline Scenario. For the high efficiency Scenario, the `skip_measure` argument is set to false and the measure is implemented. |
| Reduce Lighting Loads By Percentage | Commercial | No | Enabled in High Efficiency Scenario | An OpenStudio Measure that is used to reduce the lighting load by a certain amount. The measure is skipped for the baseline Scenario. For the high efficiency Scenario, the `skip_measure` argument is set to false and the measure is implemented. |
| Add Central Ice Storage | Commercial | No | Enabled in Thermal Storage Scenario | An OpenStudio measure that adds an ice storage tank to a chilled water loop for the purpose of thermal energy storage. |
| Add Central Ice HPWH | Commercial | No | Enabled in Thermal Storage Scenario | An OpenStudio measure that adds or replaces existing domestic hot water heater with air source heat pump system and allows for the addition of multiple daily flexible control time windows. The heater/tank system may charge at maximum capacity up to an elevated temperature, or float without any heat addition for a specified timeframe down to a minimum tank temperature. |
| Add Packaged Ice Storage | Commercial | No | Enabled in Thermal Storage Scenario | An OpenStudio measure that removes the cooling coils in the model and replaces them with packaged air conditioning units with integrated ice storage. |
| Export Time Series Modelica | Commercial | No | Yes | An OpenStudio reporting measure that adds the required output variables and creates a CSV file with plant loop level mass flow rates and temperatures for use in a Modelica simulation. |
| Export Modelica Loads | Commercial | No | Yes | An OpenStudio reporting measure uses the results from the EnergyPlus simulation to generate a load file for use in Modelica. This will create a MOS and a CSV file of the heating, cooling, and hot water loads. |
| OpenStudio Results | Commercial | No | No | An OpenStudio reporting measure that creates high level tables and charts pulling both from model inputs and EnergyPlus results. It has building level information as well as detail on space types, thermal zones, HVAC systems, envelope characteristics, and economics. |
| Envelope and Internal Load Breakdown | Commercial | No | No | An OpenStudio reporting measure that provides annual and monthly views into heat gains and losses for envelope and internal loads. |
| Generic QAQC | Commercial | No | No | An OpenStudio reporting measure that extracts key simulation results and performs basic model QAQC checks. |
| Default Feature Reports | Commercial and Residential | Yes | Yes | An URBANopt Scenario Measure that creates a `default_feature_reports.json` used by URBANopt Scenario Default Post-Processor. |
Functionality Example Lookup
The following table lists some of the functionality that is available in URBANopt, as well as where examples of that functionality can be found. Scroll to the right in the table to reveal additional columns and click on the links for more details.
| Feature | Commercial Example Project | Commercial-Residential Example Project (HPXML) | Example Project with electric network (OpenDSS) | Example Project with Streets (RNM) | Photovoltaics Example Project (REopt) | Floorspace Geometry Example | CreateBar Geometry Example | Additional Info |
|---|---|---|---|---|---|---|---|---|
| Default Geometry | ✔ | ✔ | ✔ | ✔ | ✔ | See Default Geometry Workflow for more details. | ||
| FloorspaceJS Geometry | ✔ | See FloorspaceJS Geometry Workflow for more details. | ||||||
| CreateBar Geometry | ✔ | See CreateBar Geometry Workflow for more details. | ||||||
| Residential Features | ✔ | Residential feature examples can be found by creating the combined example project with the CLI. See Residential Workflows for more details, including how to adjust appliance and efficiency assumptions. | ||||||
| Detailed OSM Example | ✔ | ✔ | ✔ | ✔ | ✔ | Commercial building features with IDs 7, 8, and 9 have a detailed osm specified in the GeoJSON file and code specified in the Baseline mapper. The detailed models should be placed in the `osm_building` directory within the project folder. Create one of the selected projects with the CLI to investigate this functionality further. | ||
| Detailed HPXML Example | ✔ | Residential building feature with ID 17 has a detailed HPXML specified in the GeoJSON file and code specified in the Baseline mapper. The detailed HPXML models should be placed in the `xml_building` directory within the project folder. Create a 'combined' example project with the CLI to investigate this functionality further. | ||||||
| DES Workflow | ✔ | ✔ | ✔ | ✔ | ✔ | The District Energy Systems workflow requires that the export_time_series_modelica and export_modelica_loads reporting measures be enabled to generate the results needed by the GeoJSON Modelica Translator. Create one of the selected projects with the CLI to view an example of enabling these measures in the workflow.osw file. See DES Workflow for more details. | ||
| QAQC OpenStudio Results Reporting | * | * | * | * | * | ✔ | QAQC is implemented for commercial buildings as a set of 3 reporting measures. This functionality is only enabled in the CreateBar workflow, but can be easily enabled in the workflows marked with a * by modifying the Baseline Mapper in your example project. Note that enabling this functionality will generate additional result files and will increase the size of your simulation. See QAQC Reporting for more information. | |
| Thermal Comfort Reporting | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | Thermal comfort reporting is enabled on commercial building features that do not have a detailed OSM model specified. It is implemented with the PredictedMeanVote measure. Comfort results can be found in the comfort_result section of the URBANopt reports. |
| Photovoltaics Workflows | ✔ | ; | Community photovoltaics is enabled in feature ID 14 and ground-mount photovoltaics are enabled in feature IDs 15 and 16 of the PV example project, which can be created with the CLI. Inspect the GeoJSON file to see the required fields, run the project, and post-process the results with the REopt post processor to generate the results. See Photovoltaics Workflows for more information. | |||||
| EV Charging | ✔ | ✔ | ✔ | ✔ | ✔ | EV charging examples are available in commercial building feature IDs 2-6 of the selected projects. EV charge scaling by occupancy is enabled in feature ID 2. The EV Charging Mapper is used to enable the measure required for this functionality. See the EV Charging Scenario for more information. | ||
| Carbon Emissions Reporting | ✔ | ✔ | ✔ | ✔ | ✔ | Carbon Emissions reporting is enabled in commercial building feature IDs 3 & 7, and residential feature ID 14 of the selected projects. See Carbon Emissions Reporting for more information. |
Table of contents
- REopt
- Photovoltaic Workflows
- DISCO
- OpenDSS Converter
- District Energy Systems (DES)
- Carbon Emissions
- RNM
- Residential Workflows
- Geometry Workflows
- Optimization Workflows