urbanopt-cli 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3365bbb79ce6bc9eea243c868e7e4234f15d437993245f4fdb70650236964fb
-  data.tar.gz: 52ace47ebf647cbd861f1cfb7fc2a7ec460edb870803147330e6265638de8b74
+  metadata.gz: 9bf78e9e5b7c3424cdf4e36daec9fc7161b9ea0cf508ee654fa800143f795653
+  data.tar.gz: 8d8c1c19ffcc17093d23e970208ba9d2cf8d84bc7b449d1471ea53a896e0e91b
 SHA512:
-  metadata.gz: 2498eac875e6852671f6b8a757520aed6911d097097382b2bd45039ae8c524f95583ae92a4f7e9f9238e3ff55a2f2cfc57b024c38455562da1d2100312c7f479
-  data.tar.gz: 74eb05da265daec7b6bd5d0b1b1bb83ccbcd1af4841aa82a1ff2f57f86863f8ba331dfbcf71ee314f2ea6e9f979acd92a0f1cb4cabb4f4abf76123e5d118b703
+  metadata.gz: 7d64d73afa14ec5f324764c68ca2975dc8f1d2dc468796dedebdbc019ce36dfe5a5860f023f3caf9585078464607965f4a609e9c81c60f37b67930408aa45ce6
+  data.tar.gz: 4232bee55cc8e82c0c25a3084e0778ca74136bdd1e0cbd04514eac97bcf9bacf81dab2bbc3d56045a2a5570f3f893ed50d713f272b9d77a07b0a014db55008c8

data/.github/workflows/nightly_ci_build.yml

@@ -3,13 +3,11 @@ name: CLI CI
 on:
   workflow_dispatch:
   # Run on demand and weeknights
-  # push:
+  push:
   schedule:
   #   # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
   #   # 5:24 am UTC (11:24pm MDT the day before) every weekday night in MDT
     - cron: '24 5 * * 2-6'
-  pull_request:
-    types: [review_requested]
 
 env:
   # Favor_Local_Gems enforces develop branch of all Ruby dependencies
@@ -24,6 +22,7 @@ env:
 jobs:
   weeknight-tests:
     strategy:
+      fail-fast: false
       matrix:
         # os: container operations in GHA only work on Ubuntu
         # https://docs.github.com/en/actions/using-containerized-services/about-service-containers

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## Version 0.14.0
+Date Range: 06/27/2024 - 11/15/2024
+
+## What's Changed
+### Exciting New Features 🎉
+* Upgrade version of ThermalNetwork Python dependency by @vtnate in https://github.com/urbanopt/urbanopt-cli/pull/493
+* Upgrade miniconda by @vtnate in https://github.com/urbanopt/urbanopt-cli/pull/492
+* Use new version of GMT by @vtnate in https://github.com/urbanopt/urbanopt-cli/pull/489
+### Other Changes
+* Update installer patch by @tijcolem in https://github.com/urbanopt/urbanopt-cli/pull/476
+* Fix installer path bug by @vtnate in https://github.com/urbanopt/urbanopt-cli/pull/485
+* Remove unnecessary default user-entry for DES commands by @vtnate in https://github.com/urbanopt/urbanopt-cli/pull/486
+
+
+**Full Changelog**: https://github.com/urbanopt/urbanopt-cli/compare/v0.13.0...v0.14.0
+
 ## Version 0.13.0
 Date Range: 05/15/2024 - 06/27/2024
 

data/CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.10.2)
 cmake_policy(SET CMP0048 NEW)
 
-project(URBANoptCLI VERSION 0.12.0)
+project(URBANoptCLI VERSION 0.13.0)
 
 include(FindOpenStudioSDK.cmake)
 
@@ -89,21 +89,21 @@ option(BUILD_PACKAGE "Build package" OFF)
 # need to  update the MD5sum for each platform and url below
 if(UNIX)
    if(APPLE)
-     set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20240521-darwin.tar.gz")
-     set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "b68de4be53118f58e245aa8bd17f8992")
+     set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20240709-darwin.tar.gz")
+     set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "b683bb30457904041567079ca4ff0fef")
    else()
      if (ARCH MATCHES "arm64")
        set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20240524-linux-arm.tar.gz")
        set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "18915b55621ee755bf92c506b5cdba2a")
      else() 
-       set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20240521-linux.tar.gz")
-       set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "3f5bf6bc692b0bcc5f50a5b45c2698b3")
+       set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20240719-linux.tar.gz")
+       set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "54f27859ff66915f6b343b0b9731a39c")
      endif()	
    endif()
 elseif(WIN32)
   if(CMAKE_CL_64)
-    set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20240521-windows.tar.gz")
-    set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "c01415b7b91a0db7ad97ad0493286598")
+    set(URBANOPT_CLI_GEMS_ZIP_FILENAME "urbanopt-cli-gems-20240709-windows.tar.gz")
+    set(URBANOPT_CLI_GEMS_ZIP_EXPECTED_MD5 "d34b30aae5677f20738b4be6ad31862e")
   endif()
 endif()
 

data/FindOpenStudioSDK.cmake

@@ -35,6 +35,7 @@ else()
     else() # Assumes 20.04
       set(OPENSTUDIO_EXPECTED_HASH 5c006e5e66e5e859206a63626ea2966f)
       set(OPENSTUDIO_PLATFORM "Ubuntu-20.04-x86_64")
+    endif()
     if(LSB_RELEASE_VERSION_SHORT MATCHES "20.04")
       if (ARCH MATCHES "arm64")
         set(OPENSTUDIO_EXPECTED_HASH d98b3d3d133a7c5bc1b9581553d23811)

data/README.md

@@ -55,12 +55,12 @@ sudo apt install ./UrbanOptCLI-0.3.1.b6f118d506-Linux.deb
 
 This will install to `/usr/local/` directory.
 e.g.
-`/usr/local/urbanopt-cli-0.3.1/`
+`/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.3.1/setup-env.sh
+/usr/local/urbanopt-cli-0.13.0/setup-env.sh
 . ~/.env_uo.sh
 ```
 
@@ -74,7 +74,7 @@ Use the GUI installer and choose a directory to install. Once installed, open a
 The `setup-env.sh` generates env variables and stores them in a file `.env_uo.sh` in your home directory.
 
 ```terminal
-/Applications/UrbanOptCLI_0.3.1/setup-env.sh
+/Applications/UrbanOptCLI_0.13.0/setup-env.sh
 . ~/.env_uo.sh
 ```
 
@@ -89,19 +89,19 @@ Use the GUI installer and choose a directory to install. Once installed, open a
 
 #### Bash (or GitBash for Windows)
 ```terminal
-c:/urbanopt-cli-0.3.1/setup-env.sh
+c:/urbanopt-cli-0.13.0/setup-env.sh
 . ~/.env_uo.sh
 ```
 
-#### Powershell
+#### Powershell or Command Prompt
 ```terminal
-c:\urbanopt-cli-0.3.1\setup-env.ps1
+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
-c:\urbanopt-cli-0.3.1\setup-env.bat
-%HOMEPATH%\.env_uo.bat
+"%HOMEPATH%/.env_uo.bat"
 ```
 
 When launching new shell terminals run the correct environment config to setup the environment. 
@@ -188,10 +188,10 @@ Python dependencies are currently versioned as follows:
 
 | Python Package              | Version |
 | --------------------------- | ------- |
-| urbanopt-ditto-reader       | 0.6.3   |
-| NREL-disco                  | 0.5.0   |
-| geojson-modelica-translator | 0.6.0   |
-| ThermalNetwork              | 0.2.3   |
+| urbanopt-ditto-reader       | 0.6.4   |
+| NREL-disco                  | 0.5.1   |
+| geojson-modelica-translator | 0.8.0   |
+| ThermalNetwork              | 0.3.0   |
 
 ## Development
 

data/example_files/python_deps/dependencies.json

@@ -1,6 +1,6 @@
 [
-  { "name": "ThermalNetwork", "version": "0.2.5"},
+  { "name": "ThermalNetwork", "version": "0.3.0"},
   { "name": "urbanopt-ditto-reader", "version": "0.6.4"},
   { "name": "NREL-disco", "version": "0.5.1"},
-  { "name": "geojson-modelica-translator", "version": "0.7.0"}
+  { "name": "geojson-modelica-translator", "version": "0.8.0"}
 ]

data/example_files/python_deps/install_python.sh

@@ -77,13 +77,29 @@ if [ ! -d $INSTALL_BASE ]; then
 	exit 1
 fi
 
-if [[ "$OSTYPE" == "linux-gnu" ]]; then
-	PLATFORM=Linux-x86_64
-elif [[ "$OSTYPE" == "darwin"* ]]; then
-	PLATFORM=MacOSX-x86_64
-else
-	error "unknown OS type $OSTYPE"
-	exit 1
+architecture=$(uname -m)
+
+echo "$architecture"
+
+# Handle multiple chip architectures (ARM & x86) as well as OS types (Linux & MacOS)
+if [[ $architecture == "x86"* || $architecture == "i686" || $architecture == "i386" ]]; then
+	if [[ "$OSTYPE" == "linux-gnu" ]]; then
+		PLATFORM=Linux-x86_64
+	elif [[ "$OSTYPE" == "darwin"* ]]; then
+		PLATFORM=MacOSX-x86_64
+	else
+		error "unknown OS type $OSTYPE"
+		exit 1
+	fi
+elif [[ $architecture == "arm"* || $architecture == "aarch"* ]]; then
+	if [[ "$OSTYPE" == "linux-gnu" ]]; then
+		PLATFORM=Linux-aarch64
+	elif [[ "$OSTYPE" == "darwin"* ]]; then
+		PLATFORM=MacOSX-arm64
+	else
+		error "unknown OS type $OSTYPE"
+		exit 1
+	fi
 fi
 
 CONDA_PACKAGE_NAME=Miniconda3-py${PYTHON_MAJOR_MINOR}_${CONDA_VERSION}-${PLATFORM}.sh

data/lib/uo_cli/version.rb

@@ -5,6 +5,6 @@
 
 module URBANopt
   module CLI
-    VERSION = '0.13.0'.freeze
+    VERSION = '0.14.0'.freeze
   end
 end

data/lib/uo_cli.rb

@@ -74,7 +74,7 @@ module URBANopt
       # Define creation commands
       def opt_create
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n \n"
+          banner "\nURBANopt create:\n \n"
 
           opt :project_folder, "\nCreate project directory in your current folder. Name the directory\n" \
           "Add additional tags to specify the method for creating geometry, or use the default urban geometry creation method to create building geometry from geojson coordinates with core and perimeter zoning\n" \
@@ -148,7 +148,8 @@ module URBANopt
       # Define commands to install python
       def opt_install_python
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n \n"
+          banner "\nURBANopt install_python:\n \n"
+
           opt :verbose, "\Verbose output \n" \
           'Example: uo install_python --verbose'
         end
@@ -157,7 +158,7 @@ module URBANopt
       # Update project
       def opt_update
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n \n"
+          banner "\nURBANopt update:\n \n"
 
           opt :existing_project_folder, "\Specify existing project folder name to update files \n" \
           'Example: uo update --existing-project-folder urbanopt_example_project --new-project-directory path/to/new_urbanopt_example_project', type: String, short: :e
@@ -170,7 +171,7 @@ module URBANopt
       # Define running commands
       def opt_run
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n \n"
+          banner "\nURBANopt run:\n \n"
 
           opt :scenario, "\nRun URBANopt simulations for <scenario>\n" \
           "Requires --feature also be specified\n" \
@@ -189,7 +190,7 @@ module URBANopt
       # Define opendss commands
       def opt_opendss
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n\n"
+          banner "\nURBANopt opendss:\n\n"
 
           opt :scenario, "\nRun OpenDSS simulations for <scenario>\n" \
           "Requires --feature also be specified\n" \
@@ -240,7 +241,7 @@ module URBANopt
       # Define DISCO commands
       def opt_disco
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n\n"
+          banner "\nURBANopt disco:\n\n"
 
           opt :scenario, "\nRun DISCO simulations for <scenario>\n" \
           "Requires --feature also be specified\n" \
@@ -261,7 +262,7 @@ module URBANopt
       # Define RNM commands
       def opt_rnm
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n\n"
+          banner "\nURBANopt rnm:\n\n"
 
           opt :scenario, "\nRun RNM simulation for <scenario>. Scenario must be run and post-processed prior to calling the rnm command.\n" \
           "Requires --feature also be specified\n" \
@@ -288,7 +289,7 @@ module URBANopt
       # Define post-processing commands
       def opt_process
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n \n"
+          banner "\nURBANopt process:\n \n"
 
           opt :default, "\nStandard post-processing for your scenario", short: :d
 
@@ -323,7 +324,7 @@ module URBANopt
       # Define visualization commands
       def opt_visualize
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n \n"
+          banner "\nURBANopt visualize:\n \n"
 
           opt :feature, "\nVisualize results for all scenarios for a feature file\n" \
             "Provide the FeatureFile to visualize each associated scenario\n" \
@@ -338,7 +339,7 @@ module URBANopt
       # Define validation commands
       def opt_validate
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n \n"
+          banner "\nURBANopt validate:\n \n"
 
           opt :eui, "\nCompare eui results in feature reports to limits in validation_schema.yaml\n" \
             "Provide path to the validation_schema.yaml file in your project directory\n" \
@@ -354,7 +355,7 @@ module URBANopt
 
       def opt_delete
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n \n"
+          banner "\nURBANopt delete:\n \n"
 
           opt :scenario, "\nDelete simulation files for this scenario", default: 'baseline_scenario.csv', required: true
         end
@@ -362,7 +363,7 @@ module URBANopt
 
       def opt_des_params
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n \n"
+          banner "\nURBANopt des_params:\n \n"
 
           opt :sys_param, "\nBuild a system parameters JSON config file for Modelica District Energy System or Ground Heat Exchanger simulation using URBANopt SDK outputs\n" \
             "Provide path/name of json file to be created\n" \
@@ -375,11 +376,13 @@ module URBANopt
             "Example: uo des_params --sys-param path/to/sys_params.json --feature path/to/example_project.json\n", type: String, required: true, short: :f
 
           opt :model_type, "\nSelection for which kind of DES simulation to perform\n" \
-            "Valid choices: 'time_series'", type: String, default: 'time_series'
+            "Valid choices: 'time_series']\n" \
+            'If not specified, the default time_series simulation type will be used', type: String, short: :m
 
           opt :district_type, "\nSelection for which kind of district system parameters to generate\n" \
             "Example: uo des_params --sys-param path/to/sys_params.json --feature path/to/example_project.json --district-type 5G_ghe\n" \
-            'If not specified, the default 4G district type will be used', type: String, required: false, short: :t
+            "Available options are: ['4G', '5G_ghe']\n" \
+            'If not specified, the default 4G district type will be used', type: String, short: :t
 
           opt :overwrite, "\nDelete and rebuild existing sys-param file\n", short: :o
           'Example: uo des_params --sys-param path/to/sys_params.json --feature path/to/example_project.json --overwrite'
@@ -388,7 +391,7 @@ module URBANopt
 
       def opt_des_create
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n"
+          banner "\nURBANopt des_create:\n"
 
           opt :sys_param, "\nPath to system parameters config file, possibly created with 'des_params' command in this CLI\n" \
             "Example: uo des_create --sys-param system_parameters.json\n", type: String, required: true, short: :y
@@ -397,7 +400,7 @@ module URBANopt
             'Example: uo des_create --feature path/to/example_project.json', type: String, required: true, short: :f
 
           opt :des_name, "\nPath to Modelica project dir to be created\n" \
-            'Example: uo des_create --des-name path/to/example_modelica_project', type: String, required: true, short: :n
+            'Example: uo des_create --des-name path/to/example_modelica_project', type: String, short: :n
 
           opt :overwrite, "\nDelete and rebuild existing model directory\n", short: :o
           'Example: uo des_create --des-name path/to/example_modelica_project --overwrite'
@@ -406,7 +409,7 @@ module URBANopt
 
       def opt_des_run
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n \n"
+          banner "\nURBANopt des_run:\n \n"
 
           opt :model, "\nPath to Modelica model dir, possibly created with 'des_create' command in this CLI\n" \
             'Example: uo des_run --model path/to/model/dir', type: String, required: true
@@ -415,7 +418,7 @@ module URBANopt
 
       def opt_ghe_size
         @subopts = Optimist.options do
-          banner "\nURBANopt #{@command}:\n \n"
+          banner "\nURBANopt ghe_size:\n \n"
 
           opt :sys_param, "Path to system parameters config file, possibly created with 'des_params' command in this CLI\n" \
             "Example: uo ghe_size --sys-param path/to/sys_params.json --scenario path/to/baseline_scenario.csv --feature path/to/example_project.json\n", type: String, required: true, short: :y
@@ -545,7 +548,7 @@ module URBANopt
           end
           # Rescue if json isn't a geojson feature_file
         rescue NoMethodError
-          abort("\nOops! You didn't provde a valid feature_file. Please provide path to the geojson feature_file")
+          abort("\nOops! You didn't provide a valid feature_file. Please provide path to the geojson feature_file")
         rescue StandardError => e
           puts "\nERROR: #{e.message}"
         end
@@ -902,7 +905,7 @@ module URBANopt
     def self.setup_python_variables
       pvars = {
         python_version: '3.10',
-        miniconda_version: '4.12.0',
+        miniconda_version: '24.9.2-0',
         python_install_path: nil,
         python_path: nil,
         pip_path: nil,
@@ -1844,7 +1847,7 @@ module URBANopt
           des_cli_addition += ' --overwrite'
         end
       else
-        abort("\nCommand must include system parameter file name, FeatureFile, and model name. Please try again")
+        abort("\nCommand must include system parameter file name and FeatureFile. Please try again")
       end
       begin
         system(des_cli_root + des_cli_addition)
@@ -1917,7 +1920,7 @@ module URBANopt
       # if @opthash.subopts[:verbose]
       #   puts "ghe_cli_root: #{ghe_cli_root}"
       #   puts "ghe_cli_addition: #{ghe_cli_addition}"
-      #   puts "comand: #{ghe_cli_root + ghe_cli_addition}"
+      #   puts "command: #{ghe_cli_root + ghe_cli_addition}"
       # end
       begin
         system(ghe_cli_root + ghe_cli_addition)

data/scripts/setup-env-gitbash.sh

@@ -1,16 +1,17 @@
 #!/bin/bash
-# This is a simple setup script that generates an enviroment file that
-# is used to setup the ruby enviroment to run the urbanopt-cli tool.
+# This is a simple setup script that generates an environment file that
+# is used to setup the ruby environment to run the urbanopt-cli tool.
 # To use, just run this script in bash (e.g. ./setup-env.sh)
-# Then you can use this env.sh to setup the enviroment.
+# Then you can use this env.sh to setup the environment.
 # (e.g. source ~/.env_uo.sh)
 
 
 BASE_DIR_NAME=$(dirname `which $0`)
+UO_DIR_NAME=$(basename "$BASE_DIR_NAME")
 
 GEM_HOME=${BASE_DIR_NAME}/gems/ruby/2.7.0
 GEM_PATH=${BASE_DIR_NAME}/gems/ruby/2.7.0
-PATH=${BASE_DIR_NAME}/ruby/bin:${BASE_DIR_NAME}/gems/ruby/2.7.0/bin:${BASE_DIR_NAME}/gems/ruby/2.7.0/gems/urbanopt-cli-0.11.1/example_files/python_deps/Miniconda-4.12.0/bin:$PATH
+PATH=${BASE_DIR_NAME}/ruby/bin:${BASE_DIR_NAME}/gems/ruby/2.7.0/bin:${BASE_DIR_NAME}/gems/ruby/2.7.0/gems/${UO_DIR_NAME}/example_files/python_deps/Miniconda-4.12.0/bin:$PATH
 RUBYLIB=${BASE_DIR_NAME}/OpenStudio/Ruby
 RUBY_DLL_PATH=${BASE_DIR_NAME}/OpenStudio/Ruby
 

data/scripts/setup-env-unix.sh

@@ -1,17 +1,18 @@
 #!/bin/bash
-# This is a simple setup script that generates an enviroment file that
-# is used to setup the ruby enviroment to run the urbanopt-cli tool.
+# This is a simple setup script that generates an environment file that
+# is used to setup the ruby environment to run the urbanopt-cli tool.
 # To use, just run this script in bash (e.g. ./setup-env.sh)
-# Then you can use this env.sh to setup the enviroment.
+# Then you can use this env.sh to setup the environment.
 # (e.g. . env.sh)
 
-BASE_DIR_NAME="$(cd "$(dirname "$0")" && pwd)"
+UO_DIR=$(dirname "$(realpath "$0")")
+UO_DIR_NAME=$(basename "$UO_DIR")
 
-GEM_HOME=${BASE_DIR_NAME}/gems/ruby/2.7.0
-GEM_PATH=${BASE_DIR_NAME}/gems/ruby/2.7.0
-PATH=${BASE_DIR_NAME}/ruby/bin:${BASE_DIR_NAME}/gems/ruby/2.7.0/bin:${BASE_DIR_NAME}/gems/ruby/2.7.0/gems/urbanopt-cli-0.11.1/example_files/python_deps/Miniconda-4.12.0/bin:$PATH
-RUBYLIB=${BASE_DIR_NAME}/OpenStudio/Ruby
-RUBY_DLL_PATH=${BASE_DIR_NAME}/OpenStudio/Ruby
+GEM_HOME=${UO_DIR}/gems/ruby/2.7.0
+GEM_PATH=${UO_DIR}/gems/ruby/2.7.0
+PATH=${UO_DIR}/ruby/bin:${UO_DIR}/gems/ruby/2.7.0/bin:${UO_DIR}/gems/ruby/2.7.0/gems/${UO_DIR_NAME}/example_files/python_deps/Miniconda-4.12.0/bin:$PATH
+RUBYLIB=${UO_DIR}/OpenStudio/Ruby
+RUBY_DLL_PATH=${UO_DIR}/OpenStudio/Ruby
 
 # Remove if exists
 if [ -f ~/.env_uo.sh ]; then
@@ -23,5 +24,3 @@ echo "export GEM_PATH=\"${GEM_PATH}\"" >> ~/.env_uo.sh
 echo "export PATH=\"${PATH}\"" >> ~/.env_uo.sh
 echo "export RUBYLIB=\"${RUBYLIB}\"" >> ~/.env_uo.sh
 echo "export RUBY_DLL_PATH=\"${RUBY_DLL_PATH}\"" >> ~/.env_uo.sh
-
-

data/scripts/setup-env.ps1

@@ -1,25 +1,45 @@
-# This is a simple setup script that generates an enviroment file that
-# is used to setup the ruby enviroment to run the urbanopt-cli tool.
+# This is a simple setup script that generates an environment file that
+# is used to setup the ruby environment to run the urbanopt-cli tool.
 # To use just run this script in powershell (e.g. ./setup-env.ps1)
-# Then you can use this env.ps1 to setup the enviroment.
+# Then you can use this env.ps1 to setup the environment.
 # (e.g. . env.ps1)
+ $PSDefaultParameterValues['Out-File:Encoding'] = 'utf8'
 
 if (-not (Test-Path $HOME)) { echo "env HOME needs to be set before running this script" }
 if (-not (Test-Path $HOME)) { exit }
 
+# uo install_python will install its own python within the gem directories so we need to find the python path and add it to $env.PATH
+$output = Get-ChildItem -ErrorAction SilentlyContinue -Directory "C:\URBANopt*" -Recurse -Filter "python-3.10" | Select-Object FullName
+
+if ($output.FullName) { 
+  $RUBY_PYTHON_PATH = $output.FullName 
+}
+else {
+  $RUBY_PYTHON_PATH = ""
+}
+
+
 $BASE_DIR_NAME = $PSScriptRoot
 
 $env:GEM_HOME      = "$BASE_DIR_NAME\gems\ruby\2.7.0"
 $env:GEM_PATH      = "$BASE_DIR_NAME\gems\ruby\2.7.0"
-$env:PATH         += ";$BASE_DIR_NAME\ruby\bin;$BASE_DIR_NAME\gems\ruby\2.7.0\bin;$BASE_DIR_NAME\gems\ruby\2.7.0\gems\urbanopt-cli-0.11.1\example_files\python_deps\python-3.10"
+$env:PATH         += ";$BASE_DIR_NAME\ruby\bin;$BASE_DIR_NAME\gems\ruby\2.7.0\bin;$RUBY_PYTHON_PATH"
 $env:RUBYLIB       = "$BASE_DIR_NAME\OpenStudio\Ruby"
 $env:RUBY_DLL_PATH = "$BASE_DIR_NAME\OpenStudio\Ruby"
 
 # Remove if exists
 Remove-Item $HOME/.env_uo.ps1 -ErrorAction Ignore
+Remove-Item $HOME/.env_uo.bat -ErrorAction Ignore
 
 '$env:GEM_HOME       = "' + $env:GEM_HOME + '"'   >> $HOME/.env_uo.ps1
 '$env:GEM_PATH       = "' + $env:GEM_PATH + '"'   >> $HOME/.env_uo.ps1
 '$env:PATH           = "' + $env:PATH     + '"'   >> $HOME/.env_uo.ps1
 '$env:RUBYLIB        = "' + $env:RUBYLIB  + '"'   >> $HOME/.env_uo.ps1
 '$env:RUBY_DLL_PATH  = "' + $env:RUBY_DLL_PATH  + '"'   >> $HOME/.env_uo.ps1
+
+''  >> $HOME/.env_uo.bat
+'SET "GEM_HOME=' + $env:GEM_HOME + '"'   >> $HOME/.env_uo.bat
+'SET "GEM_PATH=' + $env:GEM_PATH + '"'   >> $HOME/.env_uo.bat
+'SET "PATH=' + $env:PATH     + '"'   >> $HOME/.env_uo.bat
+'SET "RUBYLIB=' + $env:RUBYLIB  + '"'   >> $HOME/.env_uo.bat
+'SET "RUBY_DLL_PATH=' + $env:RUBY_DLL_PATH  + '"'   >> $HOME/.env_uo.bat

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-cli
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - NREL URBANopt team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-27 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optimist
@@ -1458,7 +1458,6 @@ files:
 - lib/uo_cli/version.rb
 - scripts/setup-env-gitbash.sh
 - scripts/setup-env-unix.sh
-- scripts/setup-env.bat
 - scripts/setup-env.ps1
 - uo_cli.gemspec
 homepage: https://docs.urbanopt.net/

data/scripts/setup-env.bat

@@ -1,20 +0,0 @@
-IF "%HOMEPATH%"=="" ECHO HOMEPATH is NOT defined. Please set this env value to your home directory before running this script.
-IF "%HOMEPATH%"=="" exit /B
-
-SET BASE_DIR_NAME=%~d0%~p0
-
-SET GEM_HOME=%BASE_DIR_NAME%\gems\ruby\2.7.0
-SET GEM_PATH=%BASE_DIR_NAME%\gems\ruby\2.7.0
-SET PATH=%BASE_DIR_NAME%\ruby\bin;%BASE_DIR_NAME%\gems\ruby\2.7.0\bin;%BASE_DIR_NAME%\gems\ruby\2.7.0\gems\urbanopt-cli-0.11.1\example_files\python_deps\python-3.10;%PATH%
-SET RUBYLIB=%BASE_DIR_NAME%\OpenStudio\Ruby
-SET RUBY_DLL_PATH=%BASE_DIR_NAME%\OpenStudio\Ruby
-
-IF EXIST %HOMEPATH%\.env_uo.bat (
-  del "%HOMEPATH%\.env_uo.bat"
-)
-
-echo SET "GEM_HOME=%GEM_HOME%">> "%HOMEPATH%\.env_uo.bat"
-echo SET "GEM_PATH=%GEM_PATH%">> "%HOMEPATH%\.env_uo.bat"
-echo SET "PATH=%PATH%">> "%HOMEPATH%\.env_uo.bat"
-echo SET "RUBYLIB=%RUBYLIB%">> "%HOMEPATH%\.env_uo.bat"
-echo SET "RUBY_DLL_PATH=%RUBY_DLL_PATH%">> "%HOMEPATH%\.env_uo.bat"