trnslator.idfclass.load_idf

trnslator.idfclass.load_idf(eplus_file, idd_filename=None, output_folder=None, include=None, weather_file=None, ep_version=None)[source]

Returns a parsed IDF object from file. If trnslator.settings.use_cache is true, then the idf object is loaded from cache.

Parameters

  • eplus_file (str) – Either the absolute or relative path to the idf file.

  • idd_filename (str, optional) – Either the absolute or relative path to the EnergyPlus IDD file. If None, the function tries to find it at the default EnergyPlus install location.

  • output_folder (Path, optional) – Either the absolute or relative path of the output folder. Specify if the cache location is different than trnslator.settings.cache_folder.

  • include (str, optional) – List input files that need to be copied to the simulation directory. Those can be, for example, schedule files read by the idf file. If a string is provided, it should be in a glob form (see pathlib.Path.glob).

  • weather_file – Either the absolute or relative path to the weather epw file.

  • ep_version (str, optional) – EnergyPlus version number to use, eg.: “9-2-0”. Defaults to settings.ep_version .

Returns

The IDF object.

Return type

IDF