From 62c6d30daa45ee2df88fb5ae2172d9b797129fab Mon Sep 17 00:00:00 2001
From: Katherine Fleming <2205659+kflemin@users.noreply.github.com>
Date: Fri, 6 Oct 2023 08:27:14 -0600
Subject: [PATCH] adding more known issues and notes (#198)
---
_sass/color_schemes/uo.scss | 6 ++++++
developer_resources/known_issues.md | 17 +++++++++++++++++
getting_started/getting_started.md | 10 ++++++----
installation/troubleshooting.md | 10 ++++++++++
4 files changed, 39 insertions(+), 4 deletions(-)
diff --git a/_sass/color_schemes/uo.scss b/_sass/color_schemes/uo.scss
index e9c37b1a..d2d366d6 100644
--- a/_sass/color_schemes/uo.scss
+++ b/_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%;
diff --git a/developer_resources/known_issues.md b/developer_resources/known_issues.md
index 306b0601..13dfdf50 100644
--- a/developer_resources/known_issues.md
+++ b/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.
diff --git a/getting_started/getting_started.md b/getting_started/getting_started.md
index 882d9834..07c4648a 100644
--- a/getting_started/getting_started.md
+++ b/getting_started/getting_started.md
@@ -9,10 +9,12 @@ nav_order: 1
Once the CLI is installed, help is available by typing uo --help from the command line. Detailed help for each command can be found with uo [the command name] --help. The main CLI commands are: create, run, process, visualize, opendss, rnm, disco, and delete.
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.
-
-
Important Notes
-
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 known issues section.
-
We recommend calling all URBANopt commands from outside of the project you created, using relative or absolute paths to the relevant files.
+
+
+
Important Notes
+
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.
+
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 known issues section.
+
diff --git a/installation/troubleshooting.md b/installation/troubleshooting.md
index e06f9a32..212e5669 100644
--- a/installation/troubleshooting.md
+++ b/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: