Getting Started¶
Here is a brief overview on getting setup, running an ERI calculation, and obtaining outputs.
Setup¶
To get started:
- Either download OpenStudio 2.9.1 and install the Command Line Interface/EnergyPlus components, or use the nrel/openstudio docker image.
- Download the OpenStudio-ERI v0.8.0 Beta release.
- To obtain all available weather files, run:
openstudio workflow/energy_rating_index.rb --download-weather
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¶
Run the ERI calculation on a provided sample HPXML file as follows:
openstudio --no-ssl workflow/energy_rating_index.rb -x workflow/sample_files/base.xml
Note that the Reference Home, Rated Home and Index Adjustment Home (if applicable) simulations will be executed in parallel on the local machine.
This will generate output as shown below:
You can also request generation of hourly output CSV files as part of the calculation by providing one or more --hourly
flags.
To request all possible hourly outputs:
openstudio --no-ssl workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --hourly ALL
Or one or more specific hourly output types can be requested, e.g.:
openstudio --no-ssl workflow/energy_rating_index.rb -x workflow/sample_files/base.xml --hourly fuels --hourly temperatures
Run openstudio workflow/energy_rating_index.rb -h
to see all available commands/arguments.