openstudio-workflow 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd5e1d2530fa9c784c895a46aa301e0dd2ff8ed3
-  data.tar.gz: d969e8477b3f95eb62fcf00d1f610e18564f7cf6
+  metadata.gz: fb02ff2b9ba68076ad3bd7bdd0b07a790db0a90e
+  data.tar.gz: 84f8b7b245040cbef4aae3b45a5b2fe973f0ace8
 SHA512:
-  metadata.gz: 37a2892034e72bd02e8fcb298138eeb80eb5084a52bc3c5afbd369de65d3e3af561d0d1253676ddb1e0499e4643e9023c45e7fa28725f492cdad46c0cb64b9df
-  data.tar.gz: 5ca11c5f3ab37a66293fc2b5039e124ae4ad6fe1a7ac3867b75afaa0cbf363bd4406814852c99a057d19064e85f757e8aef81e9288de3c8399965b1547e2c319
+  metadata.gz: 466afdf8aaea899d0567f97c1df7674b5a80af09ebc3044410cc3f6a752952e3d65fc9c281aea0480bdfdc13b239819ed4eab4e5d251d194f915929131741e4b
+  data.tar.gz: 7c8f671a81404622f1257077cd24bfd77ab405efe4ec1d6fc8fe45688ed9905509005d27f55658dedecbc46be020c695ac41bc18431be7a22e355775499a6bc3

data/CHANGELOG.md

@@ -1,77 +1,89 @@
-OpenStudio::Workflow Change Log
-==================================
-
-Version 1.3.4 (Unreleased)
---------------------------
-* Remove support for Ruby 2.0
-* Update license
-
-Version '1.0.0-rc1'
--------------------
-* Use specific version of OpenStudio Analysis Gem
-* Fix tests
-* Remove to_underscore method (use OpenStudio.toUnderscoreCase(...) if needed)
-
-Version '1.0.0-alpha.0'
------------------------
-* Support new workflow for PAT 2.0. Many of these changes are breaking changes
-* Remove rake from gemspec
-* Update rubyzip to version 1.2
-
-Version 0.2.0
-------------------
-* Use EnergyPlus that is packaged with OpenStudio. The branch of this repo is no longer tied to the version of EnergyPlus
-* Update find_energyplus to use new OpenStudio method instead of RUBYLIB env var
-* Update dependencies
-* Support tests running on Docker
-* Skip the PAT tests for now since they are broken
-* Remove snake_case method as it conflicts with another libraries method, now called to_underscore
-* Add test for persisting JSONs as reports. Rename reports in the form of <measure_name_underscored>_<report_name>.<ext>
-* Always add in Monthly Reports (Deprecate the :run_monthly_reports option)
-* Remove the old Standard Reports and use the version in the OpenStudio Release (along with the calibration report)
-
-Version 0.1.1
-------------------
-* Catch exception when loading a measure file.
-* Enable running simulations on windows and mac
-  * Use rubyzip gem instead of system call
-  * Fix the double directory which caused the zip files to behave strangely on windows
-  * New find_energyplus method which tries to use OpenStudio's version of EnergyPlus
-* Copy all EnergyPlus files into run directory
-* Better cleanup after EnergyPlus simulation
-* Read machine information from /etc/openstudio-server directory, if available
-
-Version 0.1.0
--------------
-* Tests for programmatically creating the analysis.json files from the OpenStudio-analysis-gem
-* Upgrade to EnergyPlus 8.2. Right now the run energyplus and run runmanager job hard code these paths.
-* Upgrade and fix Facter facts to grab the correct ip address when running on EC2
-
-Version 0.0.4
--------------
-* Include rubyXL gem for reading/writing MS Excel files
-* Remove invalid characters from OpenStudio Measure Attributes. /[|!@#\$%^&\*\(\)\{\}\\\[\]|;:'",<.>\/?\+=]+/
-* Fix objective functions to read from any of the results hash, not just the standard report legacy
-* Add time logger and reporting measure
-
-Version 0.0.3
---------------
-* Allow measures to set weather file in a measure and have it update what EnergyPlus uses for the weather file.
-* OpenStudio::Workflow.run_energyplus method added to just run energyplus.
-* Remove AASM (act as state machine) and replace with simple tracking of the state. Interface is the same except there is now no need to pass in the States.
-* Catch EnergyPlus errors (non-zero exits), Fatal Errors in eplusout.err, and invalid weather files.
-* Force UTF-8 version upon reading the eplusout.err file
-
-Version 0.0.2
---------------
-
-* Support reporting measures
-* Reduce logging messages
-* Keep IDF files
-* Remove mtr and eso files after simulation completes
-* If measure changes weather file, then use the new weather file with the analysis.json weather path
-
-Version 0.0.1
---------------
-
-* Initial release with basic workflow implemented to support running OpenStudio measure-based workflows
+OpenStudio::Workflow Change Log
+==================================
+
+Version 1.3.5
+-------------
+
+* Allow reporting to fail gracefully so HTML reports are returned Fixed [this](https://github.com/NREL/OpenStudio/issues/864).
+* Allow EMS:OutputVariable in reporting measure
+* Fixes [#93](https://github.com/NREL/OpenStudio-workflow-gem/issues/93) - Pass Model to the arguments method of ReportingMeasure
+* Update README
+* Remove CircleCI in favor of Jenkins
+* Update license and copyright
+* Improve speed by not loading REXML unless needed
+* Fix ChangeBuildingLocation test failure
+
+Version 1.3.4
+-------------
+* Remove support for Ruby 2.0
+* Update license
+
+Version '1.0.0-rc1'
+-------------------
+* Use specific version of OpenStudio Analysis Gem
+* Fix tests
+* Remove to_underscore method (use OpenStudio.toUnderscoreCase(...) if needed)
+
+Version '1.0.0-alpha.0'
+-----------------------
+* Support new workflow for PAT 2.0. Many of these changes are breaking changes
+* Remove rake from gemspec
+* Update rubyzip to version 1.2
+
+Version 0.2.0
+------------------
+* Use EnergyPlus that is packaged with OpenStudio. The branch of this repo is no longer tied to the version of EnergyPlus
+* Update find_energyplus to use new OpenStudio method instead of RUBYLIB env var
+* Update dependencies
+* Support tests running on Docker
+* Skip the PAT tests for now since they are broken
+* Remove snake_case method as it conflicts with another libraries method, now called to_underscore
+* Add test for persisting JSONs as reports. Rename reports in the form of <measure_name_underscored>_<report_name>.<ext>
+* Always add in Monthly Reports (Deprecate the :run_monthly_reports option)
+* Remove the old Standard Reports and use the version in the OpenStudio Release (along with the calibration report)
+
+Version 0.1.1
+------------------
+* Catch exception when loading a measure file.
+* Enable running simulations on windows and mac
+  * Use rubyzip gem instead of system call
+  * Fix the double directory which caused the zip files to behave strangely on windows
+  * New find_energyplus method which tries to use OpenStudio's version of EnergyPlus
+* Copy all EnergyPlus files into run directory
+* Better cleanup after EnergyPlus simulation
+* Read machine information from /etc/openstudio-server directory, if available
+
+Version 0.1.0
+-------------
+* Tests for programmatically creating the analysis.json files from the OpenStudio-analysis-gem
+* Upgrade to EnergyPlus 8.2. Right now the run energyplus and run runmanager job hard code these paths.
+* Upgrade and fix Facter facts to grab the correct ip address when running on EC2
+
+Version 0.0.4
+-------------
+* Include rubyXL gem for reading/writing MS Excel files
+* Remove invalid characters from OpenStudio Measure Attributes. /[|!@#\$%^&\*\(\)\{\}\\\[\]|;:'",<.>\/?\+=]+/
+* Fix objective functions to read from any of the results hash, not just the standard report legacy
+* Add time logger and reporting measure
+
+Version 0.0.3
+--------------
+* Allow measures to set weather file in a measure and have it update what EnergyPlus uses for the weather file.
+* OpenStudio::Workflow.run_energyplus method added to just run energyplus.
+* Remove AASM (act as state machine) and replace with simple tracking of the state. Interface is the same except there is now no need to pass in the States.
+* Catch EnergyPlus errors (non-zero exits), Fatal Errors in eplusout.err, and invalid weather files.
+* Force UTF-8 version upon reading the eplusout.err file
+
+Version 0.0.2
+--------------
+
+* Support reporting measures
+* Reduce logging messages
+* Keep IDF files
+* Remove mtr and eso files after simulation completes
+* If measure changes weather file, then use the new weather file with the analysis.json weather path
+
+Version 0.0.1
+--------------
+
+* Initial release with basic workflow implemented to support running OpenStudio measure-based workflows

data/README.md

@@ -1,93 +1,67 @@
-# OpenStudio::Workflow
-
-[![Circle CI](https://circleci.com/gh/NREL/OpenStudio-workflow-gem/tree/develop.svg?style=svg)](https://circleci.com/gh/NREL/OpenStudio-workflow-gem/tree/develop)
-[![Coverage Status](https://coveralls.io/repos/NREL/OpenStudio-workflow-gem/badge.svg?branch=develop&service=github)](https://coveralls.io/github/NREL/OpenStudio-workflow-gem?branch=develop)
-[![Dependency Status](https://www.versioneye.com/user/projects/5531fb7b10e714121100102e/badge.svg?style=flat)](https://www.versioneye.com/user/projects/5531fb7b10e714121100102e)
-
-## OpenStudio Workflow Gem
-
-This branch is the development branch for the OpenStudio workflow gem. 
-## Installation
-
-The OpenStudio Workflow Gem has the following dependencies:
-
-* Ruby 2.0
-* OpenStudio with Ruby 2.0 bindings
-* EnergyPlus 8.3 (assuming OpenStudio >= 1.7.2)
-* MongoDB if using MongoDB Adapter (or when running rspec)
-
-[OpenStudio](http://developer.nrel.gov/downloads/buildings/openstudio/builds/) needs to be installed
-and in your path.  On Mac/Linux it is easiest to add the following to your .bash_profile or /etc/profile.d/<file>.sh to ensure OpenStudio can be loaded.
-
-    export OPENSTUDIO_ROOT=/usr/local
-    export RUBYLIB=$OPENSTUDIO_ROOT/lib/ruby/site_ruby/2.0.0
-
-Add this line to your application's Gemfile:
-
-    gem 'OpenStudio-workflow'
-
-And then execute:
-    
-    Mac/Linux:
-
-        $ bundle
-        
-    Windows (avoids native extensions):
-    
-        $ bundle install --without xml profile
-
-Or install it yourself as:
-    
-    $ gem install OpenStudio-workflow
-    
-## Usage
-
-Note that the branches of the Workflow Gem depict which version of EnergyPlus is in use. The develop branch at the
-moment should not be used.
-
-There are currently two adapters to run OpenStudio workflow. The first is a simple Local adapter
-allowing the user to pass in the directory to simulation. The directory must have an
-[analysis/problem JSON file](spec/files/local_ex1/analysis_1.json) and a [datapoint JSON file](spec/files/local_ex1/datapoint_1.json).
-The workflow manager will use these data (and the measures, seed model, and weather data) to assemble and
-execute the standard workflow of (preflight->openstudio measures->energyplus->postprocess).
-
-    r = OpenStudio::Workflow.load 'Local', '/home/user/a_directory', options
-    r.run
-
-The workflow manager can also use MongoDB to receive instructions on the workflow to run and the data point values.
-
-## Caveats and Todos
-
-### Todos
-
-* Add a test to ensure that the models being returned contain alterations after apply_measure
-* Add unit tests for each util method
-* Define and document the complete set of options for the adapter and run classes
-* Implement better error handling with custom exception classes
-
-## Testing
-
-The preferred way for testing is to run rspec either natively or via docker.
-
-### Locally
-
-```
-rspec spec/
-```
-
-### Docker
-
-```
-export OPENSTUDIO_VERSION=1.13.0
-docker run -v $(pwd):/var/simdata/openstudio \
-      nrel/openstudio:$OPENSTUDIO_VERSION \
-      /var/simdata/openstudio/test/bin/docker-run.sh
-```
-
-## Contributing
-
-1. Fork it ( https://github.com/NREL/OpenStudio-workflow/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+# OpenStudio::Workflow
+
+[![Dependency Status](https://www.versioneye.com/user/projects/5531fb7b10e714121100102e/badge.svg?style=flat)](https://www.versioneye.com/user/projects/5531fb7b10e714121100102e)
+
+## OpenStudio Workflow Gem
+
+This branch is the development branch for the OpenStudio workflow gem. 
+## Installation
+
+The OpenStudio Workflow Gem has the following dependencies:
+
+* Ruby 2.2.4
+* OpenStudio 2.x
+
+[OpenStudio](http://developer.nrel.gov/downloads/buildings/openstudio/builds/) needs to be installed and in your path.  On Mac/Linux it is easiest to add the following to your .bash_profile or /etc/profile.d/<file>.sh to ensure OpenStudio loads. Assuming OpenStudio 2.9.1 installed:
+
+    export RUBYLIB=/usr/local/openstudio-2.9.1/Ruby
+
+Add this line to your application's Gemfile:
+
+    gem 'OpenStudio-workflow'
+
+And then execute:
+    
+    bundle install
+        
+Or install it yourself as:
+    
+    $ gem install openstudio-workflow
+    
+## Usage
+
+There are currently two adapters to run OpenStudio workflow. The first is a simple Local adapter allowing the user to pass in the directory to simulation. The directory must have an [analysis/problem JSON file](spec/files/local_ex1/analysis_1.json) and a [datapoint JSON file](spec/files/local_ex1/datapoint_1.json).
+
+The workflow manager will use these data (and the measures, seed model, and weather data) to assemble and execute the standard workflow of (preflight->openstudio measures->energyplus->postprocess).
+
+    r = OpenStudio::Workflow.load 'Local', '/home/user/a_directory', options
+    r.run
+
+There are also socket and web-based adapters that have yet to be documented.
+
+## Testing
+
+The preferred way for testing is to run rspec either natively or via docker.
+
+### Locally
+
+```
+rspec spec/
+```
+
+### Docker
+
+```
+export OPENSTUDIO_VERSION=2.9.1
+docker run -v $(pwd):/var/simdata/openstudio \
+      nrel/openstudio:$OPENSTUDIO_VERSION \
+      /var/simdata/openstudio/test/bin/docker-run.sh
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/NREL/OpenStudio-workflow/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -1,36 +1,36 @@
-require 'bundler'
-Bundler.setup
-
-require 'rspec/core/rake_task'
-
-# Always create spec reports
-require 'ci/reporter/rake/rspec'
-
-# Gem tasks
-require 'bundler/gem_tasks'
-
-RSpec::Core::RakeTask.new('spec:unit') do |spec|
-  spec.rspec_opts = %w(--format progress --format CI::Reporter::RSpec)
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-task 'spec:unit' => 'ci:setup:rspec'
-task default: 'spec:unit'
-
-require 'rubocop/rake_task'
-desc 'Run RuboCop on the lib directory'
-RuboCop::RakeTask.new(:rubocop) do |task|
-  task.options = ['--no-color', '--out=rubocop-results.xml']
-  task.formatters = ['RuboCop::Formatter::CheckstyleFormatter']
-  task.requires = ['rubocop/formatter/checkstyle_formatter']
-  # don't abort rake on failure
-  task.fail_on_error = false
-end
-
-require 'openstudio-workflow'
-desc 'test extracting zip'
-task :test_zip do
-  f = File.join(File.dirname(__FILE__), 'spec/files/example_models/the_project.zip')
-  puts "Trying to extract #{f}"
-  OpenStudio::Workflow.extract_archive(f, 'junk_out', true)
-end
+require 'bundler'
+Bundler.setup
+
+require 'rspec/core/rake_task'
+
+# Always create spec reports
+require 'ci/reporter/rake/rspec'
+
+# Gem tasks
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new('spec:unit') do |spec|
+  spec.rspec_opts = ['--format', 'progress', '--format', 'CI::Reporter::RSpec']
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task 'spec:unit' => 'ci:setup:rspec'
+task default: 'spec:unit'
+
+require 'rubocop/rake_task'
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ['--no-color', '--out=rubocop-results.xml']
+  task.formatters = ['RuboCop::Formatter::CheckstyleFormatter']
+  task.requires = ['rubocop/formatter/checkstyle_formatter']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end
+
+require 'openstudio-workflow'
+desc 'test extracting zip'
+task :test_zip do
+  f = File.join(File.dirname(__FILE__), 'spec/files/example_models/the_project.zip')
+  puts "Trying to extract #{f}"
+  OpenStudio::Workflow.extract_archive(f, 'junk_out', true)
+end

data/lib/openstudio-workflow.rb

@@ -1,65 +1,65 @@
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC.
-# All rights reserved.
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# (1) Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# (2) 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.
-#
-# (3) Neither the name of the copyright holder nor the names of any contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission from the respective party.
-#
-# (4) Other than as required in clauses (1) and (2), distributions in any form
-# of modifications or other derivative works may not use the "OpenStudio"
-# trademark, "OS", "os", or any other confusingly similar designation without
-# specific prior written permission from Alliance for Sustainable Energy, LLC.
-#
-# 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, THE UNITED STATES
-# GOVERNMENT, OR ANY 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 'fileutils'
-require 'json'
-require 'pathname'
-
-require_relative 'openstudio/workflow/version'
-require_relative 'openstudio/workflow/multi_delegator'
-require_relative 'openstudio/workflow/run'
-require_relative 'openstudio/workflow/job'
-require_relative 'openstudio/workflow/time_logger'
-require_relative 'openstudio/workflow/registry'
-require_relative 'openstudio/workflow/util'
-require 'openstudio'
-require_relative 'openstudio/workflow_runner'
-
-module OpenStudio
-  module Workflow
-    extend self
-
-    # Extract an archive to a specific location
-    #
-    # @param archive_filename [String] Path and name of the file to extract
-    # @param destination [String] Path to extract to
-    # @param overwrite [Boolean] If true, will overwrite any extracted file that may already exist
-    #
-    def extract_archive(archive_filename, destination, overwrite = true)
-      zf = OpenStudio::UnzipFile.new(archive_filename)
-      zf.extractAllFiles(destination)
-    end
-  end
-end
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) 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.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# 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, THE UNITED STATES
+# GOVERNMENT, OR ANY 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 'fileutils'
+require 'json'
+require 'pathname'
+
+require_relative 'openstudio/workflow/version'
+require_relative 'openstudio/workflow/multi_delegator'
+require_relative 'openstudio/workflow/run'
+require_relative 'openstudio/workflow/job'
+require_relative 'openstudio/workflow/time_logger'
+require_relative 'openstudio/workflow/registry'
+require_relative 'openstudio/workflow/util'
+require 'openstudio'
+require_relative 'openstudio/workflow_runner'
+
+module OpenStudio
+  module Workflow
+    module_function
+
+    # Extract an archive to a specific location
+    #
+    # @param archive_filename [String] Path and name of the file to extract
+    # @param destination [String] Path to extract to
+    # @param overwrite [Boolean] If true, will overwrite any extracted file that may already exist
+    #
+    def extract_archive(archive_filename, destination, overwrite = true)
+      zf = OpenStudio::UnzipFile.new(archive_filename)
+      zf.extractAllFiles(destination)
+    end
+  end
+end