Skip to content

Commit 9dfdf34

Browse files
authored
Merge pull request #30 from BuildingPerformanceSimulation/detailed_hvac_viewer
initial commit of detailed_hvac_viewer
2 parents 38da5fd + 4e786ea commit 9dfdf34

File tree

177 files changed

+24758
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

177 files changed

+24758
-0
lines changed
Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
2+
3+
###### (Automatically generated documentation)
4+
5+
# Detailed HVAC Viewer
6+
7+
## Description
8+
This measure creates a facsimile of the HVAC grid layout in the OpenStudio Application in an interactive html report. The user can optionally select loops to add Output:Variable to view node timeseries output data.
9+
10+
## Modeler Description
11+
The user is asked to provided the following parameters:
12+
- A plantLoop or airLoop from the model (dropdown)
13+
- A boolean to include or exclude demand nodes
14+
- Which variable they want to output for each node:
15+
* System Node Temperature
16+
* System Node Setpoint Temperature
17+
* System Node Mass Flow Rate
18+
* etc.
19+
20+
Developed as part of HackSimBuild 2024 by Matthew Dahlhausen and Ken Takahashi
21+
22+
## Measure Type
23+
ReportingMeasure
24+
25+
## Taxonomy
26+
27+
28+
## Arguments
29+
30+
31+
### Include Demand Side nodes in the timeseries output?
32+
33+
**Name:** include_demand_nodes,
34+
**Type:** Boolean,
35+
**Units:** ,
36+
**Required:** true,
37+
**Model Dependent:** false
38+
39+
### <h3>Select a Reporting Frequency?</h3>
40+
41+
**Name:** reporting_frequency,
42+
**Type:** Choice,
43+
**Units:** ,
44+
**Required:** true,
45+
**Model Dependent:** false
46+
47+
### System Node Temperature
48+
49+
**Name:** System Node Temperature,
50+
**Type:** Boolean,
51+
**Units:** ,
52+
**Required:** true,
53+
**Model Dependent:** false
54+
55+
### System Node Setpoint Temperature
56+
57+
**Name:** System Node Setpoint Temperature,
58+
**Type:** Boolean,
59+
**Units:** ,
60+
**Required:** true,
61+
**Model Dependent:** false
62+
63+
### System Node Mass Flow Rate
64+
65+
**Name:** System Node Mass Flow Rate,
66+
**Type:** Boolean,
67+
**Units:** ,
68+
**Required:** true,
69+
**Model Dependent:** false
70+
71+
### System Node Humidity Ratio
72+
73+
**Name:** System Node Humidity Ratio,
74+
**Type:** Boolean,
75+
**Units:** ,
76+
**Required:** true,
77+
**Model Dependent:** false
78+
79+
### System Node Setpoint High Temperature
80+
81+
**Name:** System Node Setpoint High Temperature,
82+
**Type:** Boolean,
83+
**Units:** ,
84+
**Required:** true,
85+
**Model Dependent:** false
86+
87+
### System Node Setpoint Low Temperature
88+
89+
**Name:** System Node Setpoint Low Temperature,
90+
**Type:** Boolean,
91+
**Units:** ,
92+
**Required:** true,
93+
**Model Dependent:** false
94+
95+
### System Node Setpoint Humidity Ratio
96+
97+
**Name:** System Node Setpoint Humidity Ratio,
98+
**Type:** Boolean,
99+
**Units:** ,
100+
**Required:** true,
101+
**Model Dependent:** false
102+
103+
### System Node Setpoint Minimum Humidity Ratio
104+
105+
**Name:** System Node Setpoint Minimum Humidity Ratio,
106+
**Type:** Boolean,
107+
**Units:** ,
108+
**Required:** true,
109+
**Model Dependent:** false
110+
111+
### System Node Setpoint Maximum Humidity Ratio
112+
113+
**Name:** System Node Setpoint Maximum Humidity Ratio,
114+
**Type:** Boolean,
115+
**Units:** ,
116+
**Required:** true,
117+
**Model Dependent:** false
118+
119+
### System Node Relative Humidity
120+
121+
**Name:** System Node Relative Humidity,
122+
**Type:** Boolean,
123+
**Units:** ,
124+
**Required:** true,
125+
**Model Dependent:** false
126+
127+
### System Node Pressure
128+
129+
**Name:** System Node Pressure,
130+
**Type:** Boolean,
131+
**Units:** ,
132+
**Required:** true,
133+
**Model Dependent:** false
134+
135+
### System Node Standard Density Volume Flow Rate
136+
137+
**Name:** System Node Standard Density Volume Flow Rate,
138+
**Type:** Boolean,
139+
**Units:** ,
140+
**Required:** true,
141+
**Model Dependent:** false
142+
143+
### System Node Current Density Volume Flow Rate
144+
145+
**Name:** System Node Current Density Volume Flow Rate,
146+
**Type:** Boolean,
147+
**Units:** ,
148+
**Required:** true,
149+
**Model Dependent:** false
150+
151+
### System Node Current Density
152+
153+
**Name:** System Node Current Density,
154+
**Type:** Boolean,
155+
**Units:** ,
156+
**Required:** true,
157+
**Model Dependent:** false
158+
159+
### System Node Enthalpy
160+
161+
**Name:** System Node Enthalpy,
162+
**Type:** Boolean,
163+
**Units:** ,
164+
**Required:** true,
165+
**Model Dependent:** false
166+
167+
### System Node Wetbulb Temperature
168+
169+
**Name:** System Node Wetbulb Temperature,
170+
**Type:** Boolean,
171+
**Units:** ,
172+
**Required:** true,
173+
**Model Dependent:** false
174+
175+
### System Node Dewpoint Temperature
176+
177+
**Name:** System Node Dewpoint Temperature,
178+
**Type:** Boolean,
179+
**Units:** ,
180+
**Required:** true,
181+
**Model Dependent:** false
182+
183+
### System Node Quality
184+
185+
**Name:** System Node Quality,
186+
**Type:** Boolean,
187+
**Units:** ,
188+
**Required:** true,
189+
**Model Dependent:** false
190+
191+
### System Node Height
192+
193+
**Name:** System Node Height,
194+
**Type:** Boolean,
195+
**Units:** ,
196+
**Required:** true,
197+
**Model Dependent:** false
198+
199+
200+
201+
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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+
<% end %>
30+
31+
<% if arguments.size == 0 %>
32+
<%= "This measure does not have any user arguments" %>
33+
<% end %>
34+
35+
<% if outputs.size > 0 %>
36+
## Outputs
37+
<% output_names = [] %>
38+
<% outputs.each do |output| %>
39+
<% output_names << output[:display_name] %>
40+
<% end %>
41+
<%= output_names.join(", ") %>
42+
<% end %>

0 commit comments

Comments
 (0)