README.md in openstudio-analysis-1.3.5 vs README.md in openstudio-analysis-1.3.6
- old
+ new
@@ -1,102 +1,102 @@
-# OpenStudio(R) Analysis Gem
-
-[](https://github.com/NREL/OpenStudio-analysis-gem/actions/workflows/openstudio-analysis.yml)
-[](https://coveralls.io/r/NREL/OpenStudio-analysis-gem?branch=develop)
-[](https://badge.fury.io/rb/openstudio-analysis)
-
-The OpenStudio Analysis Gem is used to communicate files to the [OpenStudio Analysis Framework](https://www.tandfonline.com/doi/full/10.1080/19401493.2020.1778788).
-
-The purpose of this gem is to generate the analysis.json file, analysis.zip, convert an OSW to an OSA, and communicate with the server to upload
-the simulations.
-
-This gem does not create the cluster. To manage cloud resources use the [OpenStudio Analysis Framework Helm Charts](https://github.com/NREL/openstudio-server-helm).
-
-## Instructions
-
-There are two ways to create an OpenStudio Analysis description:
-* Use the Excel Translator
-
-
-* Programmatically
-
- ```
- analysis = OpenStudio::Analysis.create('Analysis Name')
- analysis.seed_model = 'local/dir/seed.osm'
- analysis.weather_file = 'local/dir/USA_CO_Golden-NREL.724666_TMY3.epw'
-
- # override existing workflow from a file by
- analysis.workflow = OpenStudio::Analysis::Workflow.load_from_file(...)
-
- # add measures to the workflow
- wf = analysis.workflow
- # def add_measure_from_path(instance_name, instance_display_name, local_path_to_measure)
- wf.add_measure_from_path('instance_name', 'Display name', 'path_to_measure')
- wf.add_measure_from_path('instance_name_2', 'Display name two', 'path_to_measure_2')
-
- # make a measure's argument a variable
- m = wf.add_measure_from_path('instance_name_3', 'Display name three', 'path_to_measure_3')
- m.make_variable('variable_argument_name', 'discrete')
-
- m = wf.add_measure_from_path('instance_name_4', 'Display name four', 'path_to_measure_4')
- m.make_variable('variable_argument_name', 'pivot')
- m.argument_value('variable_argument_name', value)
-
- # Save off the analysis files and a static data point
- run_dir = 'local/run'
- analysis.save("#{run_dir}/analysis.json")
- analysis.save_zip("#{run_dir}/analysis.zip")
- analysis.save_static_data_point("#{run_dir}/data_point.zip")
- ```
-
-* Running Datapoints with Workflow Gem
-
- ```
- require 'openstudio-workflow'
-
- run_dir = 'local/run'
- OpenStudio::Workflow.extract_archive("#{run_dir}/analysis.zip", run_dir)
-
- options = {
- problem_filename: 'analysis.json',
- datapoint_filename: 'data_point.json',
- analysis_root_path: run_dir
- }
- k = OpenStudio::Workflow.load 'Local', run_dir, options
- k.run
- ```
-
-* Server API
-
-## Testing
-
-This gem used RSpec for testing. To test simply run `bundle exec rspec` at the command line.
-
-# Releasing
-
-Follow the steps below when releasing a new version:
-
-1. Update /lib/openstudio/analysis/version.rb to the next version. Make sure to follow semantic versioning.
-2. Add changes to the CHANGELOG.md.
-3. Run rubocop and make sure code meets coding standards.
-4. Push release candidate on a branch.
-5. Create a pull request to develop. Once the tests pass, merge into develop.
-6. Create a pull request to main. Once tests pass, then merge into main.
-7. Checkout main and run `rake release`
-
-# Todos
-
-In the programmatic interface there are still several items that would be nice to have.
-
-* Check the type of measure being added and make sure that it is in the right workflow (e.g. no energyplus measures before rubymeasures)
-* add reverse translator from existing analysis.jsons
-* more explicit run workflows. For example, add workflow steps for running energyplus, openstudio translator, radiance, etc
-* more explicit assignment of the analyses that can run. This would be nice:
-
- ```
- a = OpenStudio::Analysis.create("new analysis")
- a.analysis_type('single_run')
- ```
-
-* adding mulitple seed models
-* adding multiple weather files
-
+# OpenStudio(R) Analysis Gem
+
+[](https://github.com/NREL/OpenStudio-analysis-gem/actions/workflows/openstudio-analysis.yml)
+[](https://coveralls.io/r/NREL/OpenStudio-analysis-gem?branch=develop)
+[](https://badge.fury.io/rb/openstudio-analysis)
+
+The OpenStudio Analysis Gem is used to communicate files to the [OpenStudio Analysis Framework](https://www.tandfonline.com/doi/full/10.1080/19401493.2020.1778788).
+
+The purpose of this gem is to generate the analysis.json file, analysis.zip, convert an OSW to an OSA, and communicate with the server to upload
+the simulations.
+
+This gem does not create the cluster. To manage cloud resources use the [OpenStudio Analysis Framework Helm Charts](https://github.com/NREL/openstudio-server-helm).
+
+## Instructions
+
+There are two ways to create an OpenStudio Analysis description:
+* Use the Excel Translator
+
+
+* Programmatically
+
+ ```
+ analysis = OpenStudio::Analysis.create('Analysis Name')
+ analysis.seed_model = 'local/dir/seed.osm'
+ analysis.weather_file = 'local/dir/USA_CO_Golden-NREL.724666_TMY3.epw'
+
+ # override existing workflow from a file by
+ analysis.workflow = OpenStudio::Analysis::Workflow.load_from_file(...)
+
+ # add measures to the workflow
+ wf = analysis.workflow
+ # def add_measure_from_path(instance_name, instance_display_name, local_path_to_measure)
+ wf.add_measure_from_path('instance_name', 'Display name', 'path_to_measure')
+ wf.add_measure_from_path('instance_name_2', 'Display name two', 'path_to_measure_2')
+
+ # make a measure's argument a variable
+ m = wf.add_measure_from_path('instance_name_3', 'Display name three', 'path_to_measure_3')
+ m.make_variable('variable_argument_name', 'discrete')
+
+ m = wf.add_measure_from_path('instance_name_4', 'Display name four', 'path_to_measure_4')
+ m.make_variable('variable_argument_name', 'pivot')
+ m.argument_value('variable_argument_name', value)
+
+ # Save off the analysis files and a static data point
+ run_dir = 'local/run'
+ analysis.save("#{run_dir}/analysis.json")
+ analysis.save_zip("#{run_dir}/analysis.zip")
+ analysis.save_static_data_point("#{run_dir}/data_point.zip")
+ ```
+
+* Running Datapoints with Workflow Gem
+
+ ```
+ require 'openstudio-workflow'
+
+ run_dir = 'local/run'
+ OpenStudio::Workflow.extract_archive("#{run_dir}/analysis.zip", run_dir)
+
+ options = {
+ problem_filename: 'analysis.json',
+ datapoint_filename: 'data_point.json',
+ analysis_root_path: run_dir
+ }
+ k = OpenStudio::Workflow.load 'Local', run_dir, options
+ k.run
+ ```
+
+* Server API
+
+## Testing
+
+This gem used RSpec for testing. To test simply run `bundle exec rspec` at the command line.
+
+# Releasing
+
+Follow the steps below when releasing a new version:
+
+1. Update /lib/openstudio/analysis/version.rb to the next version. Make sure to follow semantic versioning.
+2. Add changes to the CHANGELOG.md.
+3. Run rubocop and make sure code meets coding standards.
+4. Push release candidate on a branch.
+5. Create a pull request to develop. Once the tests pass, merge into develop.
+6. Create a pull request to main. Once tests pass, then merge into main.
+7. Checkout main and run `rake release`
+
+# Todos
+
+In the programmatic interface there are still several items that would be nice to have.
+
+* Check the type of measure being added and make sure that it is in the right workflow (e.g. no energyplus measures before rubymeasures)
+* add reverse translator from existing analysis.jsons
+* more explicit run workflows. For example, add workflow steps for running energyplus, openstudio translator, radiance, etc
+* more explicit assignment of the analyses that can run. This would be nice:
+
+ ```
+ a = OpenStudio::Analysis.create("new analysis")
+ a.analysis_type('single_run')
+ ```
+
+* adding mulitple seed models
+* adding multiple weather files
+