openstudio-geb 0.2.1 → 0.3.1r
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +3 -2
- data/CHANGELOG.md +3 -0
- data/Gemfile +6 -1
- data/doc_templates/LICENSE.md +7 -21
- data/doc_templates/copyright_erb.txt +2 -32
- data/doc_templates/copyright_js.txt +2 -2
- data/doc_templates/copyright_ruby.txt +3 -33
- data/lib/measures/Add Output Variable/LICENSE.md +7 -21
- data/lib/measures/Add Output Variable/measure.rb +3 -33
- data/lib/measures/Add Output Variable/measure.xml +128 -125
- data/lib/measures/Add Output Variable/tests/AddOutputVariable_Test.rb +2 -32
- data/lib/measures/AddElectricVehicleChargingLoad/LICENSE.md +13 -1
- data/lib/measures/AddElectricVehicleChargingLoad/measure.rb +16 -52
- data/lib/measures/AddElectricVehicleChargingLoad/measure.xml +24 -23
- data/lib/measures/AddElectricVehicleChargingLoad/tests/add_electric_vehicle_charging_load_test.rb +2 -32
- data/lib/measures/AdjustThermostatSetpointsByDegreesForPeakHours/LICENSE.md +7 -21
- data/lib/measures/AdjustThermostatSetpointsByDegreesForPeakHours/README.md +22 -16
- data/lib/measures/AdjustThermostatSetpointsByDegreesForPeakHours/measure.rb +14 -35
- data/lib/measures/AdjustThermostatSetpointsByDegreesForPeakHours/measure.xml +41 -30
- data/lib/measures/AdjustThermostatSetpointsByDegreesForPeakHours/tests/AdjustThermostatSetpointsByDegreesForPeakHours_Test.rb +2 -32
- data/lib/measures/Enable Demand Controlled Ventilation/LICENSE.md +7 -21
- data/lib/measures/Enable Demand Controlled Ventilation/measure.rb +2 -32
- data/lib/measures/Enable Demand Controlled Ventilation/measure.xml +14 -13
- data/lib/measures/Enable Demand Controlled Ventilation/tests/EnableDemandControlledVentilation_Test.rb +2 -32
- data/lib/measures/GEB Metrics Report/LICENSE.md +13 -1
- data/lib/measures/GEB Metrics Report/measure.rb +2 -37
- data/lib/measures/GEB Metrics Report/measure.xml +238 -23
- data/lib/measures/GEB Metrics Report/resources/os_lib_helper_methods.rb +2 -32
- data/lib/measures/GEB Metrics Report/resources/os_lib_reporting.rb +2 -32
- data/lib/measures/GEB Metrics Report/tests/geb_metrics_report_test.rb +2 -32
- data/lib/measures/add_ceiling_fan/LICENSE.md +13 -0
- data/lib/measures/add_ceiling_fan/README.md +119 -0
- data/lib/measures/add_ceiling_fan/README.md.erb +45 -0
- data/lib/measures/add_ceiling_fan/docs/.gitkeep +0 -0
- data/lib/measures/add_ceiling_fan/measure.rb +565 -0
- data/lib/measures/add_ceiling_fan/measure.xml +226 -0
- data/lib/measures/add_ceiling_fan/tests/CZ06RV2.epw +8768 -0
- data/lib/measures/add_ceiling_fan/tests/MediumOffice-90.1-2010-ASHRAE 169-2013-5A.osm +13669 -0
- data/lib/measures/add_ceiling_fan/tests/SFD_1story_UB_UA_ASHP2_HPWH.osm +13110 -0
- data/lib/measures/add_ceiling_fan/tests/add_ceiling_fan_test.rb +82 -0
- data/lib/measures/add_chilled_water_storage_tank/LICENSE.md +13 -1
- data/lib/measures/add_chilled_water_storage_tank/measure.rb +56 -56
- data/lib/measures/add_chilled_water_storage_tank/measure.xml +201 -28
- data/lib/measures/add_chilled_water_storage_tank/tests/add_chilled_water_storage_tank_test.rb +4 -34
- data/lib/measures/add_chilled_water_storage_tank/tests/example_model.osm +8077 -21624
- data/lib/measures/add_electrochromic_window/LICENSE.md +13 -1
- data/lib/measures/add_electrochromic_window/measure.rb +2 -32
- data/lib/measures/add_electrochromic_window/measure.xml +28 -27
- data/lib/measures/add_electrochromic_window/tests/add_electrochromic_window_test.rb +2 -32
- data/lib/measures/add_exterior_blinds_and_control/LICENSE.md +13 -1
- data/lib/measures/add_exterior_blinds_and_control/measure.rb +2 -34
- data/lib/measures/add_exterior_blinds_and_control/measure.xml +15 -26
- data/lib/measures/add_exterior_blinds_and_control/tests/add_exterior_blinds_and_control_test.rb +2 -34
- data/lib/measures/add_heat_pump_water_heater/LICENSE.md +7 -21
- data/lib/measures/add_heat_pump_water_heater/measure.rb +2 -32
- data/lib/measures/add_heat_pump_water_heater/measure.xml +89 -17
- data/lib/measures/add_heat_pump_water_heater/tests/add_hpwh_test.rb +2 -32
- data/lib/measures/add_interior_blinds_and_control/LICENSE.md +13 -1
- data/lib/measures/add_interior_blinds_and_control/measure.rb +2 -32
- data/lib/measures/add_interior_blinds_and_control/measure.xml +21 -33
- data/lib/measures/add_interior_blinds_and_control/tests/add_exterior_blinds_and_control_test.rb +2 -32
- data/lib/measures/add_natural_ventilation_with_hybrid_control/LICENSE.md +13 -0
- data/lib/measures/add_natural_ventilation_with_hybrid_control/README.md +133 -0
- data/lib/measures/add_natural_ventilation_with_hybrid_control/README.md.erb +45 -0
- data/lib/measures/add_natural_ventilation_with_hybrid_control/docs/.gitkeep +0 -0
- data/lib/measures/add_natural_ventilation_with_hybrid_control/measure.rb +453 -0
- data/lib/measures/add_natural_ventilation_with_hybrid_control/measure.xml +247 -0
- data/lib/measures/add_natural_ventilation_with_hybrid_control/tests/CZ06RV2.epw +8768 -0
- data/lib/measures/add_natural_ventilation_with_hybrid_control/tests/MediumOffice-90.1-2010-ASHRAE 169-2013-5A.osm +13669 -0
- data/lib/measures/add_natural_ventilation_with_hybrid_control/tests/SmallHotel-2A.osm +42899 -0
- data/lib/measures/add_natural_ventilation_with_hybrid_control/tests/USA_NY_Buffalo.Niagara.Intl.AP.725280_TMY3.epw +8768 -0
- data/lib/measures/add_natural_ventilation_with_hybrid_control/tests/USA_TX_Houston-Bush.Intercontinental.AP.722430_TMY3.epw +8768 -0
- data/lib/measures/add_natural_ventilation_with_hybrid_control/tests/add_natural_ventilation_with_hybrid_control_test.rb +95 -0
- data/lib/measures/add_rooftop_pv_simple/LICENSE.md +7 -21
- data/lib/measures/add_rooftop_pv_simple/measure.rb +2 -32
- data/lib/measures/add_rooftop_pv_simple/measure.xml +11 -5
- data/lib/measures/add_rooftop_pv_simple/tests/add_rooftop_pv_test.rb +2 -32
- data/lib/measures/adjust_dhw_setpoint/LICENSE.md +13 -1
- data/lib/measures/adjust_dhw_setpoint/measure.rb +2 -32
- data/lib/measures/adjust_dhw_setpoint/measure.xml +34 -21
- data/lib/measures/adjust_dhw_setpoint/tests/adjust_dhw_setpoint_test.rb +2 -32
- data/lib/measures/average_ventilation_for_peak_hours/LICENSE.md +13 -1
- data/lib/measures/average_ventilation_for_peak_hours/README.md +5 -45
- data/lib/measures/average_ventilation_for_peak_hours/measure.rb +2 -32
- data/lib/measures/average_ventilation_for_peak_hours/measure.xml +24 -79
- data/lib/measures/average_ventilation_for_peak_hours/tests/average_ventilation_for_peak_hours_test.rb +2 -32
- data/lib/measures/enable_occupancy_driven_lighting/LICENSE.md +13 -1
- data/lib/measures/enable_occupancy_driven_lighting/measure.rb +2 -32
- data/lib/measures/enable_occupancy_driven_lighting/measure.xml +28 -27
- data/lib/measures/enable_occupancy_driven_lighting/tests/enable_occupancy_driven_lighting_test.rb +2 -32
- data/lib/measures/precooling/LICENSE.md +7 -21
- data/lib/measures/precooling/measure.rb +2 -33
- data/lib/measures/precooling/measure.xml +12 -11
- data/lib/measures/preheating/LICENSE.md +7 -21
- data/lib/measures/preheating/measure.rb +2 -33
- data/lib/measures/preheating/measure.xml +18 -17
- data/lib/measures/reduce_domestic_hot_water_use_for_peak_hours/LICENSE.md +13 -1
- data/lib/measures/reduce_domestic_hot_water_use_for_peak_hours/measure.rb +2 -32
- data/lib/measures/reduce_domestic_hot_water_use_for_peak_hours/measure.xml +34 -27
- data/lib/measures/reduce_domestic_hot_water_use_for_peak_hours/tests/reduce_domestic_hot_water_use_for_peak_hours_test.rb +2 -32
- data/lib/measures/reduce_epd_by_percentage_for_peak_hours/LICENSE.md +13 -1
- data/lib/measures/reduce_epd_by_percentage_for_peak_hours/README.md +3 -3
- data/lib/measures/reduce_epd_by_percentage_for_peak_hours/measure.rb +2 -32
- data/lib/measures/reduce_epd_by_percentage_for_peak_hours/measure.xml +25 -18
- data/lib/measures/reduce_epd_by_percentage_for_peak_hours/tests/reduce_epd_by_percentage_for_peak_hours_copy_test.rb +2 -32
- data/lib/measures/reduce_exterior_lighting_loads/LICENSE.md +13 -0
- data/lib/measures/reduce_exterior_lighting_loads/README.md +79 -0
- data/lib/measures/reduce_exterior_lighting_loads/README.md.erb +45 -0
- data/lib/measures/reduce_exterior_lighting_loads/docs/.gitkeep +0 -0
- data/lib/measures/reduce_exterior_lighting_loads/measure.rb +385 -0
- data/lib/measures/reduce_exterior_lighting_loads/measure.xml +195 -0
- data/lib/measures/reduce_exterior_lighting_loads/tests/CZ06RV2.epw +8768 -0
- data/lib/measures/reduce_exterior_lighting_loads/tests/SFD_1story_UB_UA_ASHP2_HPWH.osm +13110 -0
- data/lib/measures/reduce_exterior_lighting_loads/tests/example_model.osm +8077 -0
- data/lib/measures/reduce_exterior_lighting_loads/tests/reduce_exterior_lighting_loads_test.rb +81 -0
- data/lib/measures/reduce_lpd_by_percentage_for_peak_hours/LICENSE.md +13 -1
- data/lib/measures/reduce_lpd_by_percentage_for_peak_hours/measure.rb +2 -32
- data/lib/measures/reduce_lpd_by_percentage_for_peak_hours/measure.xml +30 -23
- data/lib/measures/reduce_lpd_by_percentage_for_peak_hours/tests/reduce_lpd_by_percentage_for_peak_hours_test.rb +2 -32
- data/lib/openstudio/geb/extension.rb +2 -32
- data/lib/openstudio/geb/logging.rb +2 -32
- data/lib/openstudio/geb/run.rb +2 -32
- data/lib/openstudio/geb/utilities.rb +2 -32
- data/lib/openstudio/geb/version.rb +3 -33
- data/lib/openstudio/geb.rb +2 -32
- data/lib/openstudio-geb.rb +5 -0
- data/openstudio-geb.gemspec +2 -3
- metadata +41 -8
@@ -1,36 +1,6 @@
|
|
1
1
|
# *******************************************************************************
|
2
|
-
# OpenStudio(R), Copyright (c)
|
3
|
-
#
|
4
|
-
# Redistribution and use in source and binary forms, with or without
|
5
|
-
# modification, are permitted provided that the following conditions are met:
|
6
|
-
#
|
7
|
-
# (1) Redistributions of source code must retain the above copyright notice,
|
8
|
-
# this list of conditions and the following disclaimer.
|
9
|
-
#
|
10
|
-
# (2) Redistributions in binary form must reproduce the above copyright notice,
|
11
|
-
# this list of conditions and the following disclaimer in the documentation
|
12
|
-
# and/or other materials provided with the distribution.
|
13
|
-
#
|
14
|
-
# (3) Neither the name of the copyright holder nor the names of any contributors
|
15
|
-
# may be used to endorse or promote products derived from this software without
|
16
|
-
# specific prior written permission from the respective party.
|
17
|
-
#
|
18
|
-
# (4) Other than as required in clauses (1) and (2), distributions in any form
|
19
|
-
# of modifications or other derivative works may not use the "OpenStudio"
|
20
|
-
# trademark, "OS", "os", or any other confusingly similar designation without
|
21
|
-
# specific prior written permission from Alliance for Sustainable Energy, LLC.
|
22
|
-
#
|
23
|
-
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
|
24
|
-
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
25
|
-
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
26
|
-
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
|
27
|
-
# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
|
28
|
-
# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
29
|
-
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
|
30
|
-
# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
31
|
-
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
32
|
-
# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
33
|
-
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
2
|
+
# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
|
3
|
+
# See also https://openstudio.net/license
|
34
4
|
# *******************************************************************************
|
35
5
|
|
36
6
|
require 'json'
|
@@ -1,36 +1,6 @@
|
|
1
1
|
# *******************************************************************************
|
2
|
-
# OpenStudio(R), Copyright (c)
|
3
|
-
#
|
4
|
-
# Redistribution and use in source and binary forms, with or without
|
5
|
-
# modification, are permitted provided that the following conditions are met:
|
6
|
-
#
|
7
|
-
# (1) Redistributions of source code must retain the above copyright notice,
|
8
|
-
# this list of conditions and the following disclaimer.
|
9
|
-
#
|
10
|
-
# (2) Redistributions in binary form must reproduce the above copyright notice,
|
11
|
-
# this list of conditions and the following disclaimer in the documentation
|
12
|
-
# and/or other materials provided with the distribution.
|
13
|
-
#
|
14
|
-
# (3) Neither the name of the copyright holder nor the names of any contributors
|
15
|
-
# may be used to endorse or promote products derived from this software without
|
16
|
-
# specific prior written permission from the respective party.
|
17
|
-
#
|
18
|
-
# (4) Other than as required in clauses (1) and (2), distributions in any form
|
19
|
-
# of modifications or other derivative works may not use the "OpenStudio"
|
20
|
-
# trademark, "OS", "os", or any other confusingly similar designation without
|
21
|
-
# specific prior written permission from Alliance for Sustainable Energy, LLC.
|
22
|
-
#
|
23
|
-
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
|
24
|
-
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
25
|
-
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
26
|
-
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
|
27
|
-
# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
|
28
|
-
# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
29
|
-
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
|
30
|
-
# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
31
|
-
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
32
|
-
# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
33
|
-
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
2
|
+
# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
|
3
|
+
# See also https://openstudio.net/license
|
34
4
|
# *******************************************************************************
|
35
5
|
|
36
6
|
# insert your copyright here
|
@@ -0,0 +1,13 @@
|
|
1
|
+
OpenStudio(R), Copyright (c) 2008, 2023 Alliance for Sustainable Energy, LLC.
|
2
|
+
|
3
|
+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
4
|
+
|
5
|
+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
6
|
+
|
7
|
+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
8
|
+
|
9
|
+
3. Redistribution of this software, without modification, must refer to the software by the same designation. Redistribution of a modified version of this software (i) may not refer to the modified version by the same designation, or by any confusingly similar designation, and (ii) must refer to the underlying software originally provided by Alliance as “OpenStudio®”. Except to comply with the foregoing, the term “OpenStudio®”, or any confusingly similar designation may not be used to refer to any modified version of this software or any modified version of the underlying software originally provided by Alliance without the prior written consent of Alliance.
|
10
|
+
|
11
|
+
4. The name of the copyright holder(s), any contributors, the United States Government, the United States Department of Energy, or any of their employees may not be used to endorse or promote products derived from this software without specific prior written permission from the respective party.
|
12
|
+
|
13
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
@@ -0,0 +1,119 @@
|
|
1
|
+
|
2
|
+
|
3
|
+
###### (Automatically generated documentation)
|
4
|
+
|
5
|
+
# Add Ceiling Fan
|
6
|
+
|
7
|
+
## Description
|
8
|
+
Install ceiling fans in buildings to increase air circulation. Ceiling fans effectively cool by introducing slow movement to induce evaporative cooling, rather than directly conditioning the air. A diversity factor is added to consider the simultaneous usage among the household.
|
9
|
+
|
10
|
+
## Modeler Description
|
11
|
+
Ceiling fan is modeled by increasing air velocity in the People objects and adding electric equipment to consider extra fan energy use. Cooling setpoint is increased by certain degrees in the presence of ceiling fans. A schedule is also introduced to simulate ceiling fan operation. A diversity factor (different in commercial and residential buildings) is added to consider the simultaneous usage among the building/household.
|
12
|
+
|
13
|
+
## Measure Type
|
14
|
+
ModelMeasure
|
15
|
+
|
16
|
+
## Taxonomy
|
17
|
+
|
18
|
+
|
19
|
+
## Arguments
|
20
|
+
|
21
|
+
|
22
|
+
### Select building type:
|
23
|
+
Building type (residential or commercial)
|
24
|
+
**Name:** bldg_type,
|
25
|
+
**Type:** Choice,
|
26
|
+
**Units:** ,
|
27
|
+
**Required:** true,
|
28
|
+
**Model Dependent:** false
|
29
|
+
|
30
|
+
**Choice Display Names** ["residential", "commercial"]
|
31
|
+
|
32
|
+
|
33
|
+
### Cooling setpoint increase - C
|
34
|
+
Cooling setpoint increase in degree C
|
35
|
+
**Name:** cool_stp_increase_C,
|
36
|
+
**Type:** Double,
|
37
|
+
**Units:** ,
|
38
|
+
**Required:** true,
|
39
|
+
**Model Dependent:** false
|
40
|
+
|
41
|
+
|
42
|
+
### Select ceiling fan motor type:
|
43
|
+
Ceiling fan motor type
|
44
|
+
**Name:** motor_type,
|
45
|
+
**Type:** Choice,
|
46
|
+
**Units:** ,
|
47
|
+
**Required:** true,
|
48
|
+
**Model Dependent:** false
|
49
|
+
|
50
|
+
**Choice Display Names** ["DC", "AC"]
|
51
|
+
|
52
|
+
|
53
|
+
### Ceiling fan EUI in watts per floor area
|
54
|
+
Ceiling fan watts per m2
|
55
|
+
**Name:** watts_per_m2,
|
56
|
+
**Type:** Double,
|
57
|
+
**Units:** ,
|
58
|
+
**Required:** false,
|
59
|
+
**Model Dependent:** false
|
60
|
+
|
61
|
+
|
62
|
+
### First start date for the Reduction
|
63
|
+
In MM-DD format
|
64
|
+
**Name:** start_date,
|
65
|
+
**Type:** String,
|
66
|
+
**Units:** ,
|
67
|
+
**Required:** false,
|
68
|
+
**Model Dependent:** false
|
69
|
+
|
70
|
+
|
71
|
+
### First end date for the Reduction
|
72
|
+
In MM-DD format
|
73
|
+
**Name:** end_date,
|
74
|
+
**Type:** String,
|
75
|
+
**Units:** ,
|
76
|
+
**Required:** false,
|
77
|
+
**Model Dependent:** false
|
78
|
+
|
79
|
+
|
80
|
+
### Start Time for the Reduction
|
81
|
+
In HH:MM:SS format
|
82
|
+
**Name:** start_time,
|
83
|
+
**Type:** String,
|
84
|
+
**Units:** ,
|
85
|
+
**Required:** false,
|
86
|
+
**Model Dependent:** false
|
87
|
+
|
88
|
+
|
89
|
+
### End Time for the Reduction
|
90
|
+
In HH:MM:SS format
|
91
|
+
**Name:** end_time,
|
92
|
+
**Type:** String,
|
93
|
+
**Units:** ,
|
94
|
+
**Required:** false,
|
95
|
+
**Model Dependent:** false
|
96
|
+
|
97
|
+
|
98
|
+
### Diversity factor
|
99
|
+
Diversity factor
|
100
|
+
**Name:** diversity_factor,
|
101
|
+
**Type:** Double,
|
102
|
+
**Units:** ,
|
103
|
+
**Required:** false,
|
104
|
+
**Model Dependent:** false
|
105
|
+
|
106
|
+
|
107
|
+
### People air velocity
|
108
|
+
Air velocity surrounding people (m/s)
|
109
|
+
**Name:** people_air_velocity,
|
110
|
+
**Type:** Double,
|
111
|
+
**Units:** ,
|
112
|
+
**Required:** false,
|
113
|
+
**Model Dependent:** false
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
@@ -0,0 +1,45 @@
|
|
1
|
+
<%#= README.md.erb is used to auto-generate README.md. %>
|
2
|
+
<%#= To manually maintain README.md throw away README.md.erb and manually edit README.md %>
|
3
|
+
###### (Automatically generated documentation)
|
4
|
+
|
5
|
+
# <%= name %>
|
6
|
+
|
7
|
+
## Description
|
8
|
+
<%= description %>
|
9
|
+
|
10
|
+
## Modeler Description
|
11
|
+
<%= modelerDescription %>
|
12
|
+
|
13
|
+
## Measure Type
|
14
|
+
<%= measureType %>
|
15
|
+
|
16
|
+
## Taxonomy
|
17
|
+
<%= taxonomy %>
|
18
|
+
|
19
|
+
## Arguments
|
20
|
+
|
21
|
+
<% arguments.each do |argument| %>
|
22
|
+
### <%= argument[:display_name] %>
|
23
|
+
<%= argument[:description] %>
|
24
|
+
**Name:** <%= argument[:name] %>,
|
25
|
+
**Type:** <%= argument[:type] %>,
|
26
|
+
**Units:** <%= argument[:units] %>,
|
27
|
+
**Required:** <%= argument[:required] %>,
|
28
|
+
**Model Dependent:** <%= argument[:model_dependent] %>
|
29
|
+
<% if argument[:type] == "Choice" && !argument[:model_dependent]%>
|
30
|
+
**Choice Display Names** <%= argument[:choice_display_names] %>
|
31
|
+
<% end %>
|
32
|
+
<% end %>
|
33
|
+
|
34
|
+
<% if arguments.size == 0 %>
|
35
|
+
<%= "This measure does not have any user arguments" %>
|
36
|
+
<% end %>
|
37
|
+
|
38
|
+
<% if outputs.size > 0 %>
|
39
|
+
## Outputs
|
40
|
+
<% output_names = [] %>
|
41
|
+
<% outputs.each do |output| %>
|
42
|
+
<% output_names << output[:display_name] %>
|
43
|
+
<% end %>
|
44
|
+
<%= output_names.join(", ") %>
|
45
|
+
<% end %>
|
File without changes
|