Linux Installation Instructions

EnergyPlus Installation/Uninstall Instructions for Linux operating systems

Required Software

  1. EnergyPlus for Linux is only tested on recent versions of Ubuntu and Redhat Linux. The package should, however, be compatible with most recent distributions of Linux.

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 etEPlusV830-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 etEPlusV830-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 ./etEPlusV830-lin.sh

    Alternatively, you can install without administrative privileges, but custom paths must be entered when prompted. To install without administrative rights enter:

    % ./etEPlusV830-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-V830.
  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.

Known Issues

While this version of EnergyPlus will run most IDF or IMF files regardless of origin (e.g, MS-DOS or linux), a few easy to work around cross-platform incompatibilities exist.  Specifically, file path name delimiters can cause problems.

For example, the FileName field in the Construction:WindowDataFile object is operating system dependent. Consequently, if an IDF or IMF file originates on a MS-DOS machine (i.e., Windows machine), check to make sure that any path delimiters in the FileName field are changed to their unix equivalents (the FileName DataSets\Window5DataFile.dat will need to be changed to DataSets/Window5DataFile.dat). The same is true the Name of File field in the Schedule:File object.

The weather file menu in the program EP-Launch Lite is built each time the program starts. What this means is that if you add a weather file to the weatherdata directory while EP-Launch Lite is running, the program will be unaware of the new weather file. To work around this issue, quit and restart EP-Launch Lite. The new weather file should now appear in the popup menu.

Notice for Linux Users

At the present time, the Linux version of EnergyPlus is a subset of the Windows version. The Linux version includes the EnergyPlus simulation engine and an interface to select input files and run a simulation. The Windows version of EnergyPlus includes additional utilities such as EP-Launch and IDF Editor which do not currently have Linux equivalents. IDF Editor is useful to simplify editing EnergyPlus input files. If you have a virtual Windows machine on your Linux machine, you may wish to also install the Windows version of EnergyPlus in order to access the additional utilities as needed.

Help

For questions regarding downloading and installing EnergyPlus on the Linux operating system, send email to [email protected].

For any other EnergyPlus related questions, please visit www.energyplus.net or send email to [email protected].