Link Search Menu Expand Document

The URBANopt SDK consists of 3 main modules at its core: urbanopt-core-gem, urbanopt-scenario-gem, and urbanopt-geojson-gem.

image info

The Core gem defines a FeatureFile class. The feature file format currently supported is GeoJSON, other formats can be supported in the future as more workflows are integrated in the SDK. The FeatureFile describes properties of each Feature, such as location, floor area, number of stories, building type, cooling source, etc. This Core gem in the SDK architecture allows the development of new modules that are independent of other modules.

The GeoJSON gem is an OpenStudio Extension gem that translates a GeoJSON feature file into OpenStudio model inputs. The GeoJSON gem reads each feature from the FeatureFile (such as this example FeatureFile), converts geospatial coordinates to cartesian coordinates and extrudes geometry from 2D footprints to 3D surfaces. These properties from each Feature are translated to OpenStudio model (OSM file) inputs leveraging methods in the OpenStudio Model Articulation Gem and OpenStudio Standards Gem. Methods to translate district systems and transformers into model inputs will be addressed in future releases.

The Scenario gem does the heavy lifting in URBANopt. It takes the Scenario you want to examine (such as this example Scenario, runs the FeatureFile (translated by the GeoJSON gem) through OpenStudio building energy simulation, and reports results for each feature. These reported results are defined by the default_feature_report Measure. A run directory is created in your example project directory with folders for each Scenario and each feature_id within each Scenario. Feature level results are stored in a default_feature_report folder within the run directory for each Feature. Post-Processing may then be executed to aggregate all Feature reports of a Scenario into a Scenario level report (e.g. aggregated energy use, aggregated building program information) that is written at the top level of each Scenario folder, inside the run folder.

New developed modules can use the FeatureFile in the Core Gem to test their functionality. All developed modules are accessed via the Command Line Interface (urbanopt-cli). The Command Line Interface can then be used to connect the gems together and run/test projects.


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