urbanopt-cli 0.2.0.pre5 → 0.2.0.pre6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f66c7cd5936e11c853396f1153c20f4c8a96d25
-  data.tar.gz: 4488b300c2b54f57b41ef60b36d9fe125836c909
+  metadata.gz: 1526537dc5660dcdf15f90de2c38ca79097d710b
+  data.tar.gz: fcd6a41d2f450dd114b9bd363f0842a8622494d2
 SHA512:
-  metadata.gz: 02b2249ccae843a9b9ca536471cb7653a78f21c0b281f02d867a3d3ec841afc77f14061da0e3799e6a90704cd4617c0a9514da08eb18d28d7c9505cdcb6facf0
-  data.tar.gz: aa9450fae4c9ffe1c3dc754dbea9f51c826e54bb5ae41195959f6fc138877227bcef944e4db797eaad9843fd29b076214a919a33bc18697c361098af6e01f0d5
+  metadata.gz: 19f93d4b54b442dd211af34096c2e125e5465a46e16cbba494f32d0d160351d95958987266c57ddf62f53953b188e462ce38ce774996524b492d2393e2232b18
+  data.tar.gz: 4d3b613a41825e1cdf9ca1bdac133e900f11caba41a1a7fd5dac5e0dc5d284b9a966f58f9b0676ef326bfb3f71666ab3867f16b5cacb91f0a3473004222e1e49

data/Gemfile

@@ -52,7 +52,7 @@ if allow_local && File.exists?('../urbanopt-geojson-gem')
 elsif allow_local
   gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
 else
-  gem 'urbanopt-geojson', '0.2.0.pre2'
+  gem 'urbanopt-geojson', '0.2.0.pre3'
   # temporary
   # gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
 end

data/example_files/Gemfile

@@ -63,7 +63,7 @@ if allow_local && File.exists?('../urbanopt-geojson-gem')
 elsif allow_local
   gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
 else
-  gem 'urbanopt-geojson', '0.2.0.pre2'
+  gem 'urbanopt-geojson', '0.2.0.pre3'
   # gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
 end
 

data/example_files/mappers/Baseline.rb

@@ -117,37 +117,7 @@ module URBANopt
             end
           rescue
           end
-
-          # ChangeBuildingLocation
-          # cec climate zone takes precedence
-          cec_found = false
-          begin
-            cec_climate_zone = feature.cec_climate_zone
-            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
-            end
-          rescue
-          end
-          if !cec_found
-            begin
-              climate_zone = feature.climate_zone
-              if !climate_zone.empty?
-                climate_zone = "ASHRAE 169-2013-" + climate_zone
-                OpenStudio::Extension.set_measure_argument(osw, 'ChangeBuildingLocation', 'climate_zone', climate_zone)
-              end
-            rescue
-            end
-          end
-
-          begin
-            weather_filename = feature.weather_filename
-            if !feature.weather_filename.empty?
-              OpenStudio::Extension.set_measure_argument(osw, 'ChangeBuildingLocation', 'weather_file_name', weather_filename)
-            end
-          rescue
-          end  
+ 
           # convert to hash
           building_hash = feature.to_hash
           # check for detailed model filename
@@ -273,6 +243,41 @@ module URBANopt
               return new_time
             end
 
+
+            # ChangeBuildingLocation
+            # set skip measure to false change building location
+            OpenStudio::Extension.set_measure_argument(osw, 'ChangeBuildingLocation', '__SKIP__', false)
+
+            # cec climate zone takes precedence
+            cec_found = false
+            begin
+              cec_climate_zone = feature.cec_climate_zone
+              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
+              end
+            rescue
+            end
+            if !cec_found
+              begin
+                climate_zone = feature.climate_zone
+                if !climate_zone.empty?
+                  climate_zone = "ASHRAE 169-2013-" + climate_zone
+                  OpenStudio::Extension.set_measure_argument(osw, 'ChangeBuildingLocation', 'climate_zone', climate_zone)
+               end
+              rescue
+              end
+            end
+
+          begin
+            weather_filename = feature.weather_filename
+            if !feature.weather_filename.empty?
+              OpenStudio::Extension.set_measure_argument(osw, 'ChangeBuildingLocation', 'weather_file_name', weather_filename)
+            end
+          rescue
+          end 
+
             #set weekday start time
             begin
               weekday_start_time = feature.weekday_start_time
@@ -382,10 +387,10 @@ module URBANopt
           OpenStudio::Extension.set_measure_argument(osw, 'default_feature_reports', 'feature_id', feature_id)
           OpenStudio::Extension.set_measure_argument(osw, 'default_feature_reports', 'feature_name', feature_name)
           OpenStudio::Extension.set_measure_argument(osw, 'default_feature_reports', 'feature_type', feature_type)
-        end # if Building
+        end 
 
         return osw
-      end # def
+      end 
       
     end #BaselineMapper
   end #Scenario

data/example_files/mappers/base_workflow.osw

@@ -16,6 +16,7 @@
     },{
       "measure_dir_name": "ChangeBuildingLocation",
       "arguments": {
+        "__SKIP__": true,
         "weather_file_name": "USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.epw",
         "climate_zone": "ASHRAE 169-2013-6A"
       }

data/lib/uo_cli/version.rb

@@ -1,5 +1,5 @@
 module URBANopt
   module CLI
-  	VERSION = "0.2.0.pre5"
+  	VERSION = "0.2.0.pre6"
   end
 end

data/lib/uo_cli.rb

@@ -45,7 +45,7 @@ module URBANopt
     # Set up user interface
     @user_input = {}
     the_parser = OptionParser.new do |opts|
-        opts.banner = "Usage: uo [-pmradsfiv]\n" +
+        opts.banner = "Usage: uo [-peomradsfiv]\n" +
         "\n" +
         "URBANopt CLI\n" +
         "First create a project folder with -p, then run additional commands as desired\n" +
@@ -53,10 +53,27 @@ module URBANopt
         opts.separator ""
 
         opts.on("-p", "--project_folder <DIR>",String, "Create project directory named <DIR> in your current folder\n" +
-            "                                     You must be insde the project directory you just created for all following commands to work") do |folder|
+            "                                     You must be inside the project directory you just created for all following commands to work") 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
+            @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" +
+            "                                     Usage: uo -o -p <DIR>\n" +
+            "                                     or, uo -o -e -p <DIR>\n" +
+            "                                     Where, <DIR> is the existing project folder") 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" +
@@ -175,11 +192,18 @@ module URBANopt
     # 
     # Folder gets created in the current working directory
     # Includes weather for UO's example location, a base workflow file, and mapper files to show a baseline and a high-efficiency option.
-    def self.create_project_folder(dir_name)
-        if Dir.exist?(dir_name)
-            abort("ERROR:  there is already a directory here named #{dir_name}... aborting")
-        else
-            puts "CREATING URBANopt project directory: #{dir_name}"
+    def self.create_project_folder(dir_name, empty_folder = false, overwrite_project = false)
+        if overwrite_project == true
+            if Dir.exist?(dir_name)
+                FileUtils.rm_rf(dir_name)
+                puts "Overwriting project directory: #{dir_name}"
+            end
+        elsif overwrite_project == false
+            if Dir.exist?(dir_name)
+                abort("ERROR:  there is already a directory here named #{dir_name}... aborting")
+            end
+        end
+            puts "CREATING NEW URBANopt project directory: #{dir_name}"
             Dir.mkdir dir_name
             Dir.mkdir File.join(dir_name, 'mappers')
             Dir.mkdir File.join(dir_name, 'weather')
@@ -188,66 +212,100 @@ module URBANopt
             weather_dir_abs_path = File.absolute_path(File.join(dir_name, 'weather/'))
             osm_dir_abs_path = File.absolute_path(File.join(dir_name, 'osm_building/'))
 
-            # FIXME: When residential hpxml flow is implemented (https://github.com/urbanopt/urbanopt-example-geojson-project/pull/24 gets merged) these files will change
-            config_file = "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/runner.conf"
-
-            example_feature_file = "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/example_project.json"
-            example_gem_file = "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/Gemfile"
+            # FIXME: When residential hpxml flow is implemented
+            # (https://github.com/urbanopt/urbanopt-example-geojson-project/pull/24 gets merged)
+            # these files will change
+            
+            
             remote_mapper_files = [
                 "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/mappers/base_workflow.osw",
                 "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/mappers/Baseline.rb",
                 "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/mappers/HighEfficiency.rb",
             ]
-            remote_weather_files = [
-                "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/weather/USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.epw",
-                "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/weather/USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.ddy",
-                "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/weather/USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.stat",
-            ]
-
-            osm_files = [
-                "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/osm_building/7.osm",
-                "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/osm_building/8.osm",
-                "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/osm_building/9.osm"
-            ]
             
-            # Download files to user's local machine
+            example_gem_file = "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/Gemfile"
+            
+            # Download mapper files to user's local machine
             remote_mapper_files.each do |mapper_file|
                 mapper_path, mapper_name = File.split(mapper_file)
                 mapper_download = open(mapper_file, {ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE})
                 IO.copy_stream(mapper_download, File.join(mappers_dir_abs_path, mapper_name))
             end
-            remote_weather_files.each do |weather_file|
-                weather_path, weather_name = File.split(weather_file)
-                weather_download = open(weather_file, {ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE})
-                IO.copy_stream(weather_download, File.join(weather_dir_abs_path, weather_name))
-            end
-            osm_files.each do |osm_file|
-                osm_path, osm_name = File.split(osm_file)
-                osm_download = open(osm_file, {ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE})
-                IO.copy_stream(osm_download, File.join(osm_dir_abs_path, osm_name))
-            end
+
+            # Download gemfile to user's local machine
             gem_path, gem_name = File.split(example_gem_file)
             example_gem_download = open(example_gem_file, {ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE})
             IO.copy_stream(example_gem_download, File.join(dir_name, gem_name))
 
-            feature_path, feature_name = File.split(example_feature_file)
-            example_feature_download = open(example_feature_file, {ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE})
-            IO.copy_stream(example_feature_download, File.join(dir_name, feature_name))
+            #if argument for creating an empty folder is not added
+            if empty_folder == false
+                
+                example_feature_file = "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/example_project.json"
+            
+                remote_weather_files = [
+                    "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/weather/USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.epw",
+                    "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/weather/USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.ddy",
+                    "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/weather/USA_NY_Buffalo-Greater.Buffalo.Intl.AP.725280_TMY3.stat",
+                ]
 
-            config_path, config_name = File.split(config_file)
-            config_download = open(config_file, {ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE})
-            IO.copy_stream(config_download, File.join(dir_name, config_name))
-        end
+                osm_files = [
+                    "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/osm_building/7.osm",
+                    "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/osm_building/8.osm",
+                    "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/osm_building/9.osm"
+                ]
+
+                config_file = "https://raw.githubusercontent.com/urbanopt/urbanopt-cli/master/example_files/runner.conf"
+                config_path, config_name = File.split(config_file)
+                config_download = open(config_file, {ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE})
+                IO.copy_stream(config_download, File.join(dir_name, config_name))
+
+                
+                # Download weather file to user's local machine
+                remote_weather_files.each do |weather_file|
+                    weather_path, weather_name = File.split(weather_file)
+                    weather_download = open(weather_file, {ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE})
+                    IO.copy_stream(weather_download, File.join(weather_dir_abs_path, weather_name))
+                end
+
+                osm_files.each do |osm_file|
+                    osm_path, osm_name = File.split(osm_file)
+                    osm_download = open(osm_file, {ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE})
+                    IO.copy_stream(osm_download, File.join(osm_dir_abs_path, osm_name))
+                end
+
+                feature_path, feature_name = File.split(example_feature_file)
+                example_feature_download = open(example_feature_file, {ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE})
+                IO.copy_stream(example_feature_download, File.join(dir_name, feature_name))
+
+            end
     end
 
 
     # Perform CLI actions
-    if @user_input[:project_folder]
-        create_project_folder(@user_input[:project_folder])
+    if @user_input[:project_folder] && @user_input[:empty_project_folder].nil?
+        if @user_input[:overwrite_project_folder]
+            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."
+        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: 'uo -m -f <FFP>'"
+        puts "Next, move inside your new folder ('cd <FolderYouJustCreated>') and create ScenarioFiles using this CLI call: 'uo -m -f <FFP>'"
+    elsif @user_input[:project_folder] && @user_input[:empty_project_folder]
+        if @user_input[:overwrite_project_folder]
+            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."
+        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>'"
     end
 
     if @user_input[:make_scenario_from]
@@ -268,6 +326,8 @@ module URBANopt
         end
     end
 
+
+
     if @user_input[:run_scenario]
         if @user_input[:scenario].nil?
             abort("\nYou must provide '-s' flag and a valid path to a ScenarioFile!\n---\n\n")

data/uo_cli.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre5
+  version: 0.2.0.pre6
 platform: ruby
 authors:
 - Nathan Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2020-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0.pre2
+        version: 0.2.0.pre3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0.pre2
+        version: 0.2.0.pre3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement