eppySupport¶
-
eppySupport.create_idf_object(idd, idf, epw)[source]¶ Returns an idf object generated from the passed idd, idf, and epw
Parameters: - idd (str) – The directory to the idd
- idf (str) – The directory to the idf
- epw (str) – The directory to the epw
-
eppySupport.get_energy_usage(idf, obj_list)[source]¶ Runs an idf, and extracts the building’s energy usage from that run.
Parameters: - idf (IDF) – The idf to be run.
- obj_list (list) – ONLY USED IF VERBOSE IS TRUE FOR DEBUGGING PURPOSES. This variable prints the final state of each of the idf’s objects that are being changed.
-
eppySupport.get_idfobject_from_name(idf, name)[source]¶ Gets an object from the passed idf where it’s name value is equal to the passed string, if none are found then this method returns None
Parameters: - idf (IDF) – The idf to find the object from.
- name (str) – The string to find that is equal to the name field of the object.
-
eppySupport.listify_idf_objects(idf, objects)[source]¶ Takes the passed idf, and grabs the objects out of it that are specified in objects
Parameters: - idf (IDF) – The idf to grab the objects from
- objects (list) – A list generated from a yaml file that specifies how and what to read from the idf file
-
eppySupport.printErr(msg)[source]¶ Prints the message in an error red on unicode supported consoles.
Parameters: msg (str) – The string to print
-
eppySupport.printSuccess(msg)[source]¶ Prints the message in a success green on unicode supported consoles.
Parameters: msg (str) – The string to print
-
eppySupport.rebuild_idf(idd_path, idf_path, epw_path, w_objects, build_list)[source]¶ Builds an idf based off of a passed config file, and a list of values that was passed.
Parameters: - idd_path (str) – The absolute path to the idd file to be run.
- idf_path (str) – The absolute path to the idf file to be run.
- epw_path (str) – The absolute path to the epw file to be run.
- w_objects (list) – A list generated from a yaml file that specifies how and what to read from the idf file
- build_list (list) – A list of values which will be assigned to values in objects in the idf.