6.1.3.1 Methods Defined Here
get_options( ) -> dictionary
Get the simulation options currently in effect. Return type is a dictionary with the current options. Available options are:
|
aux_ventilation
|
(Bool) defaults to True
|
|
cooling_end_month
|
(int) 1-12
|
|
cooling_start_month
|
(int) 1-12
|
|
end_day
|
(int) 1-31
|
|
end_month
|
(int) 1-12
|
|
HVAC
|
(Bool) include HVAC
|
|
HVAC_filename
|
(string) HVAC network filename, used if HVAC is True
|
|
macroflo
|
(Bool) setting this to True requires a macroflo input file (.mfo) to be present. Setting this to True is required for opening-level results
|
|
nat_ventilation
|
(Bool) defaults to True
|
|
preconditioning_days
|
(int) 0-365
|
|
radiance
|
(Bool) setting this to True will automatically run Radiance if queue_to_tasks is True when running simulations. It will not run automatically if a blocking simulation is run, in which case an existing Radiance results file (.ill) is required
|
|
reporting_interval
|
(int) 0=6, 1=10, 2=30, 3=60 minutes
|
|
results_filename
|
(string) file will be located in Vista folder
|
|
simulation_timestep
|
(int) 0=1, 1=2, 2=6, 3=10, 4=30 minutes
|
|
start_day
|
(int) 1-31
|
|
start_month
|
(int) 1-12
|
|
suncast
|
(Bool) setting this to True will run Suncast if required
|
|
suncast_filename
|
(string) shading file filename
|
Output options. These correspond to the Apache Simulation Output Options dialog and apply to all rooms:
|
output_conduction_gains
|
(Bool) defaults to False
|
|
output_HVAC_components
|
(Bool) defaults to False
|
|
output_HVAC_systems
|
(Bool) defaults to True
|
|
output_latent_internal_gains
|
(Bool) defaults to False
|
|
output_latent_ventilation_gains
|
(Bool) defaults to False
|
|
output_sensible_internal_gains
|
(Bool) defaults to True
|
|
output_standard_outputs
|
(Bool) defaults to True
|
Detailed output options. These correspond to the Apache Simulation Output Options dialog and apply only to the rooms indicated in detailed_rooms. Note that detailed output per room can significantly increase APS file size if a large number of rooms are included.
|
detailed_conduction_gains
|
(Bool) defaults to False
|
|
detailed_convective_gains
|
(Bool) defaults to True
|
|
detailed_external_solar
|
(Bool) defaults to False. Setting this for a room enables Surface level results for that room
|
|
detailed_HVAC_systems
|
(Bool) defaults to True
|
|
detailed_internal_solar
|
(Bool) defaults to False. Setting this for a room enables Surface level results for that room
|
|
detailed_latent_internal_gains
|
(Bool) defaults to True
|
|
detailed_latent_ventilation_gains
|
(Bool) defaults to True
|
|
detailed_microflo
|
(Bool) defaults to True
|
|
detailed_rooms
|
(list of strings) each string holds a room ID
|
|
detailed_sensible_internal_gains
|
(Bool) defaults to True
|
|
detailed_standard_outputs
|
(Bool) defaults to True
|
|
detailed_surface_temps
|
(Bool) defaults to True. Setting this for a room enables Surface level results for that room
|
Note that setting Suncast and Radiance to True will only auto-run suncast when using batch operation. When using the blocking run, suncast and radiance will not be automatically run when set to True, but if corresponding data files are available (shd and ill files) they will be used in simulation. Absence of data files may cause simulation to fail.
reset_options( ) -> Bool
Reset the simulation options file to defaults. Returns True if the options file was saved successfully.
run_compliance_simulation () -> Bool
Run compliance simulation with the currently active settings. Parallel Simulation Manager (BETA) will
be used. A return value of true indicates that simulation was run / queued, false indicates error.
run_loads_sizing()
Run a Loads and Sizing simulation
run_simulation( queue_to_tasks = False ) -> Bool
Run Apache thermal simulation with the currently active settings. If the queue_to_tasks parameter is True, Parallel Simulation Manager (BETA) will be used (if licensed and activated). The task will be queued and script operation will continue immediately. When not using queueing, the simulation will run and the VE is blocked until simulation is complete. A return value of true indicates that simulation was run / queued, false indicates error.
set_hvac_network(network_name)
Set the HVAC network.
set_options( {options} ) -> Bool
Set and save simulation options. These options will be used for the subsequent simulation run. See get_options() for details on available options (keywords). Returns True if the options file was saved successfully.
Note: the options to be set can be supplied either as a dict or as keyword parameters.
show_simulation_dialog( ) -> Bool
Show the Apache Simulation dialog. Returns True if dialog was shown and simulation was run.
stitch(output_file_path, files_to_stitch)
Stitch together a list of APS files into a single APS file.
Parameters:
|
output_file_path (string)
|
Path of the output APS file
|
|
files_to_stitch (list)
|
Ordered list of APS file to stitch
|
