Merge pull request #199 from urbanopt/develop

publish updates

_sass/color_schemes/uo.scss

@@ -188,6 +188,12 @@ ul.jk_accordion li.acc input:checked + label::before {transform: rotate(-45deg);
   padding: 0.50rem 2rem;
   color: white;
 }
+.important-note-wide {
+  background-color: #68C3E8;
+  margin: 0.5rem 1rem;
+  padding: 0.25rem 1rem;
+  color: white;
+}
 .center-img {
   display: inline-block;
   height: 100%;

developer_resources/known_issues.md

@@ -9,6 +9,12 @@ nav_order: 3
 
 ### All Versions
 
+1. **Cannot Load Such File -- uo_cli** Ensure that your path on the command line is not within a directory that already has a `Gemfile` in it. If it does, move to a different directory with no Gemfiles and try the commands again. URBANopt cannot be called successfully from a directory containing a `Gemfile`. The error text will look something like this:
+
+	```terminal
+	C:/Ruby27-x64/lib/ruby/2.7.0/rubygems/core_ext/kernel_require.rb:92:in `require': cannot load such file -- uo_cli (LoadError)
+	```
+
 1. **CERTIFICATE HAS EXPIRED** You may encounter a 'certificate has expired' error when running REopt™ optimizations. The error text will look something like this:
 
 	```bash
@@ -38,6 +44,15 @@ nav_order: 3
 
 1. **OSAF** Starting with OpenStudio version 3.3.0, major biannual releases of OpenStudio SDK / OpenStudio Analysis Framework (OSAF) will *not* include the URBANopt SDK due to dependency conflicts. URBANopt SDK will be released following the OpenStudio release, and then a patch release of the OSAF will be made that includes the URBANopt dependency.  Visit the [Release Instructions](release_instructions.md#openstudio---urbanopt-release-process) page for more details.
 
+1. **Residential HPXML workflow and Non-US Weather Files** This workflow supports only US weather files at this time. If you have a weather file outside of the US, a possible work-around is to add a row to the climate zone lookup file with your weather file's WMO and climate_zone. The file can be found in your project directory under:
+
+	```bash 
+	resources/hpxml-resources/HPXMLtoOpenStudio/resources/data/climate_zones.csv
+	```
+
+### Version 0.7.0 through 0.9.0
+1. Residential stochastic schedules are silently failing in UO v0.7.0-v0.9.0 and the default schedules are instead being used. Use version v0.10.0 and above to resolve this issue.
+
 ### Version 0.9.1 and below
 1. An unpinned ruby dependency has been updated and is causing an issue with running URBANopt projects.  If you get an error related to `unicode_normalize` similar to this:
 	```bash
@@ -51,6 +66,8 @@ Since this issue is isolated to the files in your project directory, you can als
 		gem 'addressable', '2.8.1'
 	```
 
+1. The HPXML detailed functionality introduced in v0.8.0 is broken in version 0.9.0. Use version v0.10.0 and above to resolve this issue.
+
 ### Version 0.6.3
 
 1. The REopt assumptions files have the `gcr` field set incorrectly to `1` as a default value and will cause REopt optimizations to fail.  The maximum value for this field is `0.99`. This change can be made in the `base_assumptions.json` (1 occurrence) and `multiPV_assumptions.json` (2 occurrences) files found in the `reopt` folder within the project directory.

getting_started/getting_started.md

@@ -9,10 +9,12 @@ nav_order: 1
 		<p>Once the CLI is installed, help is available by typing <code><span class="code-text">uo --help</span></code> from the command line.  Detailed help for each command can be found with <code><span class="code-text">uo [the command name] --help</span></code>. The main CLI commands are: <code><span class="code-text">create</span></code>, <code><span class="code-text">run</span></code>, <code><span class="code-text">process</span></code>, <code><span class="code-text">visualize</span></code>, <code><span class="code-text">opendss</span></code>, <code><span class="code-text">rnm</span></code>, <code><span class="code-text">disco</span></code>, and <code><span class="code-text">delete</span></code>.</p>
 		<p>Before you start, think about the capabilities and analyses you want to utilize and setup your project accordingly. The best way to start is to use the example project made with the CLI.  Once you are familiar with the commands you can customize your project.</p>
 	</div>
-	<div class="col" style="padding-left:20px;">
-	<h2 style="padding-bottom:20px;">Important Notes</h2>
-	<p>Keep the project directory path short to avoid errors related to long paths, especially when running on Windows.  For more information on this error, refer to the <a href="../developer_resources/known_issues" class="bold">known issues section</a>.</p>
-	<p>We recommend calling all URBANopt commands from outside of the project you created, using relative or absolute paths to the relevant files.</p>
+  <div class="col">
+    <div class="important-note-wide">
+	    <h2 style="padding-bottom:20px;color:#ffffff;">Important Notes</h2>
+    	<p>All URBANopt commands should be called from outside the project directory you created, using relative or absolute paths to the relevant files. Do not call the CLI or install it in a directory that contains a Gemfile. This will lead to unexpected errors.</p>
+      <p>Keep the project directory path short to avoid errors related to long paths, especially when running on Windows.  For more information on this error, refer to the <a href="../developer_resources/known_issues" class="bold">known issues section</a>.</p>
+    </div>
 	<div style="float:right;padding-top:30px;padding-right:20px;"><a href="../resources/definitions" class="btn btn-uo white-text">Definitions</a></div>
   <div style="float:right;padding-top:30px;padding-right:20px;"><a href="../resources/tutorials/tutorials" class="btn btn-uo white-text">Tutorial Videos</a></div>
 	</div>

installation/linux.md

@@ -31,12 +31,12 @@ e.g.:  ```/usr/local/urbanopt-cli-0.3.1/```
 
 **_Linux installation has not been tested exhaustively. Please submit a bug report via the [Github issue page](https://github.com/urbanopt/urbanopt-cli/issues) if you run into installation errors_**
 
-1. Install Ruby 2.7 (anything in the 2.7.x range will work).  We recommend using [rbenv](https://github.com/rbenv/rbenv#installation) to manage and install [Ruby 2.7](https://github.com/rbenv/rbenv#installing-ruby-versions)
+1. Install Ruby 2.7.2.  We recommend using [rbenv](https://github.com/rbenv/rbenv#installation) to manage and install [Ruby](https://github.com/rbenv/rbenv#installing-ruby-versions)
     - Install rbenv on your system
     - Install your desired Ruby version
     - Do not forget the `rbenv init` step of rbenv installation
     - Once installed, you may check which versions of Ruby have been installed and which one is active with: `rbenv versions`
-    - Set your current directory to use Ruby 2.7.x with: `rbenv local 2.7.x`
+    - Set your current directory to use Ruby 2.7.2 with: `rbenv local 2.7.2`
     - Full documentation for rbenv can be found at the [rbenv github site](https://github.com/rbenv/rbenv#command-reference)
 
 1. Install Bundler version 2.1:

installation/mac.md

@@ -33,12 +33,12 @@ Follow the steps below or watch the [Mac Installer Video](https://urbanopt-tutor
 
 Follow the steps below or watch the [Mac Manual Installation Video](https://urbanopt-tutorial.s3.amazonaws.com/videos/04_Mac_Manual_Install.mp4).
 
-1. Install Ruby 2.7.2 (anything in the 2.7.x range will work).  We recommend using [rbenv](https://github.com/rbenv/rbenv#installation) to manage and install [Ruby 2.7](https://github.com/rbenv/rbenv#installing-ruby-versions)
+1. Install Ruby 2.7.2.  We recommend using [rbenv](https://github.com/rbenv/rbenv#installation) to manage and install [Ruby](https://github.com/rbenv/rbenv#installing-ruby-versions)
     - `brew install rbenv`
-    - `rbenv install 2.7.x`
+    - `rbenv install 2.7.2`
     - Do not forget the `rbenv init` step of rbenv installation
     - Once installed, you may check which versions of Ruby have been installed and which one is active with: `rbenv versions`
-    - Set your current directory to use Ruby 2.7.x with: `rbenv local 2.7.x`
+    - Set your current directory to use Ruby 2.7.2 with: `rbenv local 2.7.2`
     - Full documentation for rbenv can be found at the [rbenv github site](https://github.com/rbenv/rbenv#command-reference)
 
 1. Install Bundler version 2.1:

installation/troubleshooting.md

@@ -7,6 +7,16 @@ nav_order: 6
 
 # Troubleshooting Installation Errors
 
+## Cannot Load such file -- uo_cli
+
+If after installation, you try to use the URBANotp CLI and get an error similar to this:
+
+```terminal
+C:/Ruby27-x64/lib/ruby/2.7.0/rubygems/core_ext/kernel_require.rb:92:in `require': cannot load such file -- uo_cli (LoadError)
+```
+
+Ensure that your path on the command line is not within a directory that already has a `Gemfile` in it. If it does, move to a different directory with no Gemfiles and try the commands again. URBANopt cannot be called successfully from a directory containing a `Gemfile`.
+
 ## Bundler Installation Error
 
 If you have a secure firewall that prevents **bundler** from installing properly, type the following into the command line: