urbanopt-scenario 0.4.2 → 0.4.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/pull_request_template.md +1 -1
- data/CHANGELOG.md +14 -0
- data/Gemfile +1 -1
- data/RDOC_MAIN.md +2 -2
- data/README.md +1 -1
- data/docs/.vuepress/components/InnerJsonSchema.vue +7 -15
- data/docs/.vuepress/config.js +13 -9
- data/docs/.vuepress/highlight.js +1 -1
- data/docs/.vuepress/json-schema-deref-loader.js +22 -0
- data/docs/README.md +2 -2
- data/docs/package-lock.json +355 -471
- data/docs/package.json +4 -4
- data/lib/urbanopt/scenario/extension.rb +5 -3
- data/lib/urbanopt/scenario/scenario_base.rb +4 -4
- data/lib/urbanopt/scenario/scenario_csv.rb +7 -8
- data/lib/urbanopt/scenario/scenario_datapoint_base.rb +4 -4
- data/lib/urbanopt/scenario/scenario_post_processor_base.rb +2 -2
- data/lib/urbanopt/scenario/scenario_post_processor_default.rb +23 -15
- data/lib/urbanopt/scenario/scenario_post_processor_opendss.rb +7 -7
- data/lib/urbanopt/scenario/scenario_runner_base.rb +6 -5
- data/lib/urbanopt/scenario/scenario_runner_osw.rb +6 -4
- data/lib/urbanopt/scenario/scenario_visualization.rb +4 -5
- data/lib/urbanopt/scenario/simulation_dir_base.rb +3 -3
- data/lib/urbanopt/scenario/simulation_dir_osw.rb +4 -4
- data/lib/urbanopt/scenario/simulation_mapper_base.rb +3 -3
- data/lib/urbanopt/scenario/version.rb +1 -1
- data/urbanopt-scenario-gem.gemspec +3 -3
- metadata +9 -10
- data/docs/.vuepress/components/ScenarioSchema.vue +0 -12
- data/docs/schemas/scenario-schema.md +0 -3
data/docs/package.json
CHANGED
@@ -10,11 +10,11 @@
|
|
10
10
|
},
|
11
11
|
"author": "NREL",
|
12
12
|
"dependencies": {
|
13
|
-
"highlight.js": "^10.2.
|
13
|
+
"highlight.js": "^10.2.1",
|
14
14
|
"json-schema-ref-parser": "^9.0.6",
|
15
15
|
"json-schema-view-js": "git+https://git@github.com/bgschiller/json-schema-view-js.git",
|
16
|
-
"vuepress": "^1.
|
17
|
-
"webpack-dev-middleware": "^3.
|
16
|
+
"vuepress": "^1.6.0",
|
17
|
+
"webpack-dev-middleware": "^3.6.0"
|
18
18
|
},
|
19
19
|
"devDependencies": {
|
20
20
|
"braces": "^3.0.2",
|
@@ -25,6 +25,6 @@
|
|
25
25
|
"node-forge": ">=0.10.0",
|
26
26
|
"serialize-javascript": "^5.0.1",
|
27
27
|
"set-value": "^3.0.2",
|
28
|
-
"yargs-parser": "
|
28
|
+
"yargs-parser": "^20.2.1"
|
29
29
|
}
|
30
30
|
}
|
@@ -39,14 +39,15 @@ module URBANopt
|
|
39
39
|
end
|
40
40
|
|
41
41
|
##
|
42
|
-
#
|
42
|
+
# [return:] Absolute path of the measures or nil if there is none, can be used when configuring OSWs.
|
43
43
|
def measures_dir
|
44
44
|
return File.absolute_path(File.join(@root_dir, 'lib', 'measures'))
|
45
45
|
end
|
46
46
|
|
47
47
|
##
|
48
48
|
# Relevant files such as weather data, design days, etc.
|
49
|
-
|
49
|
+
##
|
50
|
+
# [return:] Absolute path of the files or nil if there is none, used when configuring OSWs
|
50
51
|
def files_dir
|
51
52
|
return nil
|
52
53
|
end
|
@@ -54,7 +55,8 @@ module URBANopt
|
|
54
55
|
##
|
55
56
|
# Doc templates are common files like copyright files which are used to update measures and other code.
|
56
57
|
# Doc templates will only be applied to measures in the current repository.
|
57
|
-
|
58
|
+
##
|
59
|
+
# [return:] Absolute path of the doc templates dir or nil if there is none.
|
58
60
|
def doc_templates_dir
|
59
61
|
return File.absolute_path(File.join(@root_dir, 'doc_templates'))
|
60
62
|
end
|
@@ -36,10 +36,10 @@ module URBANopt
|
|
36
36
|
# Initialize ScenarioBase attributes: +name+ , +root directory+ , +run directory+ and +feature_file+
|
37
37
|
##
|
38
38
|
# [parameters:]
|
39
|
-
# +name+ - _String_ - Human readable scenario name.
|
40
|
-
# +root_dir+ - _String_ - Root directory for the scenario, contains Gemfile describing dependencies.
|
41
|
-
# +run_dir+ - _String_ - Directory for simulation of this scenario, deleting run directory clears the scenario.
|
42
|
-
# +feature_file+ - _FeatureFile_ - An instance of +URBANopt::Core::FeatureFile+ containing features for simulation.
|
39
|
+
# * +name+ - _String_ - Human readable scenario name.
|
40
|
+
# * +root_dir+ - _String_ - Root directory for the scenario, contains Gemfile describing dependencies.
|
41
|
+
# * +run_dir+ - _String_ - Directory for simulation of this scenario, deleting run directory clears the scenario.
|
42
|
+
# * +feature_file+ - _FeatureFile_ - An instance of +URBANopt::Core::FeatureFile+ containing features for simulation.
|
43
43
|
def initialize(name, root_dir, run_dir, feature_file)
|
44
44
|
@name = name
|
45
45
|
@root_dir = root_dir
|
@@ -42,14 +42,13 @@ module URBANopt
|
|
42
42
|
# The CSV file has three columns 1) feature_id, 2) feature_name, and 3) mapper_class_name. There is one row for each Feature.
|
43
43
|
##
|
44
44
|
# [parameters:]
|
45
|
-
# +name+ - _String_ - Human readable scenario name.
|
46
|
-
# +root_dir+ - _String_ - Root directory for the scenario, contains Gemfile describing dependencies.
|
47
|
-
# +run_dir+ - _String_ - Directory for simulation of this scenario, deleting run directory clears the scenario.
|
48
|
-
# +feature_file+ - _URBANopt::Core::FeatureFile_ - FeatureFile containing features to simulate.
|
49
|
-
# +mapper_files_dir+ - _String_ - Directory containing all mapper class files containing MapperBase definitions.
|
50
|
-
# +csv_file+ - _String_ - Path to CSV file assigning a MapperBase class to each feature in feature_file.
|
51
|
-
# +num_header_rows+ -
|
52
|
-
|
45
|
+
# * +name+ - _String_ - Human readable scenario name.
|
46
|
+
# * +root_dir+ - _String_ - Root directory for the scenario, contains Gemfile describing dependencies.
|
47
|
+
# * +run_dir+ - _String_ - Directory for simulation of this scenario, deleting run directory clears the scenario.
|
48
|
+
# * +feature_file+ - _URBANopt::Core::FeatureFile_ - FeatureFile containing features to simulate.
|
49
|
+
# * +mapper_files_dir+ - _String_ - Directory containing all mapper class files containing MapperBase definitions.
|
50
|
+
# * +csv_file+ - _String_ - Path to CSV file assigning a MapperBase class to each feature in feature_file.
|
51
|
+
# * +num_header_rows+ - _String_ - Number of header rows to skip in CSV file.
|
53
52
|
def initialize(name, root_dir, run_dir, feature_file, mapper_files_dir, csv_file, num_header_rows)
|
54
53
|
super(name, root_dir, run_dir, feature_file)
|
55
54
|
@mapper_files_dir = mapper_files_dir
|
@@ -38,10 +38,10 @@ module URBANopt
|
|
38
38
|
# A Simulation Mapper will map the
|
39
39
|
##
|
40
40
|
# [parameters:]
|
41
|
-
#
|
42
|
-
#
|
43
|
-
#
|
44
|
-
#
|
41
|
+
# * +scenario+ - _ScenarioBase_ - Scenario containing this ScenarioDatapoint.
|
42
|
+
# * +feature_id+ - _String_ - Unique id of the feature for this ScenarioDatapoint.
|
43
|
+
# * +feature_name+ - _String_ - Human readable name of the feature for this ScenarioDatapoint.
|
44
|
+
# * +mapper_class+ - _String_ - Name of Ruby class used to translate feature to simulation OSW.
|
45
45
|
def initialize(scenario, feature_id, feature_name, mapper_class)
|
46
46
|
@scenario = scenario
|
47
47
|
@feature_id = feature_id
|
@@ -35,7 +35,7 @@ module URBANopt
|
|
35
35
|
# ScenarioPostProcessorBase post-processes a Scenario to create scenario level results.
|
36
36
|
##
|
37
37
|
# [parameters:]
|
38
|
-
# +scenario_base+ - _ScenarioBase_ - An object of ScenarioBase class.
|
38
|
+
# * +scenario_base+ - _ScenarioBase_ - An object of ScenarioBase class.
|
39
39
|
def initialize(scenario_base)
|
40
40
|
@scenario_base = scenario_base
|
41
41
|
end
|
@@ -53,7 +53,7 @@ module URBANopt
|
|
53
53
|
# Add results from a simulation_dir to this result.
|
54
54
|
##
|
55
55
|
# [parameters:]
|
56
|
-
# +simulation_dir+ - _SimulationDirOSW_ - An object on SimulationDirOSW class.
|
56
|
+
# * +simulation_dir+ - _SimulationDirOSW_ - An object on SimulationDirOSW class.
|
57
57
|
def add_simulation_dir(simulation_dir)
|
58
58
|
raise 'add_simulation_dir not implemented for ScenarioPostProcessorBase, override in your class'
|
59
59
|
end
|
@@ -43,7 +43,7 @@ module URBANopt
|
|
43
43
|
# ScenarioPostProcessorBase post-processes a scenario to create scenario level results
|
44
44
|
##
|
45
45
|
# [parameters:]
|
46
|
-
# +scenario_base+ - _ScenarioBase_ - An object of ScenarioBase class.
|
46
|
+
# * +scenario_base+ - _ScenarioBase_ - An object of ScenarioBase class.
|
47
47
|
def initialize(scenario_base)
|
48
48
|
super(scenario_base)
|
49
49
|
|
@@ -69,7 +69,7 @@ module URBANopt
|
|
69
69
|
# Add results from a simulation_dir to this result.
|
70
70
|
##
|
71
71
|
# [parameters:]
|
72
|
-
# +simulation_dir+ - _SimulationDirOSW_ - An object on SimulationDirOSW class.
|
72
|
+
# * +simulation_dir+ - _SimulationDirOSW_ - An object on SimulationDirOSW class.
|
73
73
|
def add_simulation_dir(simulation_dir)
|
74
74
|
feature_reports = URBANopt::Reporting::DefaultReports::FeatureReport.from_simulation_dir(simulation_dir)
|
75
75
|
|
@@ -86,6 +86,9 @@ module URBANopt
|
|
86
86
|
|
87
87
|
# Create database file with scenario-level results
|
88
88
|
# Sum values for each timestep across all features. Save to new table in a new database
|
89
|
+
##
|
90
|
+
# [parameters:]
|
91
|
+
# * +file_name+ - _String_ - Assign a name to the saved scenario results file
|
89
92
|
def create_scenario_db_file(file_name = @default_save_name)
|
90
93
|
new_db_file = File.join(@initialization_hash[:directory_name], "#{file_name}.db")
|
91
94
|
scenario_db = SQLite3::Database.open new_db_file
|
@@ -97,8 +100,9 @@ module URBANopt
|
|
97
100
|
Hour VARCHAR(255),
|
98
101
|
Minute VARCHAR(255),
|
99
102
|
Dst INTEGER,
|
100
|
-
|
101
|
-
Value INTEGER
|
103
|
+
FuelType VARCHAR(255),
|
104
|
+
Value INTEGER,
|
105
|
+
FuelUnits VARCHAR(255)
|
102
106
|
)"
|
103
107
|
|
104
108
|
values_arr = []
|
@@ -127,12 +131,14 @@ module URBANopt
|
|
127
131
|
feature_db = SQLite3::Database.open uo_output_sql_file
|
128
132
|
# Doing "db.results_as_hash = true" is prettier, but in this case significantly slower.
|
129
133
|
|
130
|
-
|
131
|
-
|
132
|
-
elec_query = feature_db.query "SELECT ReportData.TimeIndex, Time.Year, Time.Month, Time.Day, Time.Hour, Time.Minute, Time.Dst, ReportData.Value
|
134
|
+
elec_query = feature_db.query "SELECT ReportData.TimeIndex, Time.Year, Time.Month, Time.Day, Time.Hour,
|
135
|
+
Time.Minute, Time.Dst, ReportData.Value
|
133
136
|
FROM ReportData
|
134
137
|
INNER JOIN Time ON Time.TimeIndex=ReportData.TimeIndex
|
135
|
-
|
138
|
+
INNER JOIN ReportDataDictionary AS rddi ON rddi.ReportDataDictionaryIndex=ReportData.ReportDataDictionaryIndex
|
139
|
+
WHERE rddi.IndexGroup == 'Facility:Electricity'
|
140
|
+
AND rddi.ReportingFrequency == 'Zone Timestep'
|
141
|
+
AND Time.Year > 1900
|
136
142
|
ORDER BY ReportData.TimeIndex"
|
137
143
|
|
138
144
|
elec_query.each do |row| # Add up all the values for electricity usage across all Features at this timestep
|
@@ -149,12 +155,14 @@ module URBANopt
|
|
149
155
|
end # End elec_query
|
150
156
|
elec_query.close
|
151
157
|
|
152
|
-
|
153
|
-
|
154
|
-
gas_query = feature_db.query "SELECT ReportData.TimeIndex, Time.Year, Time.Month, Time.Day, Time.Hour, Time.Minute, Time.Dst, ReportData.Value
|
158
|
+
gas_query = feature_db.query "SELECT ReportData.TimeIndex, Time.Year, Time.Month, Time.Day, Time.Hour,
|
159
|
+
Time.Minute, Time.Dst, ReportData.Value
|
155
160
|
FROM ReportData
|
156
161
|
INNER JOIN Time ON Time.TimeIndex=ReportData.TimeIndex
|
157
|
-
|
162
|
+
INNER JOIN ReportDataDictionary AS rddi ON rddi.ReportDataDictionaryIndex=ReportData.ReportDataDictionaryIndex
|
163
|
+
WHERE rddi.IndexGroup == 'Facility:Gas'
|
164
|
+
AND rddi.ReportingFrequency == 'Zone Timestep'
|
165
|
+
AND Time.Year > 1900
|
158
166
|
ORDER BY ReportData.TimeIndex"
|
159
167
|
|
160
168
|
gas_query.each do |row|
|
@@ -175,8 +183,8 @@ module URBANopt
|
|
175
183
|
elec_sql = []
|
176
184
|
gas_sql = []
|
177
185
|
values_arr.each do |i|
|
178
|
-
elec_sql << "(#{i[:time_index]}, #{i[:year]}, #{i[:month]}, #{i[:day]}, #{i[:hour]}, #{i[:minute]}, #{i[:dst]},
|
179
|
-
gas_sql << "(#{i[:time_index]}, #{i[:year]}, #{i[:month]}, #{i[:day]}, #{i[:hour]}, #{i[:minute]}, #{i[:dst]},
|
186
|
+
elec_sql << "(#{i[:time_index]}, #{i[:year]}, #{i[:month]}, #{i[:day]}, #{i[:hour]}, #{i[:minute]}, #{i[:dst]}, 'Electricity', #{i[:elec_val]}, 'J')"
|
187
|
+
gas_sql << "(#{i[:time_index]}, #{i[:year]}, #{i[:month]}, #{i[:day]}, #{i[:hour]}, #{i[:minute]}, #{i[:dst]}, 'Gas', #{i[:gas_val]}, 'J')"
|
180
188
|
end
|
181
189
|
|
182
190
|
# Put summed Values into the database
|
@@ -189,7 +197,7 @@ module URBANopt
|
|
189
197
|
# Save scenario result
|
190
198
|
##
|
191
199
|
# [parameters:]
|
192
|
-
# +file_name+ - _String_ - Assign a name to the saved scenario results file
|
200
|
+
# * +file_name+ - _String_ - Assign a name to the saved scenario results file
|
193
201
|
def save(file_name = @default_save_name)
|
194
202
|
@scenario_result.save
|
195
203
|
|
@@ -43,8 +43,8 @@ module URBANopt
|
|
43
43
|
# OpenDSSPostProcessor post-processes OpenDSS results to selected OpenDSS results and integrate them in scenario and feature reports.
|
44
44
|
##
|
45
45
|
# [parameters:]
|
46
|
-
# +scenario_report+ - _ScenarioBase_ - An object of Scenario_report class.
|
47
|
-
# +opendss_results_dir_name+ - _directory name of opendss results
|
46
|
+
# * +scenario_report+ - _ScenarioBase_ - An object of Scenario_report class.
|
47
|
+
# * +opendss_results_dir_name+ - _directory name of opendss results
|
48
48
|
def initialize(scenario_report, opendss_results_dir_name = 'opendss')
|
49
49
|
if !scenario_report.nil?
|
50
50
|
@scenario_report = scenario_report
|
@@ -202,9 +202,9 @@ module URBANopt
|
|
202
202
|
# Save csv report method
|
203
203
|
##
|
204
204
|
# [parameters:]
|
205
|
-
# +feature_report+ - _feature report object_ - An onject of the feature report
|
206
|
-
# +updated_feature_report_csv+ - _CSV_ - An updated feature report csv
|
207
|
-
# +file_name+ - _String_ - Assigned name to save the file with no extension
|
205
|
+
# * +feature_report+ - _feature report object_ - An onject of the feature report
|
206
|
+
# * +updated_feature_report_csv+ - _CSV_ - An updated feature report csv
|
207
|
+
# * +file_name+ - _String_ - Assigned name to save the file with no extension
|
208
208
|
def save_csv(feature_report, updated_feature_report_csv, file_name = 'default_feature_report')
|
209
209
|
File.write(File.join(feature_report.directory_name, 'feature_reports', "#{file_name}.csv"), updated_feature_report_csv)
|
210
210
|
end
|
@@ -213,7 +213,7 @@ module URBANopt
|
|
213
213
|
# create opendss json report results
|
214
214
|
##
|
215
215
|
# [parameters:]
|
216
|
-
# +feature_report+ - _feature report object_ - An onject of the feature report
|
216
|
+
# * +feature_report+ - _feature report object_ - An onject of the feature report
|
217
217
|
def add_summary_results(feature_report)
|
218
218
|
under_voltage_hrs = 0
|
219
219
|
over_voltage_hrs = 0
|
@@ -258,7 +258,7 @@ module URBANopt
|
|
258
258
|
updated_feature_csv = merge_data(@feature_reports_data[id], @opendss_data[id])
|
259
259
|
|
260
260
|
# save fetaure reports
|
261
|
-
feature_report.
|
261
|
+
feature_report.save_json_report('default_feature_report_opendss')
|
262
262
|
|
263
263
|
# resave updated csv report
|
264
264
|
save_csv(feature_report, updated_feature_csv, 'default_feature_report_opendss')
|
@@ -40,8 +40,9 @@ module URBANopt
|
|
40
40
|
# Create all SimulationDirs for Scenario.
|
41
41
|
##
|
42
42
|
# [parameters:]
|
43
|
-
# +scenario+ - _ScenarioBase_ - Scenario to create simulation input files for scenario.
|
44
|
-
# +force_clear+ - _Bool_ - Clear Scenario before creating simulation input files
|
43
|
+
# * +scenario+ - _ScenarioBase_ - Scenario to create simulation input files for scenario.
|
44
|
+
# * +force_clear+ - _Bool_ - Clear Scenario before creating simulation input files
|
45
|
+
##
|
45
46
|
# [return:] _Array_ Returns an array of all SimulationDirs, even those created previously, for Scenario.
|
46
47
|
def create_simulation_files(scenario, force_clear = false)
|
47
48
|
raise 'create_input_files is not implemented for ScenarioRunnerBase, override in your class'
|
@@ -51,9 +52,9 @@ module URBANopt
|
|
51
52
|
# Create and run all SimulationFiles for Scenario.
|
52
53
|
##
|
53
54
|
# [parameters:]
|
54
|
-
# +scenario+ - _ScenarioBase_ - Scenario to create and run simulation input files for.
|
55
|
-
# +force_clear+ - _Bool_ - Clear Scenario before creating Simulation input files.
|
56
|
-
|
55
|
+
# * +scenario+ - _ScenarioBase_ - Scenario to create and run simulation input files for.
|
56
|
+
# * +force_clear+ - _Bool_ - Clear Scenario before creating Simulation input files.
|
57
|
+
##
|
57
58
|
# [return:] _Array_ Returns an array of all SimulationDirs, even those created previously, for Scenario.
|
58
59
|
def run(scenario, force_clear = false, options = {})
|
59
60
|
raise 'run is not implemented for ScenarioRunnerBase, override in your class'
|
@@ -46,8 +46,9 @@ module URBANopt
|
|
46
46
|
# Create all OSWs for Scenario.
|
47
47
|
##
|
48
48
|
# [parameters:]
|
49
|
-
# +scenario+ - _ScenarioBase_ - Scenario to create simulation input files for.
|
50
|
-
# +force_clear+ - _Bool_ - Clear Scenario before creating simulation input files.
|
49
|
+
# * +scenario+ - _ScenarioBase_ - Scenario to create simulation input files for.
|
50
|
+
# * +force_clear+ - _Bool_ - Clear Scenario before creating simulation input files.
|
51
|
+
##
|
51
52
|
# [return:] _Array_ Returns array of all SimulationDirs, even those created previously, for Scenario.
|
52
53
|
def create_simulation_files(scenario, force_clear = false)
|
53
54
|
if force_clear
|
@@ -79,8 +80,9 @@ module URBANopt
|
|
79
80
|
# - Run osw file groups in order and store simulation failure in a array.
|
80
81
|
##
|
81
82
|
# [parameters:]
|
82
|
-
# +scenario+ - _ScenarioBase_ - Scenario to create and run SimulationFiles for.
|
83
|
-
# +force_clear+ - _Bool_ - Clear Scenario before creating SimulationFiles.
|
83
|
+
# * +scenario+ - _ScenarioBase_ - Scenario to create and run SimulationFiles for.
|
84
|
+
# * +force_clear+ - _Bool_ - Clear Scenario before creating SimulationFiles.
|
85
|
+
##
|
84
86
|
# [return:] _Array_ Returns array of all SimulationFiles, even those created previously, for Scenario.
|
85
87
|
def run(scenario, force_clear = false, options = {})
|
86
88
|
# instantiate openstudio runner - use the defaults for now. If need to change then create
|
@@ -181,14 +181,13 @@ module URBANopt
|
|
181
181
|
monthly_sum_dec += v.to_f
|
182
182
|
i += 1
|
183
183
|
end
|
184
|
-
|
185
|
-
if k <= size
|
186
|
-
annual_sum += v.to_f
|
187
|
-
k += 1
|
188
|
-
end
|
184
|
+
|
189
185
|
end
|
190
186
|
end
|
191
187
|
|
188
|
+
# sum up monthly values for annual aggregate
|
189
|
+
annual_sum = monthly_sum_jan + monthly_sum_feb + monthly_sum_mar + monthly_sum_apr + monthly_sum_may + monthly_sum_jun + monthly_sum_jul + monthly_sum_aug + monthly_sum_sep + monthly_sum_oct + monthly_sum_nov + monthly_sum_dec
|
190
|
+
|
192
191
|
# store headers as key and monthly sums as values for each header
|
193
192
|
monthly_totals[headers_unitless[j]] = [monthly_sum_jan, monthly_sum_feb, monthly_sum_mar, monthly_sum_apr, monthly_sum_may, monthly_sum_jun, monthly_sum_jul, monthly_sum_aug, monthly_sum_sep, monthly_sum_oct, monthly_sum_nov, monthly_sum_dec]
|
194
193
|
|
@@ -35,9 +35,9 @@ module URBANopt
|
|
35
35
|
# SimulationDirBase is the agnostic representation of a directory of simulation input files.
|
36
36
|
##
|
37
37
|
# [parameters:]
|
38
|
-
# +scenario+ - _ScenarioBase_ - Scenario containing this SimulationDirBase.
|
39
|
-
# +features+ - _Array_ - Array of Features that this SimulationDirBase represents.
|
40
|
-
# +feature_names+ - _Array_ - Array of scenario specific names for these Features.
|
38
|
+
# * +scenario+ - _ScenarioBase_ - Scenario containing this SimulationDirBase.
|
39
|
+
# * +features+ - _Array_ - Array of Features that this SimulationDirBase represents.
|
40
|
+
# * +feature_names+ - _Array_ - Array of scenario specific names for these Features.
|
41
41
|
def initialize(scenario, features, feature_names)
|
42
42
|
@scenario = scenario
|
43
43
|
@features = features
|
@@ -37,10 +37,10 @@ module URBANopt
|
|
37
37
|
# SimulationDirOSW creates a OSW file to simulate features, a SimulationMapperBase is invoked to translate features to OSW.
|
38
38
|
##
|
39
39
|
# [parameters:]
|
40
|
-
# +scenario+ - _ScenarioBase_ - Scenario containing this SimulationFileBase.
|
41
|
-
# +features+ - _Array_ - Array of Features this SimulationFile represents.
|
42
|
-
# +feature_names+ - _Array_ - Array of scenario specific names for these Features.
|
43
|
-
# +mapper_class+ - _String_ - Name of class derived frmo SimulationMapperBase used to translate feature to simulation OSW.
|
40
|
+
# * +scenario+ - _ScenarioBase_ - Scenario containing this SimulationFileBase.
|
41
|
+
# * +features+ - _Array_ - Array of Features this SimulationFile represents.
|
42
|
+
# * +feature_names+ - _Array_ - Array of scenario specific names for these Features.
|
43
|
+
# * +mapper_class+ - _String_ - Name of class derived frmo SimulationMapperBase used to translate feature to simulation OSW.
|
44
44
|
def initialize(scenario, features, feature_names, mapper_class)
|
45
45
|
super(scenario, features, feature_names)
|
46
46
|
|
@@ -36,9 +36,9 @@ module URBANopt
|
|
36
36
|
|
37
37
|
# create osw file given a ScenarioBase object, features, and feature_names
|
38
38
|
# [parameters:]
|
39
|
-
# +scenario+ - _ScenarioBase_ - An object of ScenarioBase class.
|
40
|
-
# +features+ - _Array_ - Array of Features.
|
41
|
-
# +feature_names+ - _Array_ - Array of scenario specific names for these Features.
|
39
|
+
# * +scenario+ - _ScenarioBase_ - An object of ScenarioBase class.
|
40
|
+
# * +features+ - _Array_ - Array of Features.
|
41
|
+
# * +feature_names+ - _Array_ - Array of scenario specific names for these Features.
|
42
42
|
def create_osw(scenario, features, feature_names)
|
43
43
|
raise 'create_osw not implemented for SimulationMapperBase, override in your class'
|
44
44
|
end
|
@@ -30,11 +30,11 @@ Gem::Specification.new do |spec|
|
|
30
30
|
|
31
31
|
spec.add_runtime_dependency 'json-schema', '~> 2.8'
|
32
32
|
spec.add_runtime_dependency 'json_pure', '~> 2.3'
|
33
|
-
spec.add_runtime_dependency 'openstudio-common-measures', '
|
33
|
+
spec.add_runtime_dependency 'openstudio-common-measures', '0.2.0'
|
34
34
|
spec.add_runtime_dependency 'openstudio-extension', '~> 0.2.5'
|
35
35
|
spec.add_runtime_dependency 'openstudio-load-flexibility-measures', '~> 0.1.3'
|
36
|
-
spec.add_runtime_dependency 'openstudio-model-articulation', '
|
36
|
+
spec.add_runtime_dependency 'openstudio-model-articulation', '0.2.0'
|
37
37
|
spec.add_runtime_dependency 'sqlite3', '1.4.2'
|
38
38
|
spec.add_runtime_dependency 'urbanopt-core', '~> 0.4.0'
|
39
|
-
spec.add_runtime_dependency 'urbanopt-reporting', '~> 0.2.
|
39
|
+
spec.add_runtime_dependency 'urbanopt-reporting', '~> 0.2.1'
|
40
40
|
end
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: urbanopt-scenario
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.4.
|
4
|
+
version: 0.4.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Rawad El Kontar
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: exe
|
11
11
|
cert_chain: []
|
12
|
-
date: 2020-
|
12
|
+
date: 2020-11-12 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: bundler
|
@@ -85,14 +85,14 @@ dependencies:
|
|
85
85
|
name: openstudio-common-measures
|
86
86
|
requirement: !ruby/object:Gem::Requirement
|
87
87
|
requirements:
|
88
|
-
- -
|
88
|
+
- - '='
|
89
89
|
- !ruby/object:Gem::Version
|
90
90
|
version: 0.2.0
|
91
91
|
type: :runtime
|
92
92
|
prerelease: false
|
93
93
|
version_requirements: !ruby/object:Gem::Requirement
|
94
94
|
requirements:
|
95
|
-
- -
|
95
|
+
- - '='
|
96
96
|
- !ruby/object:Gem::Version
|
97
97
|
version: 0.2.0
|
98
98
|
- !ruby/object:Gem::Dependency
|
@@ -127,14 +127,14 @@ dependencies:
|
|
127
127
|
name: openstudio-model-articulation
|
128
128
|
requirement: !ruby/object:Gem::Requirement
|
129
129
|
requirements:
|
130
|
-
- -
|
130
|
+
- - '='
|
131
131
|
- !ruby/object:Gem::Version
|
132
132
|
version: 0.2.0
|
133
133
|
type: :runtime
|
134
134
|
prerelease: false
|
135
135
|
version_requirements: !ruby/object:Gem::Requirement
|
136
136
|
requirements:
|
137
|
-
- -
|
137
|
+
- - '='
|
138
138
|
- !ruby/object:Gem::Version
|
139
139
|
version: 0.2.0
|
140
140
|
- !ruby/object:Gem::Dependency
|
@@ -171,14 +171,14 @@ dependencies:
|
|
171
171
|
requirements:
|
172
172
|
- - "~>"
|
173
173
|
- !ruby/object:Gem::Version
|
174
|
-
version: 0.2.
|
174
|
+
version: 0.2.1
|
175
175
|
type: :runtime
|
176
176
|
prerelease: false
|
177
177
|
version_requirements: !ruby/object:Gem::Requirement
|
178
178
|
requirements:
|
179
179
|
- - "~>"
|
180
180
|
- !ruby/object:Gem::Version
|
181
|
-
version: 0.2.
|
181
|
+
version: 0.2.1
|
182
182
|
description: Library to export data point OSW files from URBANopt Scenario CSV
|
183
183
|
email:
|
184
184
|
- rawad.elkontar@nrel.gov
|
@@ -205,16 +205,15 @@ files:
|
|
205
205
|
- docs/.gitignore
|
206
206
|
- docs/.vuepress/components/InnerJsonSchema.vue
|
207
207
|
- docs/.vuepress/components/JsonSchema.vue
|
208
|
-
- docs/.vuepress/components/ScenarioSchema.vue
|
209
208
|
- docs/.vuepress/components/StaticLink.vue
|
210
209
|
- docs/.vuepress/config.js
|
211
210
|
- docs/.vuepress/highlight.js
|
211
|
+
- docs/.vuepress/json-schema-deref-loader.js
|
212
212
|
- docs/.vuepress/public/custom_rdoc_styles.css
|
213
213
|
- docs/.vuepress/utils.js
|
214
214
|
- docs/README.md
|
215
215
|
- docs/package-lock.json
|
216
216
|
- docs/package.json
|
217
|
-
- docs/schemas/scenario-schema.md
|
218
217
|
- lib/urbanopt-scenario.rb
|
219
218
|
- lib/urbanopt/scenario.rb
|
220
219
|
- lib/urbanopt/scenario/default_reports.rb
|