System Requirements

To install Photran 6.0... You must have Eclipse 3.6 (Helios) installed.

  1. You should have the C/C++ Development Tools (CDT) 7.0 installed. If you do not...
    1. If you downloaded Eclipse from eclipse.org and you will be following the instructions below for "Installing on a Machine With Internet Access," then CDT should be installed automatically when you install Photran.
    2. Otherwise, CDT probably will not be installed automatically. You will need to install CDT manually. Follow the instructions below for "Installing on a Machine Without Internet Access." You should also follow these instructions if you did not download Eclipse from eclipse.org (e.g., if you installed it from a Linux distribution like Ubuntu).
  2. Eclipse must be running on a Java 1.5 or later Java Virtual Machine (JVM). To get reasonable performance, we recommend Sun's JVM http://java.com/en/download/manual.jsp or IBM's J9 http://wiki.eclipse.org/index.php/J9. OpenJDK (the default JVM on newer versions Fedora Linux) also works well, although GNU Classpath (the default JVM on older versions of Fedora) is generally too slow to be useful.
  3. If you want to compile and build Fortran applications, you must have a make program (such as GNU Make) and a Fortran compiler (such as gfortran, the GNU Fortran compiler) in your system path. Many Linux/Unix systems include these; details on installing them in Windows and Mac are below.

Installation Procedure

Installing on a Machine With Internet Access

To install Photran, start Eclipse, then...

  1. Click on Help > Install New Software...
  2. Click on the "Add..." button
  3. In the Location field, type http://download.eclipse.org/tools/ptp/releases/helios
  4. Click OK to close the Add Site dialog. This will return you to the Install dialog.
  5. Expand "Fortran Development Tools (Photran)" and check the box next to "Photran End-User Runtime"
  6. If you are running Linux and have the Intel Fortran Compiler installed, or if you are on a Macintosh and have the IBM XL Fortran compiler installed, expand "Fortran Compiler Support" and select the appropriate compiler. Note that you cannot install Intel Fortran compiler support unless you are running Linux!
  7. Click on the "Next" button
  8. If you get an error message, see below for troubleshooting information.
  9. Click the Finish button and agree to the license to complete the installation.


Installing on a Machine Without Internet Access

You will the following files:

  1. If you do not have CDT installed, you will need to download the latest 7.0.x "CDT master update archive" from http://download.eclipse.org/tools/cdt/releases/helios/ ). This should be a file named cdt-master-7.0.x.zip (for some value of x )
  2. To install Photran, you will need the latest PTP update site archive from http://wiki.eclipse.org/PTP/builds/4.0.0 ). This should be a file named ptp-master-4.0.0-I2010xxxxxxxx.zip

If you do not have CDT installed, start Eclipse, then...

  1. Click on Help > Install New Software...
  2. Click on the "Add..." button
  3. Click on the "Archive..." button
  4. Point it to the file cdt-master-7.0.x.zip
  5. Click OK to close the Add Site dialog. This will return you to the Install dialog.
  6. Expand "CDT Main Features" and check the box next to "Eclipse C/C++ Development Tools"
  7. Click on the "Next" button
  8. Click the Finish button and agree to the license to complete the installation.
  9. After CDT is installed, you will be asked to restart Eclipse. You may then proceed to install Photran.

To install Photran, start Eclipse, then...

  1. Click on Help > Install New Software...
  2. Click on the "Add..." button
  3. Click on the "Archive..." button
  4. Point it to the file ptp-master-4.0.0-I2010xxxxxxxx.zip
  5. Click OK to close the Add Site dialog. This will return you to the Install dialog.
  6. Expand "Fortran Development Tools (Photran)" and check the boxes next to "Photran End-User Runtime" and "Rephraser Engine End-User Runtime" (the latter is a supporting component)
  7. If you are running Linux and have the Intel Fortran Compiler installed, or if you are on a Macintosh and have the IBM XL Fortran compiler installed, expand "Fortran Compiler Support" and select the appropriate compiler. Note that you cannot install Intel Fortran compiler support unless you are running Linux!
  8. Click on the "Next" button
  9. If you get an error message, see below for troubleshooting information.
  10. Click the Finish button and agree to the license to complete the installation.


Troubleshooting

Eclipse's installer gives notoriously cryptic error messages, which, unfortunately, are out of Photran's control. Some of the more common ones are below. If you run into a different error message and cannot resolve it, please ask for help on the Photran mailing list .


Problem: You receive the following error message during installation.
Cannot complete the install because one or more required items could not be found.
Missing requirement: 125xxxxxxxxxx 0.0.0.125xxxxxxxxxx requires 'org.eclipse.photran.intel.feature.group 5.0.0.xxxx' but it could not be found
Solution: You are attempting to install support for the Intel Fortran compiler, but you are not running Linux. Go back in the installation wizard, and uncheck "Linux Intel(R) Fortran Compiler Support."


Problem: You receive the following error message during installation.
Cannot complete the install because one or more required items could not be found.
Software being installed: Photran End-User Runtime 6.0.x.xxxxxxxxxxxx (org.eclipse.photran.feature.group 6.0.x.xxxxxxxxxxxx)
Missing requirement: Photran VPG CDT Interface Plug-in 6.0.x.xxxxxxxxxxxx (org.eclipse.photran.cdtinterface.vpg 6.0.x.xxxxxxxxxxxx) requires 'bundle org.eclipse.cdt.core 0.0.0' but it could not be found
Cannot satisfy dependency:
From: Photran End-User Runtime 6.0.x.xxxxxxxxxxxx (org.eclipse.photran.feature.group 6.0.x.xxxxxxxxxxxx)
To: org.eclipse.photran.cdtinterface.vpg 6.0.x.xxxxxxxxxxxx
Solution: You do not have CDT 7.0 installed, and it couldn't be downloaded and installed automatically. Try installing CDT 7.0 first, then retry installing Photran.

Additional Instructions for Windows Users

To compile and run Fortran programs in Photran, you will need to have a Fortran compiler and make utility installed. gfortran and GNU Make are commonly used (and free). Most Linux/Unix distributions include these. Under Windows, you will need to install Cygwin http://www.cygwin.com/ (which optionally includes gfortran and GNU Make) or MinGW http://www.mingw.org/ and put them on your Windows PATH.

Instructions for Cygwin

  1. Install Cygwin ; the defaults are mostly OK, but you will need to explicitly tell it to include the "Devel" packages (at least gcc4-fortran, gdb, and make) when the installer asks you to select what packages to install. (If gcc4-fortran is not listed under the "Devel" packages, you may have chosen a bad mirror; restart the Cygwin installation, and choose a different mirror instead. Georgia Tech's mirror at gtlib.gatech.edu is generally quite fast and reliable, for example.)
  2. Add the Cygwin directories to your Windows PATH. Under Windows XP, the process is as follows:
    1. Make sure you are logged in under an administrator account.
    2. Open the Control Panel.
    3. Double-click the System icon.
    4. Switch to the Advanced tab.
    5. Click the Environment Variables button.
    6. Under System Variables, find the variable "Path" in the list, and click on it.
    7. Click Edit.
    8. At the end of the "Variable Value" text, add
      ;C:\Cygwin\bin;C:\Cygwin\usr\bin;C:\Cygwin\usr\local\bin;C:\Cygwin\lib;C:\Cygwin\usr\lib
    9. Click OK, click OK, click OK, and close the Control Panel.
    10. Close and re-open Photran. Windows should now search C:\Cygwin\bin, C:\Cygwin\usr\bin, etc. when it's looking for executables (including make.exe, gcc.exe, and gfortran.exe).

Additional Instructions for Mac OS X Users

If you install gfortran on Mac OS X, it may be installed in /usr/local/bin, which is not (by default) on the PATH. If you are launching Eclipse from a Terminal, the PATH can be set by modifying /etc/paths. However, if you are launching Eclipse from the Finder (by double clicking on it) or the Dock, then the PATH is not obtained from the shell or /etc/paths. Instead, it's obtained from ~/.MacOSX/environment.plist. The format of the environment.plist file is as follows (change the path appropriately). If you create or edit this file, you will need to log out (or reboot) before the changes will take effect.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>PATH</key>
<string>/usr/local/mpi/bin:/usr/local/bin:/bin:/sbin:/usr/bin:/usr/sbin:/sbin:/usr/sbin:/Developer/Tools:/usr/texbin:/Users/greg/bin</string>
</dict>
</plist>