Link Search Menu Expand Document


CLI commands are used to run and post-process each scenario. Onscreen help is always availabe with uo --help

REopt™ Lite optimization happens during the post-processing of each scenario. Two types of REopt optimization are available: scenario-level, which optimizes for the entire district being simulated, and feature-level, which optimizes each building individually.


The type of REopt optimization is specified in the CLI call:

This command allows you to post-process a ScenarioReport in aggregate. This is suitable for community-scale optimizations.

  uo process reopt-scenario --scenario baseline_scenario.csv --feature example_project.json  

Alternatively, this command allows you to post-process a Scenario for each of its Feature Reports before aggregating into a summary in the Scenario Report. This runs REopt optimization on each building individually.

  uo process reopt-feature --scenario baseline_scenario.csv --feature example_project.json  

Depending on the type of optimization chosen, REopt Lite runs on a ScenarioReport or FeatureReport. The resulting distributed_generation attributes (including system financial and sizing attributes) are updated as shown in an example below.

  "distributed_generation": {
        "lcc_us_dollars": 100000000.0,
        "npv_us_dollars": 10000000.0,
        "year_one_energy_cost_us_dollars": 7000000.0,
        "year_one_demand_cost_us_dollars": 3000000.0,
        "year_one_bill_us_dollars": 10000000.0,
        "total_energy_cost_us_dollars": 70000000.0,
        "total_solar_pv_kw": 30000.0,
        "total_wind_kw": 0.0,
        "total_generator_kw": 0.0,
        "total_storage_kw": 2000.0,
        "total_storage_kwh": 5000.0,
        "solar_pv": [{
          "size_kw": 30000.0
        "wind": [{
          "size_kw": 0.0
        "generator": [{
          "size_kw": 0.0
        "storage": [{
          "size_kw": 2000.0,
          "size_kwh": 5000.0

Moreover, the following optimal dispatch fields are added to its timeseries CSV.

new column name unit
REopt:ElectricityProduced:Total(kW) kW
REopt:Electricity:Load:Total(kW) kW
REopt:Electricity:Grid:ToLoad(kW) kW
REopt:Electricity:Grid:ToBattery(kW) kW
REopt:Electricity:Storage:ToLoad(kW) kW
REopt:Electricity:Storage:ToGrid(kW) kW
REopt:Electricity:Storage:StateOfCharge(kW) kW
REopt:ElectricityProduced:Generator:Total(kW) kW
REopt:ElectricityProduced:Generator:ToBattery(kW) kW
REopt:ElectricityProduced:Generator:ToLoad(kW) kW
REopt:ElectricityProduced:Generator:ToGrid(kW) kW
REopt:ElectricityProduced:PV:Total(kW) kW
REopt:ElectricityProduced:PV:ToBattery(kW) kW
REopt:ElectricityProduced:PV:ToLoad(kW) kW
REopt:ElectricityProduced:PV:ToGrid(kW) kW
REopt:ElectricityProduced:Wind:Total(kW) kW
REopt:ElectricityProduced:Wind:ToBattery(kW) kW
REopt:ElectricityProduced:Wind:ToLoad(kW) kW
REopt:ElectricityProduced:Wind:ToGrid(kW) kW

NOTE: A REopt Lite solution may contain multiple PV systems. In this case the aggregate generation from all PV systems will be reported in the PV columns.

The figure below describes the workflow that takes place on implementing the run and process CLI commands.


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


URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.