Contents

# URBANopt Cli

This is the command line interface (CLI) for URBANopt.

## Installation

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
```

## Usage

For help text in your terminal, type:

```terminal
uo -h
```

Create a project folder:

```terminal
uo -p <FOLDERNAME>
```

Overwrite an existing project folder:

```terminal
uo -o -p <FOLDERNAME>
```

Create an empty project folder without the example files:

```terminal
uo -e -p <FOLDERNAME>

Make ScenarioFiles from a FeatureFile using MapperFiles:

```terminal
uo -m -f <FEATUREFILE>
```

Make a ScenarioFile using only a specific FEATURE_ID from a FEATUREFILE:

```terminal
uo -m -f <FEATUREFILE> -i <FEATURE_ID>
```

Run URBANopt energy simulations for each feature in your scenario:

```terminal
uo -r -s <SCENARIOFILE> -f <FEATUREFILE>
```

Gather simulations for a full scenario:

```terminal
uo -g -t <TYPE> -s <SCENARIOFILE> -f <FEATUREFILE>
```

- Valid `TYPE`s are: `default`, `opendss`, `reopt-scenario`, `reopt-feature`

Delete a scenario you have already run:

```terminal
uo -d -s <SCENARIOFILE>
```

Installed CLI version:

```terminal
uo -v
```

## 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, run the changelog script at `lib/change_log.rb` and copy the appropriate portion of the output into `CHANGELOG.md`. Run `bundle exec rake release` which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
urbanopt-cli-0.2.3	README.md
urbanopt-cli-0.2.2	README.md