Contents

# URBANopt Scenario Schema

The URBANopt Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results.  An URBANopt Scenario describes a specific set of options to apply to each Feature in a FeatureFile (e.g. each GeoJSON Feature in an URBANopt GeoJSON File).  User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files.  A ScenarioRunner is used to perform simulations for each SimulationDir.  Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.  The [URBANopt Scenario Gem Design Document](https://docs.google.com/document/d/1ExcGuHliaSvPlrYevAJTSV8XAtTQXz_KQqH3p4iQDwg/edit) describes the gem in more detail.  The [URBANopt Example Project](https://github.com/urbanopt/urbanopt-example-project) demonstrates how to use the URBANopt Scenario Gem to perform a scenario analysis.

## Reporting output units

**JSON Output Units**

- energy outputs: kbtu
- water rate outputs : GPM (gallon per minute)
- mass flow rate outputs : lbs/min
- Temperature outputs : °F
- area output: sf
- measured distance output: ft
- cost outputs: $

**CSV Output Units**

|            output                   |  unit   |
| ----------------------------------- | ------- |
| Electricity:Facility                | kbtu    |
| ElectricityProduced:Facility        | kbtu    |
| Gas:Facility                        | kbtu    |
| DistrictCooling:Facility            | kbtu    |
| DistrictHeating:Facility            | kbtu    |
| District Cooling Chilled Water Rate | GPM     |
| District Cooling Mass Flow Rate     | lbs/min |
| District Cooling Inlet Temperature  | °F  |
| District Cooling Outlet Temperature | °F  |
| District Heating Hot Water Rate     | GPM     |
| District Heating Mass Flow Rate     | lbs/min |
| District Heating Inlet Temperature  | °F  |
| District Heating Outlet Temperature | °F  |

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
urbanopt-scenario-0.1.0	lib/urbanopt/scenario/default_reports/schema/README.md