To run URBANopt, first install the project dependencies and the URBANopt Command Line Interface.

Once the CLI is installed, help is available by typing uo -h from the command line.

  1. Create a project folder in your current directory using:

     uo -p <FOLDERNAME>
  2. Put your FeatureFile in the root of the folder you just created, or use the provided example.
  3. Create ScenarioFiles based off the example mappers using:

     uo -m -f <FEATUREFILE>

    You may write your own mapper file for your own specific use case as needed, as well as make your own ScenarioFile by hand. You may also make edits to the ScenarioFiles to mix and match mappers.

  4. Simulate energy usage of each feature in your FeatureFile by using:

  5. Aggregate simulated features into a Scenario report by using:

  6. Delete an outdated Scenario by using:

     uo -d -s <SCENARIOFILE>

Workflow Details

The figure below describes the workflow that takes place for the run and post_process calls.


The following figure represents how Simulation Mapper Classes can be assigned to different Features from the FeatureFile in the Scenario CSV.