Efforts saved in this repository is part of the Energy Data Vault (EDV) project supported by the Department of Energy. The main purpose of the workflow reflected in this repository is to 1) leverage and extract building parameters from building audit data (e.g., Auto Template, BuildingSync) and 2) use those parameters to generate synthetic meter (e.g., electricity and gas) data with the building energy simulation tool.
Setting up an environment with Ruby connected to the OpenStudio is the same as the instructions described for OpenStudio developers. Once 1) Ruby is installed, 2) EnergyPlus is installed, 3) OpenStudio is installed, and 4) OpenStudio is connected to Ruby (via openstudio.rb), bundle install should be executed to install all gems necessary for this workflow. Current working version leverages Ruby 2.5.8 and OpenStudio 3.1.0.
Workflow can be configured in various ways per user desire. Configurations listed below are defined in lib/constants.rb:
- Data source: input data for workflow.
- Simulation type: baseline only scenarios or pre-defined energy efficiency measures.
- Input and output directories.
- Variability application type: variability in building operation to be implemented in the simulation.
Custom metadata and time-series data can be standardized for creating synthetic smart meter dataset. All processed data shall be stored in data/processed directory.
-
Sample metadata metadata_template and sample time-series data timeseriesdata_template can be found in
data/rawdirecotry.- metadata used in the current workflow:
building_idxml_filenameprimary_building_typefloor_area_sqftvintageclimate_zonezipcodecityus_statelongitudelatitudenumber_of_storiesnumber_of_occupantsfuel_typeenergystar_scoremeasurement_start_datemeasurement_end_dateweather_file_name_epwweather_file_name_ddy
- metadata used in the current workflow:
-
Custom weather data can be stored in
data/weatherdirectory.
rake format_data[data_option]
-
Note that rake task
format_dataworks exclusively for Building Data Genome Project or San Francisco monthly data. Users should create a custom rake task to convert raw input data to standard format. -
Skip if BuildingSync files with sufficient building metadata imported direclty from SEED are used as input data source.
rake generate_xmls
-
The generated XML files will be saved
workflow_results/Bldg_Sync_Filesdirecotry specified inconstant.rb. These data are not to be committed. -
Skip if BuildingSync files with sufficient building metadata are imported direclty from SEED.
rake add_measured_data
-
Previously generated BuildingSync XMLs are now updated with time-series energy consumption data.
-
Skip if BuildingSync files with sufficient building metadata imported direclty from SEED.
- The following rake task will generate a csv file that contains a list of simulation scenarios specifying dedicated BuildingSync XML files and associated weather files.
rake generate_control_csv
-
The output control file contains the name of the BuildingSync file, the Standard to define buildings, and weather file names.
-
The output control file is saved in
Control_Filesdirectory perconstants.rb. -
If BuildingSync XMLs imported from SEED are to be used, the location of the directory where these XMLs are stored should be used as an additional argument to rake task.
-
Weather files (EPWs and DDYs) are required. As default, all weather files are saved in
data/weatherdirectory.
- This rake task translates BuildingSync XMLs into OSMs/OSWs for simulations:
rake simulate_batch_xml
- The generated simulation files as well as updated BuildingSync XMLs will be saved in the
workflow_results/Simulation_Filesdirectory.
- This rake task calculates Actual EUI, Modeled EUI, CVRMSE, and NMBE from measured and simulated electricity/gas data.
rake generate_metrics_result <Simulation_Files_Dir>
- Currently, only monthly data metric calculation is implmented.
- This rake task combines before and after intervention time-series data and creates a new set of time-series data that indicates before and after intervention content (e.g., energy efficiency measure, non-routine event) based on the timing of the interventions. Intervention scenarios are defined in a separate csv file.
rake export_synthetic_data path/to/configuration/csv/file
- See format of configuration csv file.
- Rubocop setting;
- Update BuildingSync files with calibrated or modeled results for CVRMSE/NMBE;
- Upgrade to Openstudio-common-measures-gem v0.3.2;
- Upgrade to OpenStudio-cli 3.2.0 once BuildingSync-gem is upgraded;
- Single building and portfolio level calibration implementation.