install_eplus: Download and Install EnergyPlus

Description Usage Arguments Details

View source: R/install.R

Description

Download specified version of EnergyPlus for your platform from GitHub and install it.

Usage

1
2
3
install_eplus(ver = "latest", force = FALSE, dir = tempdir())

download_eplus(ver = "latest", dir = getwd())

Arguments

ver

The EnergyPlus version number, e.g., 8.7; the special value "latest" means the latest version (fetched from GitHub releases).

force

Whether to install EnergyPlus even if it has already been installed.

dir

Where to save EnergyPlus installer file. Default is current working directory for download_eplus() and tempdir() for install_eplus().

Details

download_eplus() downloads specified version of EnergyPlus from EnergyPlus Github Repository.

install_eplus() will try to install EnergyPlus into the default location, e.g. ‘C:/EnergyPlusVX-Y-0’ on Windows, ‘/usr/local/EnergyPlus-X-Y-0’ on Linux, and ‘/Applications/EnergyPlus-X-Y-0’ on MacOS.

Note that the installation process requires administrative privileges during the installation and you have to run R with administrator (or with sudo if you are on Linux) to make it work if you are not in interactive mode.


hongyuanjia/eplusr documentation built on Aug. 12, 2018, 12:24 p.m.