Why Aps and Vista variable name required for get_room_results()

The VE Python API allows users create simple programs using the Python Programming Language, to interact with a VE Model and/or Vista Results File
Post Reply
bbrannon4
VE Professor
VE Professor
Posts: 111
Joined: Wed Feb 12, 2014 6:56 pm

Why Aps and Vista variable name required for get_room_results()

Post by bbrannon4 »

I might be missing something so am just trying to understand. This is fromt he documentation:

get_room_results( room_id, aps_var, vista_var, var_level, start_day = -1, end_day = -1 )
-> Numpy array of floats
Get the results for specified room + variable. See variables list for available variables and matching level. See get_results for start_day and end_day details.

Is there an example of when there aren't unique aps and vista variable names? It's just an annoyance in many of my scripts to make sure they are match, but it seems like from the list of variables, only one or the other should be required.
User avatar
Rhind
IES Staff
IES Staff
Posts: 87
Joined: Fri Mar 22, 2013 5:06 pm

Re: Why Aps and Vista variable name required for get_room_results()

Post by Rhind »

Yes, there are some cases where they are not unique. For example, the APS variable 'Room air temperature&Temperature[w]', maps to both 'Degrees > Max. adaptive temp. (TM 52 criterion 1)' and 'Daily weighted exceedance (TM 52 criterion 2)'.

There is a companion function to get_room_results(), get_all_room_results(), which you might find useful. get_all_room_results() only requires the APS variable to be specified. It will return a dictionary of results keyed by the associated vista variables.

Hope that helps.
Post Reply