Linux Installation Instructions

EnergyPlus Installation/Uninstall Instructions for Linux operating systems

1. Other Software Required
2. Install EnergyPlus
3. Uninstall EnergyPlus
4. Help

Required Software

1. openssl - www.openssl.org
   The EnergyPlus download for Linux is password protected with the openssl utility. Your distribution of Linux probably already has this software installed. Enter "which openssl" at the command prompt to see if the software is installed in your path. If your distribution does not include openssl, let us know -- send email to kyle.benne@nrel.gov.

Optional Software

1. bash - The support programs that are distributed with this software are Bash shell scripts. To use these scripts you will need to have the Bash shell installed on your system.
   
   
2. Dos2unix converter that converts DOS text files to the UNIX format. You may need this to convert DOS input or data set files to the UNIX file format. You do not need this program to convert weather files -- they should read okay from any source.
   
   You can get dos2unix from www.rpmfind.net.
   
   
3. Adobe Acrobat Reader 8.0 or later for viewing documentation files.
   Download this from http://www.adobe.com/.
   
   

Install EnergyPlus

1. To download, right click the link provided in your registration email and select 'Save Link As' from the menu.
   In the Save As... panel: Make sure the Selection field contains your home directory followed by the file name SetEPlusV400024-lin.sh. Click OK .
   
   
2. The download is a self extracting archive. After the download is complete, make the downloaded file executable by running the command (where % is the command prompt):
   
   % chmod +x SetEPlusV400024-lin.sh
3. The default install location is /usr/local, therefore the installer must be executed with administrative privileges. Assuming your account has administrative rights, enter:
   
   % sudo ./SetEPlusV400024-lin.sh
   
   Alternatively, you can install without administrative privileges, but custom paths must be entered when prompted. To install without administrative rights enter:
   
   % ./SetEPlusV400024-lin.sh
   
   
4. Enter your admin password if required by sudo.
   
   
5. The installer will prompt for the installation path. Type the enter key to accept the default install location. EnergyPlus will be installed to a directory named EnergyPlus-V400024.
   
   
6. The installer will prompt for a path where symbolic links will be created to the software executables. The default is /usr/local/bin. Type the enter key to accept the default link location.
   
   
7. As previously stated, the package is password protected by openssl. The password will be sent to your email address when the software is downloaded. Enter the password at the prompt.
   
   
8. If symbolic links were created to a location in your path (ie. /usr/local/bin ), the installation is complete. Type the following for further information on running the included scripts.
   
   % runenergyplus --help
   % energyplus --help
   % readvarseso --help
   
   
9. If EnergyPlus was installed to a non standard location, you may need to modify the PATH environment variable to point to the bin directory of the EnergyPlus installation. See your distributions documentation for instructions on setting the PATH variable.

Uninstall EnergyPlus

To uninstall EnergyPlus, execute the uninstall.sh script in the EnergyPlus installation directory. This script will remove any symbolic links pointing to the installation. After the symbolic links are removed, you may remove the EnergyPlus- directory to completely remove the installed software.

IV. Help

For questions regarding downloading and installing EnergyPlus on the Linux operating system, send email to kyle.benne@nrel.gov.

For any other EnergyPlus related questions, please visit www.energyplus.gov or send email to EnergyPlus-Support@gard.com.