add_air_exchange (airExchange)
add_gain (casualGain)
apply_changes ()
Apply any changes made to the template to the model. Note: if this is not called, changes to the template will not be reflected in the model. This includes changes to gains and air exchanges for the template.
Note – this operation may take a significant amount of time on large models.
get () -> (roomConditions, apSystems, casualGains, airExchanges)
Returns a tuple containing all the details for the thermal template.
See the individual get_xxx functions below for information on the returned data.
get_air_exchanges () -> list
get_apache_systems () -> dictionary
Dictionary containing Apache Systems settings. The following fields are returned:
|
HVAC_system
|
(string) Apache System ID
|
|
aux_vent_system
|
(string) Apache System ID
|
|
aux_vent_system_same
|
(Boolean) True if aux vent system is same as HVAC system
|
|
cooling_capacity_units
|
(int) see below
|
|
cooling_capacity_unlimited
|
(Boolean)
|
|
cooling_capacity_value
|
(float) see cooling_capacity_units for units
|
|
cooling_plant_radiant_fraction
|
(float)
|
|
dhw_system
|
(string) Apache System ID
|
|
dhw_system_same
|
(Boolean) True if DHW system is same as HVAC system
|
|
heating_capacity_units
|
(int) see below
|
|
heating_capacity_unlimited
|
(Boolean)
|
|
heating_capacity_value
|
(float) see cooling_capacity_units for units
|
|
heating_plant_radiant_fraction
|
(float)
|
|
system_air_free_cooling
|
(float) see system_air_free_cooling_units for units
|
|
system_air_free_cooling_units
|
(int) see below for airflow units
|
|
system_air_minimum_flowrate
|
(float) see system_air_minimum_flowrate_units for units
|
|
system_air_minimum_flowrate_units
|
(int) see below for airflow units
|
|
system_air_variation_profile
|
(string) profile ID
|
Valid values for capacity units:
-1 = unlimited
0 = kW
1 = W/m2
Valid values for airflow units:
0 = ach
1 = l/s
2 = l/s/m²
3 = l/s/person
get_casual_gains () -> list
get_room_conditions () -> dictionary
Dictionary containing Room Conditions settings. The following fields are returned:
|
cooling_profile
|
(string) profile ID
|
|
cooling_setpoint
|
(float, °C) cooling setpoint, only valid if cooling_setpoint_constant is True
|
|
cooling_setpoint_constant
|
(Boolean)
|
|
cooling_setpoint_profile
|
(string) only valid if cooling_setpoint_constant is False
|
|
dhw
|
(float) DHW value linked to dhw_units
|
|
dhw_profile
|
(string) '–' if linked to occupancy, else profile ID of DHW profile
|
|
dhw_units
|
(string) one of: l/(h·pers) or l/h
|
|
heating_profile
|
(string), profile ID
|
|
heating_setpoint
|
(float, °C) cooling setpoint, only valid if heating_setpoint_constant is True
|
|
heating_setpoint_constant
|
(Boolean)
|
|
heating_setpoint_profile
|
(string) only valid if heating_setpoint_constant is False
|
|
plant_profile
|
(string) profile ID
|
|
plant_profile_type
|
(int) 0 = heating Profile, 1 = cooling profile, 2 = independent profile
|
|
sat_perc_lower
|
(float, %)
|
|
sat_perc_upper
|
(float, %)
|
remove_air_exchange (airExchange)
Remove air exchange from template. Will throw exception if air exchange is not associated with template.
remove_gain (casualGain)
Remove casual gain from template. Will throw exception if gain is not associated with template.
set_all_details (room_conditions, system_data)
Set both System Data and Room Conditions settings by passing in dictionaries of settings.
See set_apache_systems and set_room_conditions for dictionary keys.
set_apache_systems (system_data)
Set System Data settings by passing in a dictionary of settings.
Dictionary keys are:
|
aux_vent_system
|
|
aux_vent_system_same
|
|
conditioned
|
|
cooling_capacity_units
|
|
cooling_capacity_value
|
|
cooling_plant_radiant_fraction
|
|
dhw_system
|
|
dhw_system_same
|
|
heating_capacity_units
|
|
heating_capacity_value
|
|
heating_plant_radiant_fraction
|
|
HVAC_methodology
|
|
HVAC_system
|
|
system_air_free_cooling
|
|
system_air_free_cooling_units
|
|
system_air_minimum_flowrate
|
|
system_air_minimum_flowrate_units
|
|
system_air_variation_profile
|
set_room_conditions (room_conditions)
Set Room Conditions settings by passing in a dictionary of settings.
Dictionary keys are:
|
cooling_profile
|
|
cooling_setpoint
|
|
cooling_setpoint_constant
|
|
cooling_setpoint_profile
|
|
dhw
|
|
dhw_profile
|
|
dhw_units
|
|
heating_profile
|
|
heating_setpoint
|
|
heating_setpoint_constant
|
|
heating_setpoint_profile
|
|
plant_profile
|
|
plant_profile_type
|
|
sat_perc_lower
|
|
sat_perc_upper
|
