Usage Instructions¶
Setup¶
To get started:
- Either download OpenStudio 3.6.1 and install the Command Line Interface/EnergyPlus/C++ API components, or use the nrel/openstudio docker image.
- Download the latest release release.
Note
If the 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.
Running Calculations¶
Run all calculations (e.g., ERI, ENERGY STAR, etc.) on a provided sample HPXML file as follows:
openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml
Note that all simulations will be executed in parallel if there are sufficient cpus/cores available.
This will generate output as shown below:
You can also request generation of timeseries output CSV files as part of the calculation by providing one or more timeseries flags (--hourly
, --daily
, or --monthly
).
For example, to request all possible hourly outputs:
openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --hourly ALL
Or for example, one or more specific monthly output types can be requested, e.g.:
openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --monthly fuels --monthly temperatures
You can also skip simulations (i.e., just generate the ERI Reference/Rated Home HPXMLs) by using, e.g.:
openstudio workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --skip-simulation
Run openstudio workflow/energy_rating_index.rb -h
to see all available commands/arguments.
Output¶
Upon completion, results are provided in the console (stdout) as well as available in summary output files. See the Workflow Outputs section for a description of all available outputs.