openstudio-analysis 1.3.6 → 1.3.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/openstudio-analysis.yml +40 -40
- data/.gitignore +21 -21
- data/.rubocop.yml +9 -9
- data/CHANGELOG.md +274 -269
- data/Gemfile +14 -14
- data/README.md +102 -102
- data/Rakefile +40 -40
- data/lib/openstudio/analysis/algorithm_attributes.rb +47 -47
- data/lib/openstudio/analysis/formulation.rb +881 -857
- data/lib/openstudio/analysis/server_api.rb +862 -862
- data/lib/openstudio/analysis/server_scripts.rb +108 -108
- data/lib/openstudio/analysis/support_files.rb +104 -104
- data/lib/openstudio/analysis/translator/datapoints.rb +454 -454
- data/lib/openstudio/analysis/translator/excel.rb +893 -893
- data/lib/openstudio/analysis/translator/workflow.rb +143 -143
- data/lib/openstudio/analysis/version.rb +12 -12
- data/lib/openstudio/analysis/workflow.rb +302 -279
- data/lib/openstudio/analysis/workflow_step.rb +523 -523
- data/lib/openstudio/analysis.rb +144 -144
- data/lib/openstudio/helpers/hash.rb +10 -10
- data/lib/openstudio/helpers/string.rb +36 -36
- data/lib/openstudio/helpers/utils.rb +36 -36
- data/lib/openstudio/weather/epw.rb +178 -178
- data/lib/openstudio-analysis.rb +47 -47
- data/openstudio-analysis.gemspec +38 -38
- data/update_license.rb +60 -60
- metadata +2 -2
data/CHANGELOG.md
CHANGED
@@ -1,269 +1,274 @@
|
|
1
|
-
OpenStudio(R) Analysis Gem Change Log
|
2
|
-
==================================
|
3
|
-
|
4
|
-
Version 1.3.
|
5
|
-
-------------
|
6
|
-
*
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
*
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
* Add
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
*
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
*
|
33
|
-
*
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
*
|
39
|
-
* Add
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
*
|
44
|
-
*
|
45
|
-
*
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
*
|
50
|
-
*
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
*
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
*
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
*
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
*
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
*
|
86
|
-
*
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
*
|
100
|
-
*
|
101
|
-
*
|
102
|
-
*
|
103
|
-
*
|
104
|
-
*
|
105
|
-
*
|
106
|
-
*
|
107
|
-
*
|
108
|
-
*
|
109
|
-
*
|
110
|
-
*
|
111
|
-
*
|
112
|
-
*
|
113
|
-
*
|
114
|
-
*
|
115
|
-
*
|
116
|
-
*
|
117
|
-
*
|
118
|
-
*
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
*
|
123
|
-
*
|
124
|
-
|
125
|
-
Version 0.4.
|
126
|
-
------------------
|
127
|
-
*
|
128
|
-
*
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
*
|
133
|
-
*
|
134
|
-
*
|
135
|
-
*
|
136
|
-
*
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
*
|
141
|
-
*
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
*
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
*
|
156
|
-
|
157
|
-
Version 0.3.
|
158
|
-
-------------
|
159
|
-
*
|
160
|
-
*
|
161
|
-
|
162
|
-
Version 0.3.
|
163
|
-
|
164
|
-
*
|
165
|
-
*
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
*
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
*
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
*
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
*
|
184
|
-
*
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
*
|
190
|
-
*
|
191
|
-
|
192
|
-
Version 0.3.
|
193
|
-
--------------
|
194
|
-
*
|
195
|
-
*
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
*
|
202
|
-
*
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
*
|
208
|
-
|
209
|
-
|
210
|
-
Version 0.1.
|
211
|
-
|
212
|
-
*
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
218
|
-
|
219
|
-
* Add
|
220
|
-
*
|
221
|
-
|
222
|
-
Version 0.1.
|
223
|
-
-------------
|
224
|
-
* Add
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
*
|
234
|
-
|
235
|
-
Version 0.1.
|
236
|
-
-------------
|
237
|
-
*
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
|
242
|
-
*
|
243
|
-
|
244
|
-
Version 0.1.
|
245
|
-
-------------
|
246
|
-
*
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
269
|
-
|
1
|
+
OpenStudio(R) Analysis Gem Change Log
|
2
|
+
==================================
|
3
|
+
|
4
|
+
Version 1.3.7
|
5
|
+
-------------
|
6
|
+
* Add move_measure_after()
|
7
|
+
* Add custom Gemfile to zip: osa.gem_files.add('spec/files/gem_files/Gemfile')
|
8
|
+
|
9
|
+
Version 1.3.6
|
10
|
+
-------------
|
11
|
+
* Bump BCL and Rubocop
|
12
|
+
|
13
|
+
Version 1.3.5
|
14
|
+
-------------
|
15
|
+
* Increase Timeouts and write_timeouts to deal with latencies for network related issues
|
16
|
+
|
17
|
+
Version 1.3.4
|
18
|
+
-------------
|
19
|
+
* Update licenses
|
20
|
+
* Add download_zip, download_osm, download_osw, download_reports attributes to OSA
|
21
|
+
* Add cli_verbose, cli_debug, initialize_worker_timeout, run_workflow_timeout, upload_results_timeout attributes to OSA
|
22
|
+
|
23
|
+
Version 1.3.3
|
24
|
+
-------------
|
25
|
+
* Add arguments to .save_osa_zip() to add all files in weather and/or seed directories to zip file. defaults to false.
|
26
|
+
|
27
|
+
Version 1.3.2
|
28
|
+
-------------
|
29
|
+
* Add array of search paths to .convert_osw() to find measures in various directories.
|
30
|
+
* warn if :weather_file and :seed_model are not defined.
|
31
|
+
* use :file_paths in the OSW to search for :seed_model and :weather_file.
|
32
|
+
* add .stat and .ddy files to analysis.zip if in same directory as .epw defined in :weather_file.
|
33
|
+
* use :measure_paths in OSW to search for measures.
|
34
|
+
|
35
|
+
Version 1.3.1
|
36
|
+
-------------
|
37
|
+
* Add method to delete a Variable: **analysis.remove_variable()**
|
38
|
+
* fix bug related to multiple calls to analysis.to_hash deleting variables
|
39
|
+
* Add PSO and Optim to allowed algorithms
|
40
|
+
|
41
|
+
Version 1.3.0
|
42
|
+
-------------
|
43
|
+
* Create an OSA from an OSW: **analysis.convert_osw()**
|
44
|
+
* Add output variables and objective functions: **analysis.add_output()**
|
45
|
+
* Add server initialization and finalization scripts: **analysis.server_scripts.add()**
|
46
|
+
* Set algorithm attributes: **analysis.algorithm.set_attribute()**
|
47
|
+
* Set algorithm type: **analysis.analysis_type()**
|
48
|
+
* Add additional library/data files: **analysis.libraries.add()**
|
49
|
+
* create analysis.json: **File.write('analysis.json',JSON.pretty_generate(analysis.to_hash))**
|
50
|
+
* create analysis.zip: **analysis.save_osa_zip('analysis.zip')**
|
51
|
+
|
52
|
+
Version 1.2.0
|
53
|
+
-------------
|
54
|
+
* master -> main
|
55
|
+
* Remove support for Ruby 2.5. Only support Ruby ~> 2.7.0
|
56
|
+
* BCL ~> 0.7.0
|
57
|
+
* Use GitHub actions for CI
|
58
|
+
|
59
|
+
Version 1.1.0
|
60
|
+
-------------
|
61
|
+
* Allow for blank :seed, :weather_file and :workflow sections of OSA
|
62
|
+
|
63
|
+
Version 1.0.6
|
64
|
+
-------------
|
65
|
+
* Always include ../lib to the file paths to search
|
66
|
+
|
67
|
+
Version 1.0.5
|
68
|
+
-------------
|
69
|
+
* Upgrade to latest BCL (0.6.1)
|
70
|
+
* Remove the need for the measure.json (which has been deprecated in BCL gem). Now parses the measure.xml.
|
71
|
+
* Upgrade Faraday (1.0.1)
|
72
|
+
* Remove dependency on Nokogiri.
|
73
|
+
|
74
|
+
Version 1.0.4
|
75
|
+
-------------
|
76
|
+
* Update dependency Nokogiri
|
77
|
+
|
78
|
+
Version 1.0.3
|
79
|
+
-------------
|
80
|
+
* Update dependencies roo and rubyzip
|
81
|
+
|
82
|
+
Version 1.0.2
|
83
|
+
-------------
|
84
|
+
* Updates required for OpenStudio 3x
|
85
|
+
* Require Ruby ~> 2.5.1
|
86
|
+
* Update to Nokogiri ~> 1.8.2 (required for Ruby 2.5 on Windows)
|
87
|
+
|
88
|
+
Version 1.0.1
|
89
|
+
-------------
|
90
|
+
* Add support for Ruby 2.5.1 (keeping support for 2.2)
|
91
|
+
* Lock version of Roo to older version
|
92
|
+
* Updated copyright dates and remove old LGPL license. License is not LGPL but a BSD-style license.
|
93
|
+
|
94
|
+
Version 1.0.0
|
95
|
+
-------------
|
96
|
+
This is the first official release in quite some time. This includes many changes which unfortunately have not been
|
97
|
+
cataloged. The changes from 0.4.5 include:
|
98
|
+
|
99
|
+
* Requires ruby > 2.1.
|
100
|
+
* Default path to ServerApi logfile to ~/os_server_api.log. This can be overridden by setting the log_path options key in the initializer.
|
101
|
+
* Fix get_datapoint_status for new version of API where data_points are under analysis
|
102
|
+
* Fix boolean data type in datapoints translator
|
103
|
+
* Allow __skip__ variable in datapoints translator
|
104
|
+
* Fix bug in batch datapoints to look for outputs_json, not outputs when importing the definition of the outputs JSON file.
|
105
|
+
* Allow "None" as an argument in batch datapoints. This will allow the measure to be added without setting any of the arguments. Useful for adding Reporting Measures to the workflow.
|
106
|
+
* Use more recent version of BCL gem for underscoring strings
|
107
|
+
* When creating OSWs from batch datapoints, set the default run_directory to ./run
|
108
|
+
* fix get_datapoint method. show_full is no longer a valid endpoint in the new server code
|
109
|
+
* Change seed_model to seed_file in OSWs generated from the translator
|
110
|
+
* Add more unit tests
|
111
|
+
* Catch null arguments when translating from OSA/OSD to OSW
|
112
|
+
* Note that pre.rc1 was yanked from Rubygems.
|
113
|
+
* Remove allow_multiple_jobs and server_as_worker options. These are by defaulted to true now.
|
114
|
+
* Remove uncertain strings from end of uncertainty distributions
|
115
|
+
* Remove measures eval path for CSV import
|
116
|
+
* Add diag analysis type to server_api run method
|
117
|
+
* Remove support for Rubies < 2.0 and > 2.0.
|
118
|
+
* Add json extension to formulation name upon save if none exists
|
119
|
+
* Add zip extension to formulation zip upon save if none exists
|
120
|
+
* In upload_datapoint, allows set the analysis_id in the file to the one passed.
|
121
|
+
* Remove reading JSON from custom_csv method.
|
122
|
+
* Fixed bug in workflow translator which caused errors in server models
|
123
|
+
* Updated gem versions to converge across the OpenStudio Analysis Framework platforms
|
124
|
+
|
125
|
+
Version 0.4.4
|
126
|
+
------------------
|
127
|
+
* Increment objective function count only if they are true
|
128
|
+
* Do not add an output if the variable name has already been added
|
129
|
+
|
130
|
+
Version 0.4.3
|
131
|
+
------------------
|
132
|
+
* Add defaults to the OpenStudio::Analysis::ServerApi .run method.
|
133
|
+
* Bug fix for path to the measure if there was more than one depth of the directory.
|
134
|
+
* Add measure_definition_directory_local to store the path to the original measure.
|
135
|
+
* run_analysis will be deprecated in 0.5.0. Use start_analysis instead of run_analysis.
|
136
|
+
* Less stringent check on column names in Excel which caused errors at times.
|
137
|
+
* Do not error out when a measure argument is a String or Choice and does not contain Enumerations.
|
138
|
+
* New data point status API helper to list all the data points across all the analyses if desired.
|
139
|
+
* If the user sets a std dev or delta x on a uniform or discrete variable, allow it to persist. This allows certain algorithms (e.g. rgenoud) to use the data.
|
140
|
+
* New class OpenStudio::Weather::Epw to handle pulling data out of weather files.
|
141
|
+
* Deprecate the old ERB templates for creating the analysis.json via the Excel translator
|
142
|
+
|
143
|
+
Version 0.4.2
|
144
|
+
-------------
|
145
|
+
* Bug fix when adding measure from path, this now sets the correct argument name.
|
146
|
+
* Fix namespace conflict with OpenStudio::Logger and OpenStudio::Time
|
147
|
+
* Create method for saving the Analysis Zip file (save_analysis_zip)
|
148
|
+
|
149
|
+
Version 0.4.1
|
150
|
+
-------------
|
151
|
+
* Bug fix to address the spec/files directory being prepended to the measures
|
152
|
+
|
153
|
+
Version 0.4.0
|
154
|
+
-------------
|
155
|
+
* Add programmatic interface. This is now used when translating the Excel file into the JSON.
|
156
|
+
|
157
|
+
Version 0.3.7
|
158
|
+
-------------
|
159
|
+
* Worker initialization and finalization scripts
|
160
|
+
* Do not allow the file to process if the Measure Display Names are not unique
|
161
|
+
|
162
|
+
Version 0.3.6
|
163
|
+
-------------
|
164
|
+
* Allow multiple measure paths. Will search by order for the measure.
|
165
|
+
* Add AWS Tag in the Settings
|
166
|
+
|
167
|
+
Version 0.3.5
|
168
|
+
--------------
|
169
|
+
* Add delete_project method
|
170
|
+
* Integration testing
|
171
|
+
* Return status and filename of downlaoded files
|
172
|
+
* Methods for removing models from the Excel translator
|
173
|
+
* Return detailed analyses on a project
|
174
|
+
* Download database
|
175
|
+
|
176
|
+
Version 0.3.4
|
177
|
+
-------------
|
178
|
+
* BUG FIX: Measures were not being added to zip file
|
179
|
+
|
180
|
+
Version 0.3.3
|
181
|
+
-------------
|
182
|
+
* More unit tests
|
183
|
+
* Allow a UUID model name to be automatically generated if the model name is not specified
|
184
|
+
* Short name added to the variables input and output section of the spreadsheet. This required adding a new column and is not backwards compatible
|
185
|
+
|
186
|
+
Version 0.3.2
|
187
|
+
--------------
|
188
|
+
* Support both relative and absolute paths in the spreadsheet
|
189
|
+
* Helper methods for submitting analyses
|
190
|
+
* Add get_analysis method to Server API to get the status of an analysis
|
191
|
+
|
192
|
+
Version 0.3.1
|
193
|
+
--------------
|
194
|
+
* Grab the first EPW file, not the first file
|
195
|
+
* Download various formats via server API
|
196
|
+
|
197
|
+
Version 0.3.0
|
198
|
+
--------------
|
199
|
+
* Remove the column for Sampling Method. That is now part of the analysis config.
|
200
|
+
* All variables need static values now
|
201
|
+
* Updated output tab to add more information about the outputs if available
|
202
|
+
* Remove hardcoded baseline exception
|
203
|
+
|
204
|
+
Version 0.2.3
|
205
|
+
--------------
|
206
|
+
* Support for optional variables
|
207
|
+
* Display names and Machine names in the models now
|
208
|
+
* More error checking
|
209
|
+
|
210
|
+
Version 0.1.14
|
211
|
+
--------------
|
212
|
+
* Symbolize headers parsed from excel file.
|
213
|
+
|
214
|
+
|
215
|
+
Version 0.1.12/13
|
216
|
+
-------------
|
217
|
+
* Add machine name to pivot variables
|
218
|
+
* Force generation of unique UUIDs
|
219
|
+
* Add data types to arguments and variables for XML based measures
|
220
|
+
* Move Pivot variable type to Type (not sample method)
|
221
|
+
|
222
|
+
Version 0.1.11
|
223
|
+
-------------
|
224
|
+
* Add cluster name and openstudio server version
|
225
|
+
* Make the booleans in run_options actual booleans
|
226
|
+
|
227
|
+
Version 0.1.10
|
228
|
+
-------------
|
229
|
+
* Add output variables to the spreadsheet as a separate tab
|
230
|
+
|
231
|
+
Version 0.1.9
|
232
|
+
-------------
|
233
|
+
* Downcase checking of variable data types
|
234
|
+
|
235
|
+
Version 0.1.9
|
236
|
+
-------------
|
237
|
+
* Clean up the "delete_mes" in the JSONs
|
238
|
+
* Added discrete variables to the spreadsheet and bumped version
|
239
|
+
|
240
|
+
Version 0.1.8
|
241
|
+
-------------
|
242
|
+
* Parsing of Proxy parameters
|
243
|
+
|
244
|
+
Version 0.1.7
|
245
|
+
-------------
|
246
|
+
* Add setting section
|
247
|
+
* Add problem and algorithm arguments
|
248
|
+
|
249
|
+
Version 0.1.6
|
250
|
+
-------------
|
251
|
+
* Small fixes
|
252
|
+
|
253
|
+
Version 0.1.5
|
254
|
+
-------------
|
255
|
+
* Now depends on json_pure for window users
|
256
|
+
|
257
|
+
Version 0.1.3
|
258
|
+
-------------
|
259
|
+
* Removed spaced in measure type
|
260
|
+
|
261
|
+
Version 0.1.1
|
262
|
+
-------------
|
263
|
+
|
264
|
+
### Major Changes (may be backwards incompatible)
|
265
|
+
|
266
|
+
* Change XLSX translator to read from a "Variables" spreadsheet instead of "Sensitivity"
|
267
|
+
|
268
|
+
### Resolved Issues
|
269
|
+
|
270
|
+
* Added check for when weather file is a zip or an epw
|
271
|
+
|
272
|
+
* Convert argument values to the right variable types
|
273
|
+
|
274
|
+
* Add measure type parsing by reading the inherited class
|
data/Gemfile
CHANGED
@@ -1,14 +1,14 @@
|
|
1
|
-
source 'http://rubygems.org'
|
2
|
-
|
3
|
-
gemspec
|
4
|
-
|
5
|
-
gem 'colored', '~> 1.2'
|
6
|
-
gem 'openstudio-aws', '~> 0.4.2'
|
7
|
-
|
8
|
-
group :test do
|
9
|
-
# Don't install coveralls on window because requires devkit for json
|
10
|
-
unless Gem.win_platform?
|
11
|
-
gem 'coveralls', require: false
|
12
|
-
end
|
13
|
-
gem 'ci_reporter_rspec'
|
14
|
-
end
|
1
|
+
source 'http://rubygems.org'
|
2
|
+
|
3
|
+
gemspec
|
4
|
+
|
5
|
+
gem 'colored', '~> 1.2'
|
6
|
+
gem 'openstudio-aws', '~> 0.4.2'
|
7
|
+
|
8
|
+
group :test do
|
9
|
+
# Don't install coveralls on window because requires devkit for json
|
10
|
+
unless Gem.win_platform?
|
11
|
+
gem 'coveralls', require: false
|
12
|
+
end
|
13
|
+
gem 'ci_reporter_rspec'
|
14
|
+
end
|