IDF_class

Enables some geomeppy based functionality on idf objects

class IDF_class.IDF(idfname=None, epw=None)[source]

Adding some class functions to help with Geomeppy

Parameters:

  • idfname (str, optional) – Path to an IDF file (which does not have to exist yet).

  • epw (str, optional) – File path to the EPW file to use if running the IDF.

add_overhangs(depth, tilt=90, orientation=None, transmittance='')[source]

Set the overhang shading on all external windows by creating a SHADING:ZONE:DETAILED object which can be viewed using geomeppy’s view_model() function. Note: Depth must be greater than 0 :param depth: The depth of the overhang {m}. :param tilt: Tilt Angle from Window/Door {deg}. :param orientation: One of “north”, “east”, “south”, “west”. Walls within 45 degrees will be affected. :param Transmittance: Transmittance Schedule Name.

read()[source]

don’t need to use allcaps to search for items in idfobjects.

relative_to_world_coords()[source]

translates all surfaces, subsurfaces, shadings and daylighting reference points to world coordinates

remove_shading(orientation=None)[source]

removes shading surfaces with respect to orientation Note: default is ALL directions

remove_windows(orientation=None)[source]

removes windows with respect to orientation Note: default is ALL directions

view_model()[source]

automatically checks if the idf is in Relative or World coordinates

IDF_class.add_overhangs(idf, depth=<class 'float'>, tilt=90, orientation=None, Transmittance='')[source]
Set the overhang shading on all external windows by creating a SHADING:ZONE:DETAILED object

which can be viewed using geomeppy’s view_model() function.

Note: Depth must be greater than 0

Parameters:

  • idf – The IDF to edit.

  • depth – The depth of the overhang {m}.

  • tilt – Tilt Angle from Window/Door {deg}.

  • orientation – One of “north”, “east”, “south”, “west”. Walls within 45 degrees will be affected.

  • Transmittance – Transmittance Schedule Name.

IDF_class.relative_coordinates_model(building)[source]
translates RELATIVE coordinates of building surfaces to be viewed

using view_model() function without altering original idf.

Note: Does not correctly display after using geomeppy’s rotate() function

Param:

building: The building we want displayed with RELATIVE coordinates

IDF_class.relative_to_world_coords(idf)[source]

translates all surfaces, subsurfaces and daylighting reference points to world coordinates and then sets global geometry rules coordinate systems to “World”

IDF_class.remove_shading(idf, orientation=None)[source]

removes fins and overhangs from the idf Note: cannot differentiate between fins and overhangs.

Param:

orientation: compass direction with respect to building azimuth

IDF_class.remove_windows(idf, orientation=None)[source]

removes windows from the idf

Param:

orientation: compass direction with respect to building north

IDF_class.translate_to_origin(idf: IDF) → None[source]

Move an IDF so the building touches the origin. :param idf: The IDF to edit.

IDF_class.view_idf(idf: IDF) → None[source]

Display an IDF for inspection.