This page provides a brief overview of how to install and run EnergyPlus on the Macintosh OS X system. Additional information can be found in the documentation folder. The Mac OS X version of EnergyPlus requires an Intel-based Mac running Mac OS X version 10.5 or newer.
Note that the ReadMe.html document (located in the BaseDocs folder), while helpful in understanding how EnergyPlus works, describes the MS-DOS/Windows version of the EnergyPlus program. For instructions specific to operating the Macintosh version of the program, see below.
How to Install EnergyPlus
If you recently installed EnergyPlus via its installer, skip ahead to the How to Run EnergyPlus section below, otherwise:
Open the installer disk image
After you have completed downloading the SetEPlusV830-mac-64.dmg disk image, open it by double-clicking its icon.
- Start the installation program
The disk image contains an installer file named SetEPlusV830-mac-64.pkg. Double-click the installer package to start the installation process.
- Follow the on screen prompts of the installation program.
The main application will be installed in the EnergyPlus folder within the Applications folder.
How to Run EnergyPlus
From EP-Launch Lite application program:
You can run EnergyPlus form the EP-Launch Lite application that is found in the EnergyPlus application folder.
From command line:
Alternatively, from the command line of the terminal window (the Terminal application is found in /Applications/Utilities), type:
% runenergyplus -- help
The resulting terminal out will give you additional information about how to run EnergyPlus.
Note that in the above examples, the "%" symbol represents the command prompt (e.g., your_userid%).
You type only the part of the command that follows the prompt (e.g., at the prompt, type "runenergyplus -- help").
How to Convert DOS Files to UNIX Format
From the command line of the terminal window (the Terminal application is found in the /Applications/Utilities folder) type "dos2unix -U" and then the name of the file that you want to convert to unix format. For example: % dos2unix -U example.idf For more information on the dos2unix utility, type "dos2unix -h" from the terminal window's command prompt.
How to Remove EnergyPlus
To uninstall EnergyPlus, double-click the Uninstall EnergyPlus application. The program will ask you whether you want to continue. WARNING: If you click "OK", the uninstaller will immediately delete all files in the EnergyPlus application folder. This utility will remove all of the EnergyPlus-related symbolic links from the /usr/bin directory.
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 of 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 Apple Mac Users
At the present time, the Mac version of EnergyPlus is a subset of the Windows version and only runs on Intel-based Macs. The Mac 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 Mac equivalents. IDF Editor is useful to simplify editing EnergyPlus input files. If you have a virtual Windows machine on your Mac (using VM Fusion or Parallels or similar), you may wish to also install the Windows version of EnergyPlus in order to access the additional utilities as needed.
For questions regarding downloading and installing EnergyPlus on Mac OS X, send e-mail to [email protected].