2. Reading and running IDF files
archetypal is packed up with some built-in workflows to read, edit and run EnergyPlus files.
To read an IDF file, simply call
IDF with the path name. For example:
>>> from archetypal import get_eplus_dirs, IDF >>> eplus_dir = get_eplus_dirs("9-2-0") # Getting EnergyPlus install path >>> eplus_file = eplus_dir / "ExampleFiles" / "BasicsFiles" / "AdultEducationCenter.idf" # Model path >>> idf = IDF(eplus_file) # IDF load
You can optionally pass the weather file path as well:
>>> weather = eplus_dir / "WeatherData" / "USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw" # Weather file path >>> idf = IDF(eplus_file, epw=weather) # IDF load
Editing IDF files is based on the eppy package. The
IDF object exposes the
EnergyPlus objects that make up the IDF file. These objects can be edited and new objects can be created. See the eppy
documentation for more information on how to edit IDF files.
EnergyPlus outputs can be quickly defined using the
Outputs class. This class and its
methods handle adding predefined or custom outputs to an IDF model. An
instantiated by default in an
IDF model. It accessed with the
outputs attribute. For example, the idf object created above can be modified by
adding a basic set of outputs:
One can specify custom outputs by calling
add_custom() with a list of dict
of the form fieldname:value and then
apply(). These outputs will be
appended to the IDF model only if
apply() is called. See
Outputs for more details on all possible methods.
To run an
IDF model, simply call the
on the IDF object. In both cases, users can also specify run options as well as output options.
For the same IDF object above:
When running EnergyPlus simulations, a caching system can be activated to reduce the number of calls to the
EnergyPlus executable or to reduce time spent on I/O operations such as in
htm() which parse the simulation results. This caching system will save
simulation results in a folder identified by a unique identifier. This identifier is based on the content of the IDF
file, as well as EnergyPlus simulate options. This system works by invalidating any dependant attributes when
independent attributes change.
The caching system is activated by calling the
archetypal.utils.config() method (or by setting
settings.use_cache = True), which can also be used to set a series of package-wide options.
typically be put at the top of a python script:
>>> from archetypal import config >>> config(use_cache=True)