Run the Project
Both buildstockbatch and run_analysis.rb can used to run ResStock analyses. They use a common project definition, the YAML file, to provide the details of the analysis. See the Residential HPXML Workflow Generator documentation page for more information.
See the BuildStock Batch documentation for information on running projects (large-scale).
You also have the option of running (small-scale) projects using the OpenStudio Command Line Interface (CLI) with buildstockbatch yml input files. This method needs only the OpenStudio CLI.
The primary differences relative to buildstockbatch are:
Debugging: Individual, or sets of (e.g., 1, 2, 4), building ID(s) from the entire sampled space can be run. (See the related
Convenience: Simulation input files (both OSW and HPXML) are collected and stored on-the-fly. (See the related
Size: Folders containing intermediate files can be either preserved or successively overwritten. (See the related
Accessibility: Simulation input and output files are organized and stored differently, and are not tarred or compressed.
Call the OpenStudio CLI with the provided
openstudio workflow/run_analysis.rb -y project_testing/testing_baseline.yml
The previous command samples from
project_testing and runs simulations using baseline workflows generated from the specified yml file.
An “output directory” (as specified in the yml file) is created with all input (OSW and HPXML) files and simulation results.
openstudio command is not found, it’s because the executable is not in your PATH. Either add the executable to your PATH or point directly to the executable found in the openstudio-X.X.X/bin directory.
You can also request that only measures are applied (i.e., no simulations are run) using the
openstudio workflow/run_analysis.rb -y project_testing/testing_baseline.yml -m
openstudio workflow/run_analysis.rb -h to see all available commands/arguments:
$ openstudio workflow/run_analysis.rb -h
Usage: run_analysis.rb -y buildstockbatch.yml
e.g., run_analysis.rb -y national_baseline.yml
-y, --yml <FILE> YML file
-n, --threads N Number of parallel simulations (defaults to processor count)
-m, --measures_only Only run the OpenStudio and EnergyPlus measures
-i, --building_id ID Only run this building ID; can be called multiple times
-k, --keep_run_folders Preserve run folder for all datapoints; also populates run folder in cli_output.log and results-xxx.csv files
-s, --samplingonly Run the sampling only
-d, --debug Preserve lib folder and xml/osw files for existing building
-o, --overwrite Overwrite existing project directory
-v, --version Display version
-h, --help Display help
At this time the
residential_quota_downselect sampler with
resample is not supported.
EPW weather files must be contained in a
weather folder at the same level as the
workflow folder (i.e., at the top level of the repository).
If no such folder is present, or if the
weather folder does not contain any
*.epw files, it will automatically be created/populated based on the
weather_files_path) present in the specified yml file.