urbanopt-cli 0.1.0

data/lib/change_log.rb

@@ -0,0 +1,147 @@
+#!/usr/bin/env ruby
+
+require 'github_api'
+require 'date'
+require 'optparse'
+require 'optparse/date'
+
+# Instructions:
+#   Get a token from github's settings (https://github.com/settings/tokens)
+#
+# Example:
+#   ruby change_log.rb -t abcdefghijklmnopqrstuvwxyz -s 2017-09-06
+#
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: change_log.rb [options]\n" +
+  "Prints New, Open, Closed Issues, and number of accepted PRs"
+  opts.separator ""
+
+  # defaults, go back 90 days
+  options[:start_date] = Date.today - 90
+  options[:end_date] = Date.today
+
+  opts.on('-s', '--start-date [DATE]', Date, 'Start of data (e.g. 2017-09-06)') do |v|
+    options[:start_date] = v
+  end
+  opts.on('-e', '--end-date [DATE]', Date, 'End of data (e.g. 2017-09-13)') do |v|
+    options[:end_date] = v
+  end
+  opts.on('-t', '--token [String]', String, 'Github API Token') do |v|
+    options[:token] = v
+  end
+end.parse!
+
+# Convert dates to time objects
+options[:start_date] = Time.parse(options[:start_date].to_s)
+options[:end_date] = Time.parse(options[:end_date].to_s)
+puts options
+
+### Repository options
+repo_owner = 'URBANopt'
+repo = 'uo-cli'
+
+github = Github.new
+if options[:token]
+  puts 'Using github token'
+  github = Github.new oauth_token: options[:token]
+end
+
+total_open_issues = []
+total_open_pull_requests = []
+new_issues = []
+closed_issues = []
+accepted_pull_requests = []
+
+def get_num(issue)
+  issue.html_url.split('/')[-1].to_i
+end
+
+def get_issue_num(issue)
+  "\##{get_num(issue)}"
+end
+
+def get_html_url(issue)
+  issue.html_url
+end
+
+def get_title(issue)
+  issue.title
+end
+
+def print_issue(issue)
+  is_feature = false
+  issue.labels.each { |label| is_feature = true if label.name == 'Feature Request' }
+
+  if is_feature
+    "- Improved [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
+  else
+    "- Fixed [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
+  end
+end
+
+# Process Open Issues
+results = -1
+page = 1
+while results != 0
+  resp = github.issues.list user: repo_owner, repo: repo, sort: 'created', direction: 'asc',
+                            state: 'open', per_page: 100, page: page
+  results = resp.length
+  resp.env[:body].each do |issue, _index|
+    created = Time.parse(issue.created_at)
+    if !issue.key?(:pull_request)
+      total_open_issues << issue
+      if created >= options[:start_date] && created <= options[:end_date]
+        new_issues << issue
+      end
+    else
+      total_open_pull_requests << issue
+    end
+  end
+
+  page += 1
+end
+
+# Process Closed Issues
+results = -1
+page = 1
+while results != 0
+  resp = github.issues.list user: repo_owner, repo: repo, sort: 'created', direction: 'asc',
+                            state: 'closed', per_page: 100, page: page
+  results = resp.length
+  resp.env[:body].each do |issue, _index|
+    created = Time.parse(issue.created_at)
+    closed = Time.parse(issue.closed_at)
+    if !issue.key?(:pull_request)
+      if created >= options[:start_date] && created <= options[:end_date]
+        new_issues << issue
+      end
+      if closed >= options[:start_date] && closed <= options[:end_date]
+        closed_issues << issue
+      end
+    elsif closed >= options[:start_date] && closed <= options[:end_date]
+      accepted_pull_requests << issue
+    end
+  end
+
+  page += 1
+end
+
+closed_issues.sort! { |x, y| get_num(x) <=> get_num(y) }
+new_issues.sort! { |x, y| get_num(x) <=> get_num(y) }
+accepted_pull_requests.sort! { |x, y| get_num(x) <=> get_num(y) }
+total_open_pull_requests.sort! { |x, y| get_num(x) <=> get_num(y) }
+
+puts "Total Open Issues: #{total_open_issues.length}"
+puts "Total Open Pull Requests: #{total_open_pull_requests.length}"
+puts "\nDate Range: #{options[:start_date].strftime('%m/%d/%y')} - #{options[:end_date].strftime('%m/%d/%y')}:"
+puts "\nNew Issues: #{new_issues.length} (" + new_issues.map { |issue| get_issue_num(issue) }.join(', ') + ')'
+
+puts "\nClosed Issues: #{closed_issues.length}"
+closed_issues.each { |issue| puts print_issue(issue) }
+
+puts "\nAccepted Pull Requests: #{accepted_pull_requests.length}"
+accepted_pull_requests.each { |issue| puts print_issue(issue) }
+
+puts "\nAll Open Issues: #{total_open_issues.length} (" + total_open_issues.map { |issue| get_issue_num(issue) }.join(', ') + ')'

data/lib/uo_cli/version.rb

@@ -0,0 +1,5 @@
+module URBANopt
+  module CLI
+  	VERSION = "0.1.0"
+  end
+end

data/lib/uo_cli.rb

@@ -0,0 +1,253 @@
+#!/usr/bin/ ruby
+
+#*********************************************************************************
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+#*********************************************************************************
+
+require "uo_cli/version"
+require "optparse"
+require "urbanopt/geojson"
+require "urbanopt/scenario"
+require "csv"
+require "json"
+require "openssl"
+
+
+module URBANopt
+  module CLI
+
+    # Set up user interface
+    @user_input = {}
+    the_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: uo [-pmradsfv]\n" +
+        "\n" +
+        "URBANopt CLI. \n" +
+        "First create a project folder with -p, then run additional commands as desired \n"
+        opts.separator ""
+
+        opts.on("-p", "--project_folder <DIR>",String, "Create project directory named <DIR> in your current folder") do |folder|
+            @user_input[:project_folder] = folder
+        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" +
+            "                                     You must be insde the project directory you just created for this to work") do
+            @user_input[:make_scenario_from] = "Create scenario files from FeatureFiles 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
+            @user_input[:run_scenario] = "Run simulations"  # This text does not get displayed to the user
+        end
+        opts.on("-a", "--aggregate", String, "Aggregate individual feature results to scenario-level results. Must specify -s & -f arguments\n" +
+            "                                     Example: uo -a -s baseline_scenario.csv -f example_project.json") do
+            @user_input[:aggregate] = "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
+            @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|
+            @user_input[:scenario] = scenario
+        end
+        opts.on("-f", "--feature_file <FFP>", String, "Specify <FFP> (Feature file path). Used as input for other commands") do |feature|
+            @user_input[:feature] = feature
+        end
+        opts.on("-v", "--version", "Show CLI version and exit") do
+            @user_input[:version_request] = VERSION
+        end
+    end
+
+    begin
+        the_parser.parse!
+    rescue OptionParser::InvalidOption => e
+      puts e
+    end
+
+
+    # Simulate energy usage for each Feature in the Scenario\
+    # params\
+    # +scenario+:: _string_ Path to csv file that defines the scenario\
+    # +feature_file_path+:: _string_ Path to Feature File used to describe set of features in the district
+    # 
+    # FIXME: This only works when scenario_file and feature_file are in the project root directory
+    # Also, feels a little weird that now I'm only using instance variables and not passing anything to this function. I guess it's ok?
+    def self.run_func
+        name = "#{@scenario_name.split('.')[0].capitalize}"
+        root_dir = File.absolute_path(@scenario_root)
+        run_dir = File.join(root_dir, 'run', name.downcase)
+        csv_file = File.join(root_dir, @scenario_name)
+        featurefile = File.join(root_dir, @feature_name)
+        mapper_files_dir = File.join(root_dir, "mappers")
+        num_header_rows = 1
+
+        feature_file = URBANopt::GeoJSON::GeoFile.from_file(featurefile)
+        scenario_output = URBANopt::Scenario::ScenarioCSV.new(name, root_dir, run_dir, feature_file, mapper_files_dir, csv_file, num_header_rows)
+        return scenario_output
+    end
+
+    # Create a scenario csv file from a FeatureFile
+    # params\
+    # +feature_file_path+:: _string_ Path to a FeatureFile
+    def self.create_scenario_csv_file(feature_file_path)
+        feature_file_json = JSON.parse(File.read(feature_file_path), :symbolize_names => true)
+        Dir["#{@feature_root}/mappers/*.rb"].each do |mapper_file|
+            mapper_root, mapper_base = File.split(mapper_file)
+            mapper_name = mapper_base.split('.')[0]
+            scenario_file_name = "#{mapper_name.downcase}_scenario.csv"
+            CSV.open(File.join(@feature_root, scenario_file_name), "wb", :write_headers => true,
+            :headers => ["Feature Id","Feature Name","Mapper Class"]) do |csv|
+                feature_file_json[:features].each do |feature|
+                    csv << [feature[:properties][:id], feature[:properties][:name], "URBANopt::Scenario::#{mapper_name}Mapper"]
+                end
+            end
+        end
+    end
+
+
+    # Create project folder
+    # params\
+    # +dir_name+:: _string_ Name of new project folder
+    # 
+    # 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}"
+            Dir.mkdir dir_name
+            Dir.mkdir File.join(dir_name, 'mappers')
+            Dir.mkdir File.join(dir_name, 'weather')
+            mappers_dir_abs_path = File.absolute_path(File.join(dir_name, 'mappers/'))
+            weather_dir_abs_path = File.absolute_path(File.join(dir_name, 'weather/'))
+
+            # FIXME: When residential hpxml flow is implemented (https://github.com/urbanopt/urbanopt-example-geojson-project/pull/24 gets merged) these files will change
+            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"
+            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",
+            ]
+            
+            # Download files to user's local machine
+            remote_mapper_files.each do |mapper_file|
+                mapper_root, mapper_base = 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_base))
+            end
+            remote_weather_files.each do |weather_file|
+                weather_root, weather_base = 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_base))
+            end
+            gem_root, gem_base = 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_base))
+
+            feature_root, feature_base = 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_base))
+        end
+    end
+
+
+    # Perform CLI actions
+    if @user_input[:project_folder]
+        create_project_folder(@user_input[:project_folder])
+        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>'"
+    end
+
+    if @user_input[:make_scenario_from]
+        if @user_input[:feature].nil?
+            abort("\nYou must provide the '-s' flag and a valid path to a FeatureFile!\n---\n\n")
+        end
+        @feature_root, @feature_name = File.split(@user_input[:feature])
+        puts "\nBuilding sample ScenarioFiles, assigning mapper classes to each feature from #{@feature_name}..."
+        create_scenario_csv_file(@user_input[:feature])
+        puts "Done"
+    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")
+        end
+        if @user_input[:feature].nil?
+            abort("\nYou must provide '-f' flag and a valid path to a FeatureFile!\n---\n\n")
+        end
+        @scenario_root, @scenario_name = File.split(@user_input[:scenario])
+        @feature_root, @feature_name = File.split(@user_input[:feature])
+        puts "\nSimulating features of '#{@feature_name}' as directed by '#{@scenario_name}'...\n\n"
+        scenario_runner = URBANopt::Scenario::ScenarioRunnerOSW.new
+        scenario_runner.run(run_func())
+        puts "Done"
+    end
+
+    if @user_input[:aggregate]
+        if @user_input[:scenario].nil?
+            abort("\nYou must provide '-s' flag and a valid path to a ScenarioFile!\n---\n\n")
+        end
+        if @user_input[:feature].nil?
+            abort("\nYou must provide '-f' flag and a valid path to a FeatureFile!\n---\n\n")
+        end
+        @scenario_root, @scenario_name = File.split(@user_input[:scenario])
+        @feature_root, @feature_name = File.split(@user_input[:feature])
+        puts "\nAggregating results across all features of #{@feature_name} according to '#{@scenario_name}'..."
+        scenario_result = URBANopt::Scenario::ScenarioDefaultPostProcessor.new(run_func()).run
+        scenario_result.save
+        puts "Done"
+    end
+
+    if @user_input[:delete_scenario]
+        if @user_input[:scenario].nil?
+            abort("\nYou must provide '-s' flag and a valid path to a ScenarioFile!\n---\n\n")
+        end
+        @scenario_root, @scenario_name = File.split(@user_input[:scenario])
+        scenario_name = @scenario_name.split('.')[0]
+        scenario_root = File.absolute_path(@scenario_root)
+        scenario_results_dir = File.join(scenario_root, 'run', scenario_name)
+        puts "\nDeleting previous results from '#{@scenario_name}'..."
+        FileUtils.rm_rf(scenario_results_dir)
+        puts "Done"
+    end
+
+    if @user_input[:version_request]
+        puts "URBANopt CLI version: #{@user_input[:version_request]}"
+    end
+
+  end  # End module CLI
+
+end  # End module Urbanopt

data/uo_cli.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "uo_cli/version"
+
+Gem::Specification.new do |spec|
+  spec.name            = "urbanopt-cli"
+  spec.version         = URBANopt::CLI::VERSION
+  spec.authors         = ["Nathan Moore"]
+  spec.email           = ["nathan.moore@nrel.gov"]
+
+  spec.summary         = "URBANopt CLI"
+  spec.description     = "Interfacing with URBANopt"
+  spec.homepage        = "https://docs.urbanopt.net/"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+    spec.metadata["homepage_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released. 
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables  = ["uo"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "urbanopt-scenario", "~> 0.1.1"
+  spec.add_dependency "urbanopt-geojson", "~> 0.1.0"
+  
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "github_api", "~> 0.18.0"
+
+#   Set specific version while we are on Ruby 2.2.4
+  spec.add_development_dependency "rack", "2.1.2"
+
+end