View source for PTP/photran/documentation/photran9installation

You are here: [[PTP]] &gt; [[PTP/photran/|Photran]] &gt; [[PTP/photran/documentation|Documentation]] &gt; [[PTP/photran/documentation/photran9installation|Photran 9.1 Installation Guide]]
<br><br>
<big><big><big><big>Photran 9.1 Installation Guide</big></big></big></big>
<br><br>

= System Requirements  =

To install Photran 9.1... 

#You must have a '''Java 1.7 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) usually works as well. 
#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. To debug Fortran applications, you must have GNU GDB installed. Many Linux/Unix systems include these; details on installing them in Windows and Mac are below.

= Overview =

There are two ways to get Photran.

* (Option 1) <i>The easiest way is to install the '''Eclipse for Parallel Application Developers'''.</i>  This includes Photran, as well as the C/C++ Development Tools, the Eclipse Parallel Tools Platform, and several other plug-ins.
* (Option 2) <i>Alternatively, you can install Eclipse 4.5 (Mars) and manually add Photran to your installation.</i>

= Option 1: Installing the Eclipse for Parallel Application Developers  =

The easiest way to get Photran is to go to the
[http://eclipse.org/downloads Eclipse downloads page] and install the '''Eclipse for Parallel Application Developers''' package.
This includes Photran, as well as the C/C++ Development Tools, the Eclipse Parallel Tools Platform, and several other plug-ins. 

= Option 2: Installing Photran into an Existing Eclipse Installation  =

==Requirements==

To install Photran 9.1 into an existing Eclipse installation, you <b>must</b> be running '''Eclipse 4.5 (Mars)'''.  Photran 9.1 will not install correctly into earlier versions of Eclipse.

#You should have the '''C/C++ Development Tools (CDT) 8.7''' installed. If you do not... 
##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. 
##Otherwise, CDT probably ''will not'' be installed automatically (this is also true if you installed Eclipse from a Linux distribution like Ubuntu). You will need to install CDT manually. Follow the instructions below for "Installing on a Machine Without Internet Access." 

== Installing on a Machine With Internet Access ==

To install Photran, start Eclipse, then...<br> 

#Click on Help &gt; Install New Software... 
#Click on the "Available Software Sites" hyperlink 
#Look for '''http://download.eclipse.org/tools/ptp/updates/mars''' in the list. 
##If it is in the list, check the box next to it (if it is not already checked). 
##If it is not in the list... 
###Click on the "Add..." button 
###In the Location field, type http://download.eclipse.org/tools/ptp/updates/mars 
###Click OK to close the Add Site dialog. This will return you to the Install dialog. 
#Click OK to close the Preferences dialog (i.e., the list of available software sites). This will return you to the Install dialog. 
#In the "Work with:" dropdown, choose http://download.eclipse.org/tools/ptp/updates/mars 
#Expand "Fortran Development Tools (Photran)" and check the box next to "Photran End-User Runtime" 
#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.
#Click on the "Next" button 
#If you get an error message, see below for troubleshooting information. 
#Click the Finish button and agree to the license to complete the installation.

<br>

== Installing on a Machine Without Internet Access  ==

You will the following files: 

#If you do not have CDT installed, you will need to download the latest 8.7.x "Archived p2 repo" from [http://www.eclipse.org/cdt/downloads.php http://www.eclipse.org/cdt/downloads.php]. This should be a file named '''cdt-8.7.x.zip''' (for some value of ''x'') 
#To install Photran, you will need the latest PTP update site archive from&nbsp;[http://wiki.eclipse.org/PTP/builds#Release_builds http://wiki.eclipse.org/PTP/builds#Release_builds][http://wiki.eclipse.org/PTP/builds#Release_builds ]. This will be a file named '''ptp-master-9.0.x-I2015xxxxxxxx.zip'''

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

#Click on Help &gt; Install New Software... 
#Click on the "Add..." button 
#Click on the "Archive..." button 
#Point it to the file ''cdt-8.7.x.zip'' 
#Click OK to close the Add Site dialog. This will return you to the Install dialog. 
#Expand "CDT Main Features" and check the box next to "Eclipse C/C++ Development Tools" 
#Click on the "Next" button 
#Click the Finish button and agree to the license to complete the installation. 
#After CDT is installed, you will be asked to restart Eclipse. You may then proceed to install Photran.

To install Photran, start Eclipse, then...<br> 

#Click on Help &gt; Install New Software... 
#Click on the "Add..." button 
#Click on the "Archive..." button 
#Point it to the file ''ptp-master-9.0.x-I2015xxxxxxxx.zip'' 
#Click OK to close the Add Site dialog. This will return you to the Install dialog. 
#Expand "Fortran Development Tools (Photran)" and check the box next to "Photran End-User Runtime" 
#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. 
#Click on the "Next" button 
#If you get an error message, see below for troubleshooting information. 
#Click the Finish button and agree to the license to complete the installation.

<br>

==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 [http://www.eclipse.org/photran/mailinglists.php Photran mailing list].

<br>

:'''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 9.1.x.xxxxxxxxxxxx (org.eclipse.photran.feature.group 9.1.x.xxxxxxxxxxxx)
::  Missing requirement: Photran VPG CDT Interface Plug-in 9.1.x.xxxxxxxxxxxx (org.eclipse.photran.cdtinterface.vpg 9.1.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 9.1.x.xxxxxxxxxxxx (org.eclipse.photran.feature.group 9.1.x.xxxxxxxxxxxx)
::    To: org.eclipse.photran.cdtinterface.vpg [9.1.x.xxxxxxxxxxxx]

:'''Solution:''' You do not have CDT 8.7 installed, and it couldn't be downloaded and installed automatically.  Try installing CDT 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. [http://gcc.gnu.org/fortran/ gfortran] and [http://www.gnu.org/make 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==

#Install [http://www.cygwin.com/ 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.)
#Add the Cygwin directories to your Windows PATH. Under Windows XP, the process is as follows:
##Make sure you are logged in under an administrator account.
##Open the Control Panel.
##Double-click the System icon.
##Switch to the Advanced tab.
##Click the Environment Variables button.
##Under System Variables, find the variable "Path" in the list, and click on it.
##Click Edit.
##At the end of the "Variable Value" text, add <pre>;C:\Cygwin\bin;C:\Cygwin\usr\bin;C:\Cygwin\usr\local\bin;C:\Cygwin\lib;C:\Cygwin\usr\lib</pre>
##Click OK, click OK, click OK, and close the Control Panel.
##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, or possibly /usr/local/gfortran/bin, neither of which is on the PATH (by default). 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.

== On Mac OS X Lion (10.7), Snow Leopard (10.6), and Earlier ==

On OS X 10.7 and earlier, the PATH is 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.''
<pre>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"&gt;
&lt;plist version="1.0"&gt;
&lt;dict&gt;
    &lt;key&gt;PATH&lt;/key&gt;
    &lt;string&gt;/usr/local/mpi/bin:/usr/local/bin:/bin:/sbin:/usr/bin:/usr/sbin:/sbin:/usr/sbin:/Developer/Tools:/usr/texbin:/Users/greg/bin&lt;/string&gt;
&lt;/dict&gt;
&lt;/plist&gt;
</pre>

== On Mac OS X Mountain Lion (10.8) and later ==

On OS X 10.8, you will need to modify the Info.plist file for the Eclipse executable, and then re-register the Eclipse application with the Launch Service database.

1. In the Finder, locate the Eclipse application.  Right-click on it, and click Show Package Contents.

2. Open the Contents folder.

3. Right-click on Info.plist, select Open With, and select Other.  Choose TextEdit, and click OK.  The Info.plist file will open in TextEdit.

4. Add an LSEnvironment dictionary below the &lt;dict&gt; line and above the &lt;key&gt;CFBundleExecutable&lt;/key&gt; line.  An example is shown below.  Be sure to change the path appropriately for your system; this example adds /usr/local/gfortran/bin and /usr/local/bin to an otherwise-typical path.  When you finish editing the file, save it, and quit TextEdit.
<pre>
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"&gt;
&lt;plist version="1.0"&gt;

&lt;dict&gt;
        &lt;key&gt;LSEnvironment&lt;/key&gt;
                &lt;dict&gt;
                        &lt;key&gt;PATH&lt;/key&gt;
                        &lt;string&gt;/usr/local/gfortran/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin&lt;/string&gt;
                &lt;/dict&gt;
        &lt;key&gt;CFBundleExecutable&lt;/key&gt;
                &lt;string&gt;eclipse&lt;/string&gt;
...
</pre>

5. Now, open the Terminal utility, and type the following command.  Replace &quot;/path/to/eclipse/Eclipse.app&quot; with the correct path to the Eclipse application on your system.
<pre>
/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework/Support/lsregister \
    -v -f \
    /path/to/eclipse/Eclipse.app
</pre>

References:<br>
http://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html<br>
http://stackoverflow.com/questions/829749/launch-mac-eclipse-with-environment-variables-set