eplus_job: Create an EnergyPlus Simulation Job

Description Usage Arguments Value Author(s) See Also Examples

View source: R/job.R

Description

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.

Usage

1
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.

Value

An EplusJob object.

Author(s)

Hongyuan Jia

See Also

param_job() for creating an EnergyPlus parametric job.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
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))
}

hongyuanjia/eplusr documentation built on Oct. 14, 2018, 10:59 a.m.