eplus_job() takes an IDF and EPW as input, and returns an EplusJob object for running EnergyPlus simulation and collecting outputs. For more details, please see EplusJob.

eplus_job(idf, epw)

Arguments

idf

A path to an local EnergyPlus IDF file or an Idf object.

epw

A path to an local EnergyPlus EPW file or an Epw object. epw can also be NULL which will force design-day-only simulation when $run() method is called. Note this needs at least one Sizing:DesignDay object exists in the Idf.

Value

An EplusJob object.

See also

param_job() for creating an EnergyPlus parametric job.

Examples

if (is_avail_eplus(8.8)) { idf_name <- "1ZoneUncontrolled.idf" epw_name <- "USA_CA_San.Francisco.Intl.AP.724940_TMY3.epw" idf_path <- file.path(eplus_config(8.8)$dir, "ExampleFiles", idf_name) epw_path <- file.path(eplus_config(8.8)$dir, "WeatherData", epw_name) # create from local files eplus_job(idf_path, epw_path) # create from an Idf and an Epw object eplus_job(read_idf(idf_path), read_epw(epw_path)) }
#> ── EnergyPlus Simulation Job ─────────────────────────────────────────────────── #> * Model: `/usr/local/EnergyPlus-8-8-0/ExampleFiles/1ZoneUncontrolled.idf` #> * Weather: `/usr/local/EnergyPlus-8-8-0/WeatherData/USA_CA_San.Francisco.I...` #> * EnergyPlus Version: `8.8.0` #> * EnergyPlus Path: `/usr/local/EnergyPlus-8-8-0` #> < Simulation has not been run before >