urbanopt-cli 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c14894739827cbb739d7dca075586f78270ff6c2
-  data.tar.gz: 3448a95d3281bdf957c9381154430c7eb89463b7
+  metadata.gz: 45f2908aa6ed3a360029d8a474276fe27d3e1d02
+  data.tar.gz: a39f3810ddacfa43a0a2b36cfb5860bea5b514d5
 SHA512:
-  metadata.gz: a5b9bf331f9e8dba4f6a3ddd5a75ea476d72cd6e40e38efb48a25ee46b45e9b772f410886d34714453bd1c63066a6e1c180d80d744654416fb3224d9fa007119
-  data.tar.gz: 201e3e0c14ba8a05d6eac5acdf18fee97bf3b8c842d22c2952d8390e921276b74dd654397cea7cd61d983baff94354f3c222e2929ea314e12d2702177096aea6
+  metadata.gz: afa12d95c62d4fb01c10f4d7c79951c12fa7b85d972c41b5c1a77704d496da189c29b1e9ba5c7b21573ed614187474600136504aa3fc752fd3ef9f45fee75a08
+  data.tar.gz: 8acba12c2a7b36fba84f002286fa878de9577ffb9f29aae865bf5ef39fd102c458925ef3bec2e7cce5564048b266bea7e59021efe5fd669350f85a20d90fa66e

data/.gitignore

@@ -6,6 +6,11 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store
+
+# local dev IDE settings
+.vscode/
+.idea/
 
 # rbenv virtualenv management file
 .ruby-version
@@ -13,4 +18,8 @@
 # rspec failure tracking
 .rspec_status
 
-Gemfile.lock
+# rspec test folder
+spec/test_directory
+
+Gemfile.lock
+.rubocop*

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 # Changelog
 
+## Version 0.2.3
+
+Date Range: 04/01/20 - 04/23/20:
+
+- Fixed [#65]( https://github.com/urbanopt/urbanopt-cli/issues/65 ), Add more tests
+- Fixed [#81]( https://github.com/urbanopt/urbanopt-cli/issues/81 ), Mappers weren't updated for version 0.2
+- Fixed [#83]( https://github.com/urbanopt/urbanopt-cli/issues/83 ), Recommend using absolute paths
+- Fixed [#85]( https://github.com/urbanopt/urbanopt-cli/issues/85 ), reopt dependency not installed
+- Fixed [#88]( https://github.com/urbanopt/urbanopt-cli/issues/88 ), Reopt tests are failing
+- Fixed [#90]( https://github.com/urbanopt/urbanopt-cli/issues/90 ), Update baseline mapper
+- Fixed [#92]( https://github.com/urbanopt/urbanopt-cli/issues/92 ), baseline mapper bug reading json file
+
 ## Version 0.2.2
+
 Date Range: 3/31/20 - 3/31/20
 
 - Fixing simplecov / json native extension dependency

data/Gemfile

@@ -6,7 +6,6 @@ gemspec
 # simplecov has a dependency on native json gem, use fork that does not require this
 gem 'certified'
 gem 'simplecov', github: 'NREL/simplecov'
-gem 'urbanopt-reopt', '0.2.0'
 
 # Local gems are useful when developing and integrating the various dependencies.
 # To favor the use of local gems, set the following environment variable:
@@ -38,23 +37,31 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 #   gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-gem', branch: 'develop'
 # end
 
-if allow_local && File.exist?('../urbanopt-scenario-gem')
-  gem 'urbanopt-scenario', path: '../urbanopt-scenario-gem'
-elsif allow_local
-  gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
-else
-  gem 'urbanopt-scenario', '0.2.0'
-  # temporary
-  # gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
-end
-
-if allow_local && File.exist?('../urbanopt-geojson-gem')
-  # gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'develop'
-  gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
-elsif allow_local
-  gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
-else
-  gem 'urbanopt-geojson', '0.2.0'
-  # temporary
-  # gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
-end
+# if allow_local && File.exist?('../urbanopt-scenario-gem')
+#   gem 'urbanopt-scenario', path: '../urbanopt-scenario-gem'
+# elsif allow_local
+#   gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
+# else
+#   gem 'urbanopt-scenario', '0.2.0'
+#   # temporary
+#   # gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
+# end
+
+# if allow_local && File.exist?('../urbanopt-geojson-gem')
+#   # gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'develop'
+#   gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
+# elsif allow_local
+#   gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
+# else
+#   gem 'urbanopt-geojson', '0.2.0'
+#   # temporary
+#   # gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
+# end
+
+# if allow_local && File.exist?('../urbanopt-reopt-gem')
+#   gem 'urbanopt-reopt', path: '../urbanopt-reopt-gem'
+# elsif allow_local
+#   gem 'urbanopt-reopt', github: 'URBANopt/urbanopt-reopt-gem', branch: 'develop'
+# else
+#   gem 'urbanopt-reopt', '0.2.1'
+# end

data/example_files/Gemfile

@@ -46,7 +46,7 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 #   gem 'openstudio-model-articulation', '0.1.0'
 # end
 
-gem 'urbanopt-reopt', '0.2.0'
+gem 'urbanopt-reopt', '0.2.1'
 
 if allow_local && File.exist?('../urbanopt-scenario-gem')
   gem 'urbanopt-scenario', path: '../urbanopt-scenario-gem'
@@ -54,21 +54,18 @@ elsif allow_local
   gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
 else
   gem 'urbanopt-scenario', '0.2.0'
-  # gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
 end
 
 if allow_local && File.exist?('../urbanopt-geojson-gem')
-  # gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'develop'
   gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
 elsif allow_local
   gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
 else
   gem 'urbanopt-geojson', '0.2.0'
-  # gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
 end
 
 # simplecov has an unneccesary dependency on native json gem, use fork that does not require this
 gem 'simplecov', github: 'NREL/simplecov'
 
-# Fix rack version temporarily to work with Ruby 2.2.4
+# Specify exact rack version temporarily to work with Ruby 2.2.4
 gem 'rack', '2.1.2'

data/example_files/example_project.json

@@ -13,7 +13,7 @@
                 "cec_climate_zone": null,
                 "climate_zone": "6A",
                 "default_template": "90.1-2013",
-                "end_date": "2017-13-31T07:00:00.000Z",
+                "end_date": "2017-12-31T07:00:00.000Z",
                 "id": "53340c2c-ab20-40db-aba1-11ac607c52a7",
                 "import_surrounding_buildings_as_shading": null,
                 "name": "Site Origin",

data/example_files/mappers/Baseline.rb

@@ -67,61 +67,61 @@ module URBANopt
         if template.include? 'DEER'
           case building_type
           when 'Education'
-            'EPr'
+            return 'EPr'
           when 'Enclosed mall'
-            'RtL'
+            return 'RtL'
           when 'Food sales'
-            'RSD'
+            return 'RSD'
           when 'Food service'
-            'RSD'
+            return 'RSD'
           when 'Inpatient health care'
-            'Nrs'
+            return 'Nrs'
           when 'Laboratory'
-            'Hsp'
+            return 'Hsp'
           when 'Lodging'
-            'Htl'
+            return 'Htl'
           when 'Mixed use'
-            'ECC'
+            return 'ECC'
           when 'Mobile Home'
-            'DMo'
+            return 'DMo'
           when 'Multifamily (2 to 4 units)'
-            'MFm'
+            return 'MFm'
           when 'Multifamily (5 or more units)'
-            'MFm'
+            return 'MFm'
           when 'Nonrefrigerated warehouse'
-            'SUn'
+            return 'SUn'
           when 'Nursing'
-            'Nrs'
+            return 'Nrs'
           when 'Office'
             if footprint_area
-              if footprint_area.to_f > 100_000
-                'OfL'
+              if footprint_area.to_f > 100000
+                return 'OfL'
               else
-                'OfS'
+                return 'OfS'
               end
             else
               raise 'footprint_area required to map office building type'
             end
           when 'Outpatient health care'
-            'Nrs'
+            return 'Nrs'
           when 'Public assembly'
-            'Asm'
+            return 'Asm'
           when 'Public order and safety'
-            'Asm'
+            return 'Asm'
           when 'Refrigerated warehouse'
-            'WRf'
+            return 'WRf'
           when 'Religious worship'
-            'Asm'
+            return 'Asm'
           when 'Retail other than mall'
-            'RtS'
+            return 'RtS'
           when 'Service'
-            'MLI'
+            return 'MLI'
           when 'Single-Family'
-            'MFm'
+            return 'MFm'
           when 'Strip shopping mall'
-            'RtL'
+            return 'RtL'
           when 'Vacant'
-            'SUn'
+            return 'SUn'
           else
             raise "building type #{building_type} cannot be mapped to a DEER building type"
           end
@@ -130,17 +130,17 @@ module URBANopt
           # default: ASHRAE
           case building_type
           when 'Education'
-            'SecondarySchool'
+            return 'SecondarySchool'
           when 'Enclosed mall'
-            'RetailStripmall'
+            return 'RetailStripmall'
           when 'Food sales'
-            'FullServiceRestaurant'
+            return 'FullServiceRestaurant'
           when 'Food service'
-            'FullServiceRestaurant'
+            return 'FullServiceRestaurant'
           when 'Inpatient health care'
-            'Hospital'
+            return 'Hospital'
           when 'Laboratory'
-            'Hospital'
+            return 'Hospital'
           when 'Lodging'
             if number_of_stories
               if number_of_stories.to_i > 3
@@ -149,51 +149,51 @@ module URBANopt
                 return 'SmallHotel'
               end
             end
-            'LargeHotel'
+            return 'LargeHotel'
           when 'Mixed use'
-            'Mixed use'
+            return 'Mixed use'
           when 'Mobile Home'
-            'MidriseApartment'
+            return 'MidriseApartment'
           when 'Multifamily (2 to 4 units)'
-            'MidriseApartment'
+            return 'MidriseApartment'
           when 'Multifamily (5 or more units)'
-            'MidriseApartment'
+            return 'MidriseApartment'
           when 'Nonrefrigerated warehouse'
-            'Warehouse'
+            return 'Warehouse'
           when 'Nursing'
-            'Outpatient'
+            return 'Outpatient'
           when 'Office'
             if footprint_area
-              value = if footprint_area.to_f < 20_000
-                        'SmallOffice'
-                      elsif footprint_area.to_f > 100_000
-                        'LargeOffice'
-                      else
-                        'MediumOffice'
-                      end
+              if footprint_area.to_f < 20000
+                value = 'SmallOffice'
+              elsif footprint_area.to_f > 100000
+                value = 'LargeOffice'
+              else
+                value = 'MediumOffice'
+              end
             else
               raise 'Floor area required to map office building type'
             end
           when 'Outpatient health care'
-            'Outpatient'
+            return 'Outpatient'
           when 'Public assembly'
-            'MediumOffice'
+            return 'MediumOffice'
           when 'Public order and safety'
-            'MediumOffice'
+            return 'MediumOffice'
           when 'Refrigerated warehouse'
-            'Warehouse'
+            return 'Warehouse'
           when 'Religious worship'
-            'MediumOffice'
+            return 'MediumOffice'
           when 'Retail other than mall'
-            'RetailStandalone'
+            return 'RetailStandalone'
           when 'Service'
-            'MediumOffice'
+            return 'MediumOffice'
           when 'Single-Family'
-            'MidriseApartment'
+            return 'MidriseApartment'
           when 'Strip shopping mall'
-            'RetailStripmall'
+            return 'RetailStripmall'
           when 'Vacant'
-            'Warehouse'
+            return 'Warehouse'
           else
             raise "building type #{building_type} cannot be mapped to an ASHRAE building type"
           end
@@ -203,38 +203,38 @@ module URBANopt
       def lookup_template_by_year_built(template, year_built)
         if template.include? 'DEER'
           if year_built <= 1996
-            'DEER 1985'
+            return 'DEER 1985'
           elsif year_built <= 2003
-            'DEER 1996'
+            return 'DEER 1996'
           elsif year_built <= 2007
-            'DEER 2003'
+            return 'DEER 2003'
           elsif year_built <= 2011
-            'DEER 2007'
+            return 'DEER 2007'
           elsif year_built <= 2014
-            'DEER 2011'
+            return 'DEER 2011'
           elsif year_built <= 2015
-            'DEER 2014'
+            return 'DEER 2014'
           elsif year_built <= 2017
-            'DEER 2015'
+            return 'DEER 2015'
           elsif year_built <= 2020
-            'DEER 2017'
+            return 'DEER 2017'
           else
-            'DEER 2020'
+            return 'DEER 2020'
           end
         else
           # ASHRAE
           if year_built < 1980
-            'DOE Ref Pre-1980'
+            return 'DOE Ref Pre-1980'
           elsif year_built <= 2004
-            'DOE Ref 1980-2004'
+            return 'DOE Ref 1980-2004'
           elsif year_built <= 2007
-            '90.1-2004'
+            return '90.1-2004'
           elsif year_built <= 2010
-            '90.1-2007'
+            return '90.1-2007'
           elsif year_built <= 2013
-            '90.1-2010'
+            return '90.1-2010'
           else
-            '90.1-2013'
+            return '90.1-2013'
           end
         end
       end
@@ -247,7 +247,9 @@ module URBANopt
         feature_id = feature.id
         feature_type = feature.type
         feature_name = feature.name
-        feature_name = feature_names[0] if feature_names.size == 1
+        if feature_names.size == 1
+          feature_name = feature_names[0]
+        end
 
         # deep clone of @@osw before we configure it
         osw = Marshal.load(Marshal.dump(@@osw))
@@ -261,17 +263,17 @@ module URBANopt
           # set_run_period
           begin
             timesteps_per_hour = feature.timesteps_per_hour
-            unless timesteps_per_hour.empty?
+            if timesteps_per_hour
               OpenStudio::Extension.set_measure_argument(osw, 'set_run_period', 'timesteps_per_hour', timesteps_per_hour)
             end
           rescue StandardError
           end
           begin
             begin_date = feature.begin_date
-            unless feature.begin_date.empty?
+            if begin_date
               # check date-only YYYY-MM-DD
-              if feature.begin_date.length > 10
-                feature.begin_date = feature.begin_date[0, 10]
+              if begin_date.length > 10
+                begin_date = begin_date[0, 10]
               end
               OpenStudio::Extension.set_measure_argument(osw, 'set_run_period', 'begin_date', begin_date)
             end
@@ -279,10 +281,10 @@ module URBANopt
           end
           begin
             end_date = feature.end_date
-            unless feature.end_date.empty?
+            if end_date
               # check date-only YYYY-MM-DD
-              if feature.end_date.length > 10
-                feature.end_date = feature.end_date[0, 10]
+              if end_date.length > 10
+                end_date = end_date[0, 10]
               end
               OpenStudio::Extension.set_measure_argument(osw, 'set_run_period', 'end_date', end_date)
             end
@@ -366,11 +368,21 @@ module URBANopt
             end
 
             floor_height = 10
-            system_type = if building_hash.key?(:system_type)
-                            building_hash[:system_type]
-                          else
-                            'Inferred'
-                          end
+            # Map system type to openstudio system types
+            # TODO: Map all system types
+            if building_hash.key?(:system_type)
+              system_type = building_hash[:system_type]
+              case system_type
+              when 'Fan coil district hot and chilled water'
+                system_type = 'Fan coil district chilled water with district hot water'
+              when 'Fan coil air-cooled chiller and boiler'
+                system_type = 'Fan coil air-cooled chiller with boiler'
+              when 'VAV with gas reheat'
+                system_type = 'VAV air-cooled chiller with gas boiler reheat'
+              end
+            else
+              system_type = 'Inferred'
+            end
 
             def time_mapping(time)
               hour = time.split(':')[0]
@@ -379,7 +391,7 @@ module URBANopt
               fraction_roundup = fraction.round(2)
               minute_fraction = fraction_roundup.to_s.split('.')[1]
               new_time = [hour, minute_fraction].join('.')
-              new_time
+              return new_time
             end
 
             # ChangeBuildingLocation
@@ -390,17 +402,23 @@ module URBANopt
             cec_found = false
             begin
               cec_climate_zone = feature.cec_climate_zone
-              unless cec_climate_zone.empty?
+              if !cec_climate_zone.empty?
                 cec_climate_zone = 'T24-CEC' + cec_climate_zone
                 OpenStudio::Extension.set_measure_argument(osw, 'ChangeBuildingLocation', 'climate_zone', cec_climate_zone)
                 cec_found = true
+                # Temporary fix for CEC climate zone:
+                cec_modified_zone = 'CEC ' + cec_climate_zone
+                OpenStudio::Extension.set_measure_argument(osw, 'create_bar_from_building_type_ratios', 'climate_zone', cec_modified_zone)
+                OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'climate_zone', cec_modified_zone, 'create_typical_building_from_model 1')
+                OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'climate_zone', cec_modified_zone, 'create_typical_building_from_model 2')
+
               end
             rescue StandardError
             end
-            unless cec_found
+            if !cec_found
               begin
                 climate_zone = feature.climate_zone
-                unless climate_zone.empty?
+                if !climate_zone.empty?
                   climate_zone = 'ASHRAE 169-2013-' + climate_zone
                   OpenStudio::Extension.set_measure_argument(osw, 'ChangeBuildingLocation', 'climate_zone', climate_zone)
                end
@@ -430,7 +448,7 @@ module URBANopt
             # set weekday start time
             begin
               weekday_start_time = feature.weekday_start_time
-              unless feature.weekday_start_time.empty?
+              if !feature.weekday_start_time.empty?
                 new_weekday_start_time = time_mapping(weekday_start_time)
                 OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wkdy_op_hrs_start_time', new_weekday_start_time, 'create_typical_building_from_model 1')
               end
@@ -440,7 +458,7 @@ module URBANopt
             # set weekday duration
             begin
               weekday_duration = feature.weekday_duration
-              unless feature.weekday_duration.empty?
+              if !feature.weekday_duration.empty?
                 new_weekday_duration = time_mapping(weekday_duration)
                 OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wkdy_op_hrs_duration', new_weekday_duration, 'create_typical_building_from_model 1')
               end
@@ -450,7 +468,7 @@ module URBANopt
             # set weekend start time
             begin
               weekend_start_time = feature.weekend_start_time
-              unless feature.weekend_start_time.empty?
+              if !feature.weekend_start_time.empty?
                 new_weekend_start_time = time_mapping(weekend_start_time)
                 OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wknd_op_hrs_start_time', new_weekend_start_time, 'create_typical_building_from_model 1')
               end
@@ -460,7 +478,7 @@ module URBANopt
             # set weekend duration
             begin
               weekend_duration = feature.weekend_duration
-              unless feature.weekend_duration.empty?
+              if !feature.weekend_duration.empty?
                 new_weekend_duration = time_mapping(weekend_duration)
                 OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wknd_op_hrs_duration', new_weekend_duration, 'create_typical_building_from_model 1')
               end
@@ -546,7 +564,7 @@ module URBANopt
           OpenStudio::Extension.set_measure_argument(osw, 'default_feature_reports', 'feature_type', feature_type)
         end
 
-        osw
+        return osw
       end
     end # BaselineMapper
   end # Scenario

data/example_files/mappers/HighEfficiency.rb

@@ -51,7 +51,7 @@ module URBANopt
         OpenStudio::Extension.set_measure_argument(osw, 'ReduceLightingLoadsByPercentage', '__SKIP__', false)
         OpenStudio::Extension.set_measure_argument(osw, 'ReduceLightingLoadsByPercentage', 'lighting_power_reduction_percent', 10)
 
-        osw
+        return osw
       end
     end
   end

data/lib/uo_cli/version.rb

@@ -1,5 +1,5 @@
 module URBANopt
   module CLI
-    VERSION = '0.2.2'.freeze
+    VERSION = '0.2.3'.freeze
   end
 end

data/lib/uo_cli.rb

@@ -46,7 +46,7 @@ module URBANopt
     # Set up user interface
     @user_input = {}
     the_parser = OptionParser.new do |opts|
-      opts.banner = "Usage: uo [-peomrgdsfitv]\n" \
+      opts.banner = "\nUsage: uo [-peomrgdsfitv]\n" \
                     "\n" \
                     "URBANopt CLI\n" \
                     "First create a project folder with -p, then run additional commands as desired\n" \
@@ -54,60 +54,60 @@ module URBANopt
       opts.separator ''
 
       opts.on('-p', '--project_folder <DIR>', String, "Create project directory named <DIR> in your current folder\n" \
-          '                                     You must be inside the project directory you just created for all following commands to work') do |folder|
+          "                                     Fewer warnings are presented when using full paths and the user is not inside the project folder\n\n") do |folder|
         @user_input[:project_folder] = folder
       end
 
       opts.on('-e', '--empty_project_folder', String, "Use with -p argument to create an empty project folder\n" \
           "                                     Example: uo -e -p <DIR>\n" \
           "                                     Then add your own Feature file in the project directory you created,\n" \
-          "                                     add Weather files in the weather folder and add OpenStudio models of Features \n" \
-          "                                     in the Feature File, if any in the osm_building folder \n" \
-          '                                     You must be inside the project directory you just created for all following commands to work') do
+          "                                     add Weather files in the weather folder and add OpenStudio models of Features\n" \
+          "                                     in the Feature File, if any, in the osm_building folder\n" \
+          "                                     Fewer warnings are presented when using full paths and the user is not inside the project folder\n\n") do
         @user_input[:empty_project_folder] = 'Create empty project folder' # This text does not get displayed to the user
       end
 
       opts.on('-o', '--overwrite_project_folder', String, "Use with -p argument to overwrite existing project folder and replace with new project folder.\n" \
-          "                                     Or, use with -e and -p argument to overwrite existing project folder and replace with new empty project folder.\n" \
+          "                                     Or use with -e and -p argument to overwrite existing project folder and replace with new empty project folder.\n" \
           "                                     Usage: uo -o -p <DIR>\n" \
-          "                                     or, uo -o -e -p <DIR>\n" \
-          '                                     Where, <DIR> is the existing project folder') do
+          "                                     or uo -o -e -p <DIR>\n" \
+          "                                     Where <DIR> is the existing project folder\n\n") do
         @user_input[:overwrite_project_folder] = 'Overwriting existing project folder' # This text does not get displayed to the user
       end
 
       opts.on('-m', '--make_scenario', String, "Create ScenarioCSV files for each MapperFile using the Feature file path. Must specify -f argument\n" \
           "                                     Example: uo -m -f example_project.json\n" \
           "                                     Or, Create Scenario CSV for each MapperFile for a single Feature from Feature File. Must specify -f and -i argument\n" \
-          '                                     Example: uo -m -f example_project.json -i 1') do
+          "                                     Example: uo -m -f example_project.json -i 1\n\n") do
         @user_input[:make_scenario_from] = "Create scenario files from FeatureFiles or for single Feature according to the MapperFiles in the 'mappers' directory" # This text does not get displayed to the user
       end
 
       opts.on('-r', '--run', String, "Run simulations. Must specify -s & -f arguments\n" \
-          '                                     Example: uo -r -s baseline_scenario.csv -f example_project.json') do
+          "                                     Example: uo -r -s baseline_scenario.csv -f example_project.json\n\n") do
         @user_input[:run_scenario] = 'Run simulations' # This text does not get displayed to the user
       end
 
       opts.on('-g', '--gather', String, "group individual feature results to scenario-level results. Must specify -t, -s, & -f arguments\n" \
-          '                                     Example: uo -g -t default -s baseline_scenario.csv -f example_project.json') do
+          "                                     Example: uo -g -t default -s baseline_scenario.csv -f example_project.json\n\n") do
         @user_input[:gather] = 'Aggregate all features to a whole Scenario' # This text does not get displayed to the user
       end
 
       opts.on('-d', '--delete_scenario', String, "Delete results from scenario. Must specify -s argument\n" \
-          '                                     Example: uo -d -s baseline_scenario.csv') do
+          "                                     Example: uo -d -s baseline_scenario.csv\n\n") do
         @user_input[:delete_scenario] = 'Delete scenario results that were created from <SFP>' # This text does not get displayed to the user
       end
 
-      opts.on('-s', '--scenario_file <SFP>', String, 'Specify <SFP> (ScenarioCSV file path). Used as input for other commands') do |scenario|
+      opts.on('-s', '--scenario_file <SFP>', String, "Specify <SFP> (ScenarioCSV file path). Used as input for other commands\n\n") do |scenario|
         @user_input[:scenario] = scenario
         @root_dir, @scenario_file_name = File.split(File.absolute_path(@user_input[:scenario]))
       end
 
-      opts.on('-f', '--feature_file <FFP>', String, 'Specify <FFP> (Feature file path). Used as input for other commands') do |feature|
+      opts.on('-f', '--feature_file <FFP>', String, "Specify <FFP> (Feature file path). Used as input for other commands\n\n") do |feature|
         @user_input[:feature] = feature
         @feature_path, @feature_name = File.split(File.absolute_path(@user_input[:feature]))
       end
 
-      opts.on('-i', '--feature_id <FID>', Integer, 'Specify <FID> (Feature ID). Used as input for other commands') do |feature_id|
+      opts.on('-i', '--feature_id <FID>', Integer, "Specify <FID> (Feature ID). Used as input for other commands\n\n") do |feature_id|
         @user_input[:feature_id] = feature_id
       end
 
@@ -115,11 +115,11 @@ module URBANopt
           "                                       default\n" \
           "                                       reopt-scenario\n" \
           "                                       reopt-feature\n" \
-          "                                       opendss\n") do |type|
+          "                                       opendss\n\n") do |type|
         @user_input[:type] = type
       end
 
-      opts.on('-v', '--version', 'Show CLI version and exit') do
+      opts.on('-v', '--version', "Show CLI version and exit\n") do
         @user_input[:version_request] = VERSION
       end
     end
@@ -176,10 +176,10 @@ module URBANopt
             if feature_id == 'SKIP'
               # ensure that feature is a building
               if feature[:properties][:type] == 'Building'
-                csv << [feature[:properties][:id], feature[:properties][:name], "URBANopt::Scenario::#{mapper_name}Mapper", 'base_assumptions.json']
-                end
+                csv << [feature[:properties][:id], feature[:properties][:name], "URBANopt::Scenario::#{mapper_name}Mapper", 'multiPV_assumptions.json']
+              end
             elsif feature_id == feature[:properties][:id].to_i
-              csv << [feature[:properties][:id], feature[:properties][:name], "URBANopt::Scenario::#{mapper_name}Mapper", 'base_assumptions.json']
+              csv << [feature[:properties][:id], feature[:properties][:name], "URBANopt::Scenario::#{mapper_name}Mapper", 'multiPV_assumptions.json']
             elsif
               # If Feature ID specified does not exist in the Feature File raise error
               unless feature_file_json[:features].any? { |hash| hash[:properties][:id].include?(feature_id.to_s) }
@@ -201,14 +201,12 @@ module URBANopt
       if overwrite_project == true
         if Dir.exist?(dir_name)
           FileUtils.rm_rf(dir_name)
-          puts "Overwriting project directory: #{dir_name}\n"
         end
       elsif overwrite_project == false
         if Dir.exist?(dir_name)
           abort("\nERROR:  there is already a directory here named #{dir_name}... aborting\n---\n\n")
         end
       end
-      puts "CREATING NEW URBANopt project directory: #{dir_name}\n"
       Dir.mkdir dir_name
       Dir.mkdir File.join(dir_name, 'mappers')
       Dir.mkdir File.join(dir_name, 'weather')
@@ -298,28 +296,30 @@ module URBANopt
     # Perform CLI actions
     if @user_input[:project_folder] && @user_input[:empty_project_folder].nil?
       if @user_input[:overwrite_project_folder]
+        puts "\nOverwriting existing project folder: #{@user_input[:project_folder]}...\n\n"
+        puts "Creating a new project folder...\n"
         create_project_folder(@user_input[:project_folder], empty_folder = false, overwrite_project = true)
-        puts "\nOverwriting exiting project folder #{@user_input[:project_folder]}."
-        puts "Creating a new project folder.\n"
       elsif @user_input[:overwrite_project_folder].nil?
         create_project_folder(@user_input[:project_folder], empty_folder = false, overwrite_project = false)
       end
       puts "\nAn example FeatureFile is included: 'example_project.json'. You may place your own FeatureFile alongside the example."
       puts 'Weather data is provided for the example FeatureFile. Additional weather data files may be downloaded from energyplus.net/weather for free'
       puts "If you use additional weather files, ensure they are added to the 'weather' directory. You will need to configure your mapper file and your osw file to use the desired weather file"
-      puts "Next, move inside your new folder ('cd <FolderYouJustCreated>') and create ScenarioFiles using this CLI call: 'uo -m -f <FFP>'\n"
+      puts "Next, create ScenarioFiles using this CLI call: 'uo -m -f <FFP>'\n"
+      puts "We recommend using absolute paths for all commands, for cleaner output\n"
     elsif @user_input[:project_folder] && @user_input[:empty_project_folder]
       if @user_input[:overwrite_project_folder]
+        puts "\nOverwriting existing project folder: #{@user_input[:project_folder]}...\n\n"
+        puts "Creating a new project folder...\n\n"
         create_project_folder(@user_input[:project_folder], empty_folder = true, overwrite_project = true)
-        puts "\nOverwriting exiting project folder #{@user_input[:project_folder]}."
-        puts "Creating a new project folder.\n"
       elsif @user_input[:overwrite_project].nil?
         create_project_folder(@user_input[:project_folder], empty_folder = true, overwrite_project = false)
       end
       puts 'Add your FeatureFile in the Project directory you just created.'
       puts 'Add your weather data files in the Weather folder. They may be downloaded from energyplus.net/weather for free'
       puts 'Add your OpenStudio models for Features in your Feature file, if any in the osm_building folder'
-      puts "Next, move inside your new folder ('cd <FolderYouJustCreated>') and create ScenarioFiles using this CLI call: 'uo -m -f <FFP>'\n"
+      puts "Next, create ScenarioFiles using this CLI call: 'uo -m -f <FFP>'\n"
+      puts "We recommend using absolute paths for all commands, for cleaner output\n"
     end
 
     if @user_input[:make_scenario_from]
@@ -365,10 +365,14 @@ module URBANopt
       if @user_input[:feature].nil?
         abort("\nYou must provide '-f' flag and a valid path to a FeatureFile!\n---\n\n")
       end
-      if @user_input[:type].nil?
+
+      valid_postprocessors = ['default', 'reopt-scenario', 'reopt-feature', 'opendss']
+      # Abort if <type> is nil or not in valid list
+      if @user_input[:type].nil? || valid_postprocessors.none? { |needle| @user_input[:type].include? needle }
         abort("\nYou must provide '-t' flag and a valid Gather type!\n" \
-            "Valid types include: 'default', 'reopt-scenario', 'reopt-feature', or 'opendss'\n---\n\n")
+            "Valid types include: #{valid_postprocessors}\n---\n\n")
       end
+
       @scenario_folder = @scenario_file_name.split('.')[0].capitalize.to_s
 
       default_post_processor = URBANopt::Scenario::ScenarioDefaultPostProcessor.new(run_func)
@@ -378,11 +382,11 @@ module URBANopt
       # save feature reports
       scenario_report.feature_reports.each(&:save_feature_report)
 
-      if @user_input[:type].to_s.casecmp('default').zero?
+      if @user_input[:type] == valid_postprocessors[0]
         puts "\nDone\n"
-      elsif @user_input[:type].to_s.casecmp('opendss').zero?
+      elsif @user_input[:type] == valid_postprocessors[3]
         puts "\nPost-processing OpenDSS results\n"
-        opendss_folder = File.join(@root_dir, 'run', @scenario_name.split('.')[0], 'opendss')
+        opendss_folder = File.join(@root_dir, 'run', @scenario_file_name.split('.')[0], 'opendss')
         if File.directory?(opendss_folder)
           opendss_folder_name = File.basename(opendss_folder)
           opendss_post_processor = URBANopt::Scenario::OpenDSSPostProcessor.new(scenario_report, opendss_results_dir_name = opendss_folder_name)
@@ -391,25 +395,23 @@ module URBANopt
         else
           abort("\nNo OpenDSS results available in folder '#{opendss_folder}'\n")
         end
-      elsif @user_input[:type].to_s.downcase.include?('reopt')
+      elsif @user_input[:type].to_s.include?('reopt')
         scenario_base = default_post_processor.scenario_base
         reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(scenario_report, scenario_base.scenario_reopt_assumptions_file, scenario_base.reopt_feature_assumptions, DEVELOPER_NREL_KEY)
 
         # Optimize REopt outputs for the whole Scenario
-        if @user_input[:type].to_s.casecmp('reopt-scenario').zero?
+        if @user_input[:type] == valid_postprocessors[1]
           puts "\nOptimizing renewable energy for the scenario\n"
           scenario_report_scenario = reopt_post_processor.run_scenario_report(scenario_report: scenario_report, save_name: 'scenario_optimization')
           puts "\nDone\n"
         # Optimize REopt outputs for each feature individually
-        elsif @user_input[:type].to_s.casecmp('reopt-feature').zero?
+        elsif @user_input[:type] == valid_postprocessors[2]
           puts "\nOptimizing renewable energy for each feature\n"
           scenario_report_features = reopt_post_processor.run_scenario_report_features(scenario_report: scenario_report, save_names_feature_reports: ['feature_optimization'] * scenario_report.feature_reports.length, save_name_scenario_report: 'feature_optimization')
           puts "\nDone\n"
-        else
-          abort("\nError: did not use type 'reopt-scenario', 'reopt-feature'. Aborting...\n---\n\n")
         end
       else
-        abort("\nError: did not use type 'default', 'reopt-scenario', 'reopt-feature', or 'opendss'. Aborting...\n---\n\n")
+        abort("\nError: did not use one of these valid types: #{valid_postprocessors} Aborting...\n---\n\n")
       end
     end
 

data/uo_cli.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
 
   #   use specific versions of urbanopt and openstudio dependencies while under heavy development
   spec.add_dependency 'urbanopt-geojson', '0.2.0'
+  spec.add_dependency 'urbanopt-reopt', '0.2.1'
   spec.add_dependency 'urbanopt-scenario', '0.2.0'
 
   spec.add_development_dependency 'bundler', '~> 1.17'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Nathan Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -38,6 +38,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: urbanopt-reopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: urbanopt-scenario
   requirement: !ruby/object:Gem::Requirement