openstudio-workflow 1.0.0.pat1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c29f63c328f9be8e74c4ff7c624e182255eda3cc
-  data.tar.gz: 9c1bfb9ea7768c7736eeb06b713b90a00c780617
+  metadata.gz: 41a1b251ada32dafc258c2f0fc90afbbc4ba043d
+  data.tar.gz: 87b2d6a43d56d43c2eb51317ec060fbdb5737026
 SHA512:
-  metadata.gz: 4e3ab5fce7038567f820f1bfb17ec6287ecdf76842d672d077b8033ed69f600b4297ecce41322b765e7ad847d5003801005575ddb7c99da11bdff24be26e784e
-  data.tar.gz: 4efcf97529a9a83871b70fd84c303e8b6c209cd4fe75ed0c6a278b16228e9675b202e9a5a78917216bfb0ed4ae5bbefa66c122af2f5f8650e8a423f1eac4130b
+  metadata.gz: 52e7e0b922390bf6ba53039a35d31da5db0a5d1936d014147158c878ec6366b86f39186f6b5834783e46e63d06577933acc369aa21fb6b194be77341ddb66f77
+  data.tar.gz: e307a06376afd682d42a8f02e07450eb939fba1d07bd7d4d096966a7b6d7aad1fc27286ad8d349c089490b5287dc125bf36c972192daed8448835a051fb3853c

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 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

data/README.md

@@ -1,68 +1,24 @@
 # 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)
+[![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)
 
-Run an EnergyPlus simulation using a file-based workflow that is read from a Local or MongoDB adapter.
+## OpenStudio Workflow branch
 
-## 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.
+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
 
-* Read the analysis.json file to determine the states that are going to run instead of (or in addition to) passing them into the constructor
+* 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).
-* Implement a logger in the Adapters, right now they are unable to log
-* Hook up the measure group based workflows
 
 ## Testing
 
@@ -71,24 +27,16 @@ The preferred way for testing is to run rspec either natively or via docker. The
 ### Locally
 
 ```
-rake
+rspec spec/
 ```
 
 ### Docker
 
-To run all the tests automatically run:
-```
-docker run --rm -v $(pwd):/var/simdata/openstudio nrel/docker-test-containers:openstudio-1.8.5-mongo-2.4 /var/simdata/openstudio/test/bin/docker-run.sh
-```
-
-To run the tests inside docker and enable debugging, then create a bash shell in docker with:
 ```
-docker run -it --rm -v $(pwd):/var/simdata/openstudio nrel/docker-test-containers:openstudio-1.8.5-mongo-2.4 bash
-service mongodb start
-bundle update
-rake 
-# or
-bundle exec rspec <file>:<line>
+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

data/Rakefile

@@ -1,12 +1,5 @@
 require 'bundler'
-
-begin
-  Bundler.setup
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts 'Run `bundle install` to install missing gems'
-  exit e.status_code
-end
+Bundler.setup
 
 require 'rspec/core/rake_task'
 
@@ -22,6 +15,7 @@ RSpec::Core::RakeTask.new('spec:unit') do |spec|
 end
 
 task 'spec:unit' => 'ci:setup:rspec'
+task default: 'spec:unit'
 
 require 'rubocop/rake_task'
 desc 'Run RuboCop on the lib directory'
@@ -33,4 +27,10 @@ RuboCop::RakeTask.new(:rubocop) do |task|
   task.fail_on_error = false
 end
 
-task default: 'spec:unit'
+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