Skip to content

Commit

Permalink
Update README.md (#435)
Browse files Browse the repository at this point in the history
* Update README.md

* add gmt version info, and post-processing options

* remove redundant phrase from installation instructions

* fix typo in MacOS installation instructions

* we only support Ruby 2.7.2 at this time
  • Loading branch information
vtnate authored Aug 28, 2023
1 parent 6d66676 commit 3a7c086
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This is the command line interface (CLI) for the URBANopt™ SDK.

## Installation (Using Ruby)

Using ruby add this line to your application's Gemfile:
Add this line to your application's Gemfile:

```ruby
gem 'urbanopt-cli'
Expand All @@ -41,7 +41,7 @@ gem install urbanopt-cli

## Installation (Using Installer)

The UrbanOpt installer is an alternate way to install the UrbanOpt CLI that also includes Ruby 2.5.x and OpenStudio SDK.
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)
Expand Down Expand Up @@ -78,7 +78,7 @@ The `setup-env.sh` generates env variables and stores them in a file `.env_uo.sh
. ~/.env_uo.sh
```

When launching new shell terminals run `. ~/.env_uo.s` to setup the environment. 
When launching new shell terminals run `. ~/.env_uo.sh` to setup the environment. 

### Windows (64-bit Windows 7 – 10)

Expand Down Expand Up @@ -168,7 +168,7 @@ Post-process simulations for a full scenario:
uo process --<TYPE> --scenario <SCENARIOFILE> --feature <FEATUREFILE>
```

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

Delete a scenario you have already run:

Expand All @@ -186,10 +186,11 @@ uo --version

Python dependencies are currently versioned as follows:

| Python Package | Version |
| ----------- | ----------- |
| urbanopt-ditto-reader | 0.4.0 |
| NREL-disco | 0.3.4 from https://github.com/NREL/disco.git |
| Python Package | Version |
| --------------------------- | ------- |
| urbanopt-ditto-reader | 0.5.1 |
| NREL-disco | 0.4.1 |
| geojson-modelica-translator | 0.5.0 |

## Development

Expand Down

0 comments on commit 3a7c086

Please sign in to comment.