Usage

Usage

To use openstudio-backporter in a project

import openstudiobackporter

CLI

This also ships with a CLI, that you can invoke via python -m openstudiobackporter

Example:

python -m openstudiobackporter \
       --to-version 3.8.0 \
       --save-intermediate \
       --verbose \
       /path/to/model3_10_0.osm

See python -m openstudiobackporter --help for the list of command line parameters and how to use it.

usage: openstudiobackporter [-h] -t {3.8.0,3.9.0,3.10.0} [-s] [-v] osm_path

Backport an OpenStudio Model (OSM) file to an earlier version.

positional arguments:
  osm_path              Path to the input OpenStudio Model (OSM) file.

options:
  -h, --help            show this help message and exit
  -t {3.8.0,3.9.0,3.10.0}, --to-version {3.8.0,3.9.0,3.10.0}
                        Target OpenStudio version to backport to.
  -s, --save-intermediate
                        Save intermediate versions during backporting
  -v, --verbose         Enable verbose output