openstudio-workflow 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ceb6100a442d5a16d724f51f956162ca46b38d6
-  data.tar.gz: aab8fbae2a4edab82eaea83f6ebd00d330339c0e
+  metadata.gz: 36393e28da7642fc75d1e780e913c86f43c46548
+  data.tar.gz: a9474bab185e5f286258129e73a58c5718a95ffd
 SHA512:
-  metadata.gz: a7d08630608ae324fe3b816b8af27571ee243062976c6c97780cd089670305a806ad3c81295f9ddeba84d636138c88a264557bb0f031dfd80090209b641927d2
-  data.tar.gz: 8bbab1896284b8bf7957b382932d83677576ae74208196622b56ce61b9d262ed225eec39078dff18217e5414f43da64f82ae41280eed0a49ff578acaa8130336
+  metadata.gz: a4079a380d92cfff3fa7fd60454babbb768517ec7ecb182d27b29af37508629bb668db2fce62aa3127121bc9d9e0ee02966c1eb36262ae9f95e340ce413b95d4
+  data.tar.gz: 36153a1892dd12bfb4d0dca47c32ca8a7f6a6bd0770a367d317c98ed9a8d82e3ec7edf1f15c429f69a319dca858d89db3f2a82cf9b9d8cc45f93b8a80dd5828c

data/CHANGELOG.md

@@ -1,72 +1,72 @@
-OpenStudio::Workflow Change Log
-==================================
-
-Version '1.0.0-rc1' (Not released)
--------------------
-* 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.0.0-rc1' (Not released)
+-------------------
+* 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,48 +1,93 @@
-# OpenStudio::Workflow
-[![Circle CI](https://circleci.com/gh/NREL/OpenStudio-workflow-gem/tree/osw.svg?style=svg)](https://circleci.com/gh/NREL/OpenStudio-workflow-gem/tree/osw)
-[![Coverage Status](https://coveralls.io/repos/NREL/OpenStudio-workflow-gem/badge.svg?branch=osw&service=github)](https://coveralls.io/github/NREL/OpenStudio-workflow-gem?branch=osw)
-
-## OpenStudio Workflow branch
-
-This branch is the development branch for the OpenStudio 2.0 workflow gem. This will become the primary branch when OpenStudio 2.0 is released.
-
-## Caveats and Todos
-
-### Todos
-
-* Find a better home for monthly_reports.idf
-* Fix issues around where standard reports and calibration reports run (and make them optional enabled)
-* Move registry into the WorkflowRunner class; this includes logging
-* Add a test to ensure that the models being returned contain alterations after apply_measure
-* Add unit tests for each util method
-* Clean up log messages (and code flow) for @current_state in run.rb
-* Define and document the complete set of options for the adapter and run classes
-* Implement better error handling with custom exception classes
-* Add a results adapter to return a string as the last call based on the source of the call. (e.g. R, command line, C++, etc).
-
-## Testing
-
-The preferred way for testing is to run rspec either natively or via docker. The issue with natively running the tests locally is the requirement to have mongo installed and running.
-
-### 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
+
+[![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

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 = %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

data/lib/openstudio-workflow.rb

@@ -1,49 +1,49 @@
-######################################################################
-#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
-#  All rights reserved.
-#
-#  This library is free software; you can redistribute it and/or
-#  modify it under the terms of the GNU Lesser General Public
-#  License as published by the Free Software Foundation; either
-#  version 2.1 of the License, or (at your option) any later version.
-#
-#  This library is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-#  Lesser General Public License for more details.
-#
-#  You should have received a copy of the GNU Lesser General Public
-#  License along with this library; if not, write to the Free Software
-#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-######################################################################
-
-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
+######################################################################
+#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+######################################################################
+
+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