urbanopt-cli 0.2.0.pre6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1526537dc5660dcdf15f90de2c38ca79097d710b
-  data.tar.gz: fcd6a41d2f450dd114b9bd363f0842a8622494d2
+  metadata.gz: 2408b4efcec3352931f0121fabf1459e66cdfff4
+  data.tar.gz: 6a2b3d67fdeacdedf0ffaa2d5bd36410ce72beeb
 SHA512:
-  metadata.gz: 19f93d4b54b442dd211af34096c2e125e5465a46e16cbba494f32d0d160351d95958987266c57ddf62f53953b188e462ce38ce774996524b492d2393e2232b18
-  data.tar.gz: 4d3b613a41825e1cdf9ca1bdac133e900f11caba41a1a7fd5dac5e0dc5d284b9a966f58f9b0676ef326bfb3f71666ab3867f16b5cacb91f0a3473004222e1e49
+  metadata.gz: bd54c28dc9e62e070e8074ef1cef135b9ed6241d8412e5c21764042b1ebe51f27d14e068eba4cc798f63a334b30466c4cf7d08f38a84ecb960053c5e29b7d129
+  data.tar.gz: 40bdf1d80b2d484c56659b9ebe63fa297979eb5b205ddea65b446e81e6df6e25fda65f00e2868d787b0a517664bcfafae9a556cacef3482947b680e2b9e3db32

data/.github/pull_request_template.md

@@ -7,7 +7,6 @@
 ### Checklist (Delete lines that don't apply)
 
 - [ ] Unit tests have been added or updated
-- [ ] Documentation has been modified appropriately
 - [ ] All ci tests pass (green)
 - [ ] An [ISSUE](https://github.com/urbanopt/urbanopt-cli/issues) has been created that this is addressing. Issues will get added to the Change Log when the change_log.rb script is run
 - [ ] This branch is up-to-date with develop

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Exclude:
+    - gems/**/*
+    - init_templates/**/*
+    - lib/measures/**/resources/*
+    - lib/openstudio/extension/core/**/*
+
+inherit_from:
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop.yml

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## Version 0.2.0
+
+Date Range: 02/14/20 - 03/31/20
+
+- Fixed [#2]( https://github.com/urbanopt/urbanopt-cli/issues/2 ), Feature Request: Have this gem get pre-installed
+- Fixed [#4]( https://github.com/urbanopt/urbanopt-cli/issues/4 ), Remove example-geojson-project repo
+- Fixed [#9]( https://github.com/urbanopt/urbanopt-cli/issues/9 ), Update copyrights
+- Fixed [#10]( https://github.com/urbanopt/urbanopt-cli/issues/10 ), Add --version flag
+- Fixed [#12]( https://github.com/urbanopt/urbanopt-cli/issues/12 ), Support ReOpt workflow
+- Fixed [#16]( https://github.com/urbanopt/urbanopt-cli/issues/16 ), Remove travis file
+- Fixed [#19]( https://github.com/urbanopt/urbanopt-cli/issues/19 ), Rack version must be <2.2
+- Fixed [#20]( https://github.com/urbanopt/urbanopt-cli/issues/20 ), Simplecov is an unnecessary dependency
+- Fixed [#22]( https://github.com/urbanopt/urbanopt-cli/issues/22 ), Run a single datapoint
+- Fixed [#25]( https://github.com/urbanopt/urbanopt-cli/issues/25 ), Add ability for CLI to generate config file
+- Fixed [#26]( https://github.com/urbanopt/urbanopt-cli/issues/26 ), Using weekday start time in example mapper
+- Fixed [#39]( https://github.com/urbanopt/urbanopt-cli/issues/39 ), PR template shouldn't ask for Changelog updates
+- Fixed [#40]( https://github.com/urbanopt/urbanopt-cli/issues/40 ), Windows users are requiring Rack during Run command
+- Fixed [#42]( https://github.com/urbanopt/urbanopt-cli/issues/42 ), We still need to require the NREL fork of Simplecov
+- Fixed [#43]( https://github.com/urbanopt/urbanopt-cli/issues/43 ), rake install is hanging
+- Fixed [#44]( https://github.com/urbanopt/urbanopt-cli/issues/44 ), Add detailed OSM workflow to example project
+- Fixed [#45]( https://github.com/urbanopt/urbanopt-cli/issues/45 ), Remove single-family and multi-family buildings from example project
+- Fixed [#46]( https://github.com/urbanopt/urbanopt-cli/issues/46 ), Remove os-standard dependency from example project gemfile
+- Fixed [#55]( https://github.com/urbanopt/urbanopt-cli/issues/55 ), SegFault running CLI on windows
+- Fixed [#56]( https://github.com/urbanopt/urbanopt-cli/issues/56 ), Ruby version is not specified
+- Fixed [#59]( https://github.com/urbanopt/urbanopt-cli/issues/59 ), Add save individual report functionality to CLI
+- Fixed [#63]( https://github.com/urbanopt/urbanopt-cli/issues/63 ), Add a way to create an "empty" project
+- Fixed [#67]( https://github.com/urbanopt/urbanopt-cli/issues/67 ), Add an option to the -p command to overwrite an existing directory
+- Fixed [#68]( https://github.com/urbanopt/urbanopt-cli/issues/68 ), Add OpenDSS postprocess command
+
 ## Version 0.1.0
 
-Iniital commit
+Initial commit

data/Gemfile

@@ -1,10 +1,12 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in uo_cli.gemspec
 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:
@@ -15,7 +17,7 @@ gem 'simplecov', github: 'NREL/simplecov'
 allow_local = ENV['FAVOR_LOCAL_GEMS']
 
 # Uncomment (and modify path/branch) if you need to test local development versions. Otherwise
-# these are included in the gemspec file 
+# these are included in the gemspec file
 #
 # if allow_local && File.exist?('../OpenStudio-extension-gem')
 #   gem 'openstudio-extension', path: '../OpenStudio-extension-gem'
@@ -41,18 +43,18 @@ if allow_local && File.exist?('../urbanopt-scenario-gem')
 elsif allow_local
   gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
 else
-  gem 'urbanopt-scenario', '0.2.0.pre2'
+  gem 'urbanopt-scenario', '0.2.0'
   # temporary
   # gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
 end
 
-if allow_local && File.exists?('../urbanopt-geojson-gem')
+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.pre3'
+  gem 'urbanopt-geojson', '0.2.0'
   # temporary
   # gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
-end
+end

data/README.md

@@ -1,4 +1,4 @@
-# UoCli
+# URBANopt Cli
 
 This is the command line interface (CLI) for URBANopt.
 
@@ -36,25 +36,44 @@ Create a project folder:
 uo -p <FOLDERNAME>
 ```
 
+Overwrite an existing project folder:
+
+```terminal
+uo -o -p <FOLDERNAME>
+```
+
+Create an empty project folder without the example files:
+
+```terminal
+uo -e -p <FOLDERNAME>
+
 Make ScenarioFiles from a FeatureFile using MapperFiles:
 
 ```terminal
 uo -m -f <FEATUREFILE>
 ```
 
+Make a ScenarioFile using only a specific FEATURE_ID from a FEATUREFILE:
+
+```terminal
+uo -m -f <FEATUREFILE> -i <FEATURE_ID>
+```
+
 Run URBANopt energy simulations for each feature in your scenario:
 
 ```terminal
 uo -r -s <SCENARIOFILE> -f <FEATUREFILE>
 ```
 
-Aggregate simulations for a full scenario:
+Gather simulations for a full scenario:
 
 ```terminal
-uo -a -s <SCENARIOFILE> -f <FEATUREFILE>
+uo -g -t <TYPE> -s <SCENARIOFILE> -f <FEATUREFILE>
 ```
 
-Delete a scenario that you have already run:
+- Valid `TYPE`s are: `default`, `opendss`, `reopt-scenario`, `reopt-feature`
+
+Delete a scenario you have already run:
 
 ```terminal
 uo -d -s <SCENARIOFILE>

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
 task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "uo_cli"
+require 'bundler/setup'
+require 'uo_cli'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "uo_cli"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/developer_nrel_key.rb

@@ -0,0 +1,31 @@
+# *********************************************************************************
+# 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.
+# *********************************************************************************
+
+DEVELOPER_NREL_KEY = (ENV['GEM_DEVELOPER_KEY'] || '<your key here https://developer.nrel.gov/signup/>')

data/example_files/Gemfile

@@ -39,7 +39,6 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # end
 
 # if allow_local && File.exist?('../openstudio-model-articulation-gem')
-#   # gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-gem', branch: 'develop'
 #   gem 'openstudio-model-articulation', path: '../openstudio-model-articulation-gem'
 # elsif allow_local
 #   gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-gem', branch: 'develop'
@@ -47,23 +46,24 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 #   gem 'openstudio-model-articulation', '0.1.0'
 # end
 
+gem 'urbanopt-reopt', '0.2.0'
 
 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.pre2'
+  gem 'urbanopt-scenario', '0.2.0'
   # gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
 end
 
-if allow_local && File.exists?('../urbanopt-geojson-gem')
+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.pre3'
+  gem 'urbanopt-geojson', '0.2.0'
   # gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
 end