install_eplus: Download and Install EnergyPlus

Description Usage Arguments Details Value Author(s) Examples

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)

download_eplus(ver = "latest", dir)

Arguments

ver

The EnergyPlus version number, e.g., 8.7. The special value "latest", which is the default, means the latest version.

force

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

dir

Where to save EnergyPlus installer file. For install_eplus(), the installer will be saved into tempdir()

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.

Value

An invisible integer 0 if succeed. Moreover, some attributes will also be returned:

Author(s)

Hongyuan Jia

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 

# for the latest version of EnergyPlus
download_eplus("latest", dir = tempdir())
install_eplus("latest")

# for a specific version of EnergyPlus
download_eplus(8.8, dir = tempdir())
install_eplus(8.8)

## End(Not run)

hongyuanjia/eplusr documentation built on Dec. 7, 2018, 1:03 p.m.