[](https://github.com/urbanopt/urbanopt-cli/actions/workflows/nightly_ci_build.yml)
[](https://github.com/urbanopt/urbanopt-core-gem/actions/workflows/nightly_build.yml)
[](https://coveralls.io/github/urbanopt/urbanopt-core-gem?branch=develop)
[](https://github.com/urbanopt/urbanopt-geojson-gem/actions/workflows/nightly_build.yml)
[](https://coveralls.io/github/urbanopt/urbanopt-geojson-gem?branch=develop)
[](https://github.com/urbanopt/urbanopt-reopt-gem/actions/workflows/nightly_ci_build.yml)
[](https://coveralls.io/github/urbanopt/urbanopt-reopt-gem?branch=develop)
[](https://github.com/urbanopt/urbanopt-reporting-gem/actions/workflows/nightly_ci_build.yml)
[](https://coveralls.io/github/urbanopt/urbanopt-reporting-gem?branch=develop)
[](https://github.com/urbanopt/urbanopt-rnm-us-gem/actions/workflows/nightly_ci_build.yml)
[](https://coveralls.io/github/urbanopt/urbanopt-rnm-us-gem?branch=develop)
[](https://github.com/urbanopt/urbanopt-scenario-gem/actions/workflows/nightly_ci_build.yml)
[](https://coveralls.io/github/urbanopt/urbanopt-scenario-gem?branch=develop)
[](https://github.com/urbanopt/urbanopt-example-geojson-project/actions/workflows/weekly_build.yml)
[](https://coveralls.io/github/urbanopt/urbanopt-example-geojson-project?branch=develop)
# URBANopt CLI
This is the command line interface (CLI) for the URBANopt™ SDK.
## Installation (Using Ruby)
Add this line to your application's Gemfile:
```ruby
gem 'urbanopt-cli'
```
And then execute:
```terminal
bundle
```
Or install it yourself with:
```terminal
gem install urbanopt-cli
```
## Installation (Using Installer)
The UrbanOpt installer is an alternate way to install the UrbanOpt CLI that also includes Ruby 2.7.2 and the OpenStudio SDK.
Below are installation instructions for each platform.
### Linux (Ubuntu 18.04)
Download the [.deb package](https://docs.urbanopt.net/installation/linux.html#install-with-the-urbanopt-installer).
```terminal
sudo apt update
sudo apt install ./UrbanOptCLI-0.3.1.b6f118d506-Linux.deb
```
This will install to `/usr/local/` directory.
e.g.
`/usr/local/urbanopt-cli-0.13.0/`
To run the UrbanOpt CLI, first run the `setup-env.sh` script that generates environmental variables and stores these in `env_uo.sh` in your home directory.
```terminal
/usr/local/urbanopt-cli-0.13.0/setup-env.sh
. ~/.env_uo.sh
```
When launching new shell terminals run `. ~/.env_uo.sh` to setup the environment.
### Mac OSX (>= 10.12)
Download the [.dmg package](https://docs.urbanopt.net/installation/mac.html#install-with-the-urbanopt-installer).
Use the GUI installer and choose a directory to install. Once installed, open a terminal and run the provided setup script.
The `setup-env.sh` generates env variables and stores them in a file `.env_uo.sh` in your home directory.
```terminal
/Applications/UrbanOptCLI_0.13.0/setup-env.sh
. ~/.env_uo.sh
```
When launching new shell terminals run `. ~/.env_uo.sh` to setup the environment.
### Windows (64-bit Windows 7 – 10)
Download the [.exe installer](https://docs.urbanopt.net/installation/windows.html#install-with-the-urbanopt-installer).
Use the GUI installer and choose a directory to install. Once installed, open a terminal (Powershell, Windows CMD and GitBash are supported) and run the provided setup script for that shell (below are the setup scripts for each respective shell environment).
#### Bash (or GitBash for Windows)
```terminal
c:/urbanopt-cli-0.13.0/setup-env.sh
. ~/.env_uo.sh
```
#### Powershell or Command Prompt
```terminal
c:\urbanopt-cli-0.13.0\setup-env.ps1
. ~\.env_uo.ps1
```
#### Windows Command Prompt
After the `setup-env.ps1` script has been run:
```terminal
"%HOMEPATH%/.env_uo.bat"
```
When launching new shell terminals run the correct environment config to setup the environment.
## Usage
For help text in your terminal, type:
```terminal
uo --help
```
Create a project folder:
```terminal
uo create --project-folder
```
Overwrite an existing project folder:
```terminal
uo create --overwrite --project-folder
```
Create an empty project folder without the example files:
```terminal
uo create --empty --project-folder
```
Create ScenarioFiles from a FeatureFile using MapperFiles:
```terminal
uo create --scenario-file
```
Create a ScenarioFile using only a specific FEATURE_ID from a FEATUREFILE:
```terminal
uo create --scenario-file --single-feature
```
Create a REopt ScenarioFile from an existing ScenarioFile:
```terminal
uo create --reopt-scenario-file baseline_scenario.csv
```
Run URBANopt energy simulations for each feature in your scenario:
```terminal
uo run --scenario --feature
```
Run URBANopt energy simulations for each feature in your scenario, with REopt functionality included:
```terminal
uo run --reopt --scenario --feature
```
Post-process simulations for a full scenario:
```terminal
uo process -- --scenario --feature
```
- Valid `TYPE`s are: `default`, `opendss`, `reopt-scenario`, `reopt-feature`, `reopt-resilience`, `disco`
Delete a scenario you have already run:
```terminal
uo delete --scenario
```
Installed CLI version:
```terminal
uo --version
```
## Current Python Dependencies
Python dependencies are currently versioned as follows:
| Python Package | Version |
| --------------------------- | ------- |
| urbanopt-ditto-reader | 0.6.4 |
| NREL-disco | 0.5.1 |
| geojson-modelica-translator | 0.8.0 |
| ThermalNetwork | 0.3.0 |
## Development
To install this gem onto your local machine, clone this repo and run `bundle exec rake install`. If you make changes to this repo, update the version number in `lib/version.rb` in your first commit. When ready to release, [follow the documentation](https://docs.urbanopt.net/developer_resources/release_instructions.html).