Input Glossary

All components’ GUI inputs are alphabetically summarized and settings described here; refer to the user guide documents for a more in-depth discussion of parameter relationships. Only user-command inputs are discussed, not the data feeds. Contact me if you have advanced questions about those.

average_sum_or_freq_mode (user guide)

Switch between sum, average calculation or conditional percentage check
average: compute zone averages of selected variable for report time (range), schedule & frequency
sum: compute zone averages of selected variable for selected report time (range), schedule & frequency
frequency_bounds: count number of hours within schedule & set range that meet user-set conditions
Defined by frequency_condition low/highbound (set values are included in range)
frequency_single: count number of hours that meet exact condition defined by frequency_condition_lowbound slider (disregards the highbound slider)

convert_units (user guide)

Unit conversions
off: no unit conversion
x / 1000: divide zone data stream by 1000 (yields kWh from Wh)
When calling W unit report variables in range mode, Wh is the actual output
x * 0.00027: multiplier to convert Joules to Wh
(x * 0.00027) / 1000: multiplier to convert Joules to kWh
Same multiplier can also be used in custom var expression component inputs

daylight_mode (user guide)

Switch between selected thermal zone filtered, non-filtered and ‘off’ daylight display states
off: no daylight display
daylight on thermal (filtered nodes): only show daylight nodes within referenced thermal zones
daylight on thermal (all nodes): show all daylight nodes regardless of thermal zone selection
daylight only (all nodes, needs no therm. data): disable thermal calculations, show daylight only (use for standalone daylight display without referenced thermal data)

day_report_time_start_1-365 – *end (user guide)

if reporting frequency “daily“:
Set report time daily range / point in time; scheduling applies
Standard range input format; e.g. 1 – 22 = days 1 up to including 22 are reported

gradient_interpolation (user guide)

Switch between linear and logarithmic daylight display (disabled for frequency mode)
off: no interpolation
log_e: logarithmic interpolation (natural logarithm)

hour_report_time_start_0-8760 – *end (user guide)

if reporting frequency “hourly“:
Set report time hourly range / point in time; no scheduling
Standard hour range input format (as in schedule input)

min_or_max_peaks_mode (user guide)

Output minimum or maximum peaks & time stamps of generated time step sums or averages
off: no peaks, outputs averages or sums
min: compute zone peaks of minima of selected variable that occur in the selected time range during set schedule hours
max: compute zone peaks of maxima of selected variable that occur in the selected time range during set schedule hours
Modifiers: peaks report frequency changes according to reporting_frequency

month_report_time_start_1-12 – *end (user guide)

if reporting frequency “monthly“:
Set report time monthly range / point in time; scheduling applies
Standard range input format; e.g. 1 – 8 = months 1 up to including 8 are reported

normalize_per_zone_m2 (user guide)

Normalize output units by selected zones areas
off: no normalisation
on: divide zone data strea items by zone areas, resulting in [Unit]/m2
Set convert_units to “Wh to kWh”, normalize_per_zone_m2 “on” and call W rate report variable in range sum mode to get kWh/m2

range_or_point_in_time_mode (user guide)

Switch between single time step & custom data range display
range: report averages, peaks or sums from set range
point in time: report averages or sums from set single time step, taken from range start sliders
Modifiers: range and point in time frequency depends on reporting_frequency selection

reporting_frequency (user guide)

Set hourly, daily, monthly or annual report time step
Hourly reporting has no scheduling
Annual mode overrides all report time frequency inputs

schedule_hour_start_0-24 – *end (user guide)

Set schedule; only values from within its range are reported
Standard hour range input format; e.g. 8 – 18 = hours 8 up to but not including 18 are within schedule

suppress_null_zones (user guide)

Disregard zones with null data in gradient bounds calculation
off: all zones in report stream are considered for gradient bounds generation
on: zones that have “0″ as annual sum for selected report variable are disregarded for bounds generation, but are still included in zone stream

 var_expression (user guide)

Input custom user expression through GH panel (not set to “multiline data”), evaluate expression(s), append to new hourly report data variable(s). Input existing variable names for computations are not whitespace or case-sensitive. Tool evaluates input expression per hourly timestep and appends new custom variable hourly values (8760) to report variable fields of each zone.

Format: custom user variable name A “=” existing variable name 01 OPERATOR existing variable name 02; custom variable name B “=” existing variable name 03 OPERATOR existing variable name 04; etc.

Separator/declarator for user variable name is “=” (equals in quotes)
Separator for individual user variable commands is ; (semicolon, no quotes)
Supported standard operators: (+, -, /,*, **, >=, <=, ==, <, >) in their natural precedence
Use math.function() to access Python mathematical functions or primitives (documentation)
(Nested) bracketing is supported
Supported boolean primitives, conditionals & Python keywords:
if, else, elif, and, or, not, is, in, true, false, for

Sample commands, to be input via GH panel (NOT set to multiline):

Combined Energy = zone/sys sensible cooling rate + zone/sys sensible heating rate; Operative Temperature “=” (Zone Mean Air Temperature + Zone Mean Radiant Temperature)/2

Excess Heating Season Solar Gains “=” zone transmitted solar if (zone mean air temperature > 22 and zone/sys sensible heating rate > 0) else 0

var_expression_mode (user guide)

off/pass through: no custom calculations / disable
calculate: parse var_expression user command from non-multiline panel, add new variables to set of displayable metrics (memory-resident only, does not write back to *.csv (yet))

visualization_bounds_mode (user guide)

Select source time range of gradient low/high bounds calculation, allows for point in time traverse fit within longer time span
fit to input: gradient low and high bounds generated from minima and maxima of zone report value stream
custom range: gradient bounds computed from custom input time range
annual reporting_frequency mode has no custom bounds available

visualization_bounds_start_time_0-8760 – *end (user guide)

Set time range for custom range visualization bounds computation
Modifiers: reporting_frequency locks input to day or month selected hours are on, if set to daily or monthly mode