use_eplus {eplusr}

Configure which version of EnergyPlus to use

Description

Configure which version of EnergyPlus to use

Usage

use_eplus(eplus)

eplus_config(ver)

avail_eplus()

is_avail_eplus(ver)

locate_eplus()

Arguments

eplus

An acceptable EnergyPlus version or an EnergyPlus installation path.

ver

An acceptable EnergyPlus version.

Details

use_eplus() adds an EnergyPlus version into the EnergyPlus version cache in eplusr. That cache will be used to get corresponding Idd object when parsing IDF files and call corresponding EnergyPlus to run models.

eplus_config() returns the a list of configure data of specified version of EnergyPlus. If no data found, an empty list will be returned.

avail_eplus() returns all versions of available EnergyPlus.

locate_eplus() re-searches all EnergyPlus installations at the default locations and returns versions of EnergyPlus it finds. Please note that all configure data of EnergyPlus installed at custom locations will be removed.

is_avail_eplus() checks if the specified version of EnergyPlus is available or not.

Value

• For use_eplus() and eplus_config(), an (invisible for use_eplus()) list of three contains EnergyPlus version, directory and EnergyPlus executable. version of EnergyPlus;

• For avail_eplus(), a numeric_version vector or NULL if no available EnergyPlus is found;

• For is_avis_avail_eplus(), a scalar logical vector.

See Also

download_eplus() and install_eplus() for downloading and installing EnergyPlus

Examples

## Not run: 
# add specific version of EnergyPlus
use_eplus("8.9")
use_eplus("8.8.0")

# get configure data of specific EnergyPlus version if avaiable
eplus_config("8.6")

## End(Not run)

# get all versions of avaiable EnergyPlus
avail_eplus()

# check if specific version of EnergyPlus is available
is_avail_eplus("8.5")
is_avail_eplus("8.8")