README.md in openstudio-analysis-0.4.4 vs README.md in openstudio-analysis-0.4.5
- old
+ new
@@ -17,38 +17,55 @@
* Programmatically
```
-analysis = OpenStudio::Analysis.create
-analysis.seed_model = "local/dir/seed.osm"
-analysis.name = "Analysis Name"
+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
-wf.add_measure_from_path("path_to_measure")
-wf.add_measure_from_path("path_to_measure_2")
+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')
-# or allow the system to search for the measure based on default_measure_paths
-OpenStudio::Analysis.measure_paths = ['measures', '../project_specific_measures']
-wf.add_measure_by_name('measure_name')
-
# make a measure's argument a variable
-m = wf.add_measure("path_to_measure_3")
+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('path_to_measure_4')
+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_static_value('variable_argument_name', value)
+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")
```
+If you would like to run the data point, then you can use the OpenStudio-workflow gem.
-## Testing
+```
+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
+```
+
+## Testing
This gem used RSpec for testing. To test simply run `rspec` at the command line.
# Todos