Installing GSAS-II on Mac OS X

Prerequisite: Before GSAS-II can be used on your computer, you must have Python installed with a number of required Python packages (see below.) You must also have the subversion (svn) package installed, which is standard on all Macs prior to Mountain Lion (10.8).

GSAS-II has been tested by us on Intel (i386) Macs running 10.5 (Leopard), 10.6 (Snow Leopard) and 10.7 (Lion). We have heard from people running with 10.8 (Mountain Lion) but have not tested this ourselves. Getting GSAS-II to run on 10.4 or PPC (G4/G5) Macs is likely possible, but will require considerable work since you would need to build python and its packages from source code and compile the GSAS-II Fortran code; this is not recommended except to the cognoscenti.

Quick Install Instructions

1. Install EPDfree, download ​the EPDfree 32-bit Mac installer from web page ​https://www.enthought.com/repo/free/. This requires administrator privileges. Note that GSAS-II requires a 32-bit version of Python.

2. (For 10.7 or earlier, skip this step.) Install Subversion, if running Mountain Lion (OS X 10.8) using ​http://www.wandisco.com/get/?f=subversion-binaries/1.7/Subversion-1.7.7_10.8.x.pkg or see below for distributions from Apple.

3. Download file bootstrap.py file from ​​https://subversion.xray.aps.anl.gov/trac/pyGSAS/browser/install/bootstrap.py?format=txt and move it to the location where you want GSAS-II to be installed.

4. Start a terminal window and run the previous file by typing <path1>python <path2>bootstrap.py, where <path1> is the location where the full python has been loaded. If you are not sure, you can type python on a line by itself and see if you are running EPD python. <path2>` will be where you have installed the bootstrap.py file. Simply clicking on that file might work.

5. Run GSAS-II with the GSASII.app file created by the bootstrap procedure.

Python

Python is a computer scripting language, which means that one must have the Python interpreter installed on your Mac to run a Python program. Macs do come with python installed, but not with all the Python packages required by GSAS-II, so some Python software installation is required. Note that GSAS-II requires the WxPython package, which at present runs on the Mac only in 32-bit Python.

We use the ​Enthought Python Distribution (EPD) package for our code development (Argonne has a site license). EPD is being replaced by a newer product, Canopy, which we have not tested. We have done some testing with a free version of this package, called ​EPDFree that will run GSAS-II with addition of one small package (see below). Note that the versions of python supplied with OS X seem pretty old, so adding the missing packages is probably not a good idea. Use of the Fink or DarwinPorts versions of Python is also not the best choice -- the GUI and graphics will be shown in X-windows rather than in Mac style. Note that at this time, Python 2.7 is recommended for GSAS-II; older versions of Python (particularly 2.5 or earlier) may not work. GSAS-II does not yet support Python 3.0+.

• The freely distributed ​Enthought EPDfree Python package provides everything one needs to run GSAS-II, except the interface needed for OpenGL graphics (​PyOpenGL) which can be added; GSAS-II will attempt to install this package for you when first started. Note that Enthought has replaced EPDfree with CanopyExpress; we have not tested that. To get EPDfree, download ​the EPDfree 32-bit Mac installer from web page ​https://www.enthought.com/repo/free/. This is a ~72Mb .dmg file that requires admin privs to install. Installation from the .dmg is easy: click on the file to open it (that might happen automatically when you download it). In that new volume, you will see the EPD_free.mpkg installer. Click on that to start the installation process. It works best to run this from the account where you will run GSAS-II and supply the name of the admin account and its password when requested, as this will cause your login shell setup file to be updated so that directory /Library/Frameworks/Python.framework/Versions/Current/bin is in your path. (This is done by adding lines like this to file ~/.profile:

  # Setting PATH for EPD-7.2-2
  PATH="/Library/Frameworks/Python.framework/Versions/Current/bin:${PATH}"
  export PATH
  

• ​Enthought Python Distribution (EPD) is a commercially licensed Python package that features differing levels of support. It appears that academic users can obtain this for free at this link ​http://enthought.com/products/edudownload.php. It is usually distributed as an ~250Mb .dmg file that requires admin privs for installation (but note that a version that can be installed without admin privs is here: ​http://www.enthought.com/repo/epd/installers/mac_local/). Follow the above instructions to install from the .dmg file or type bash epd-7.7-2-macos-i386.sh and follow prompts to install locally.

• ​ActiveState ActivePython is a possible alternative to EPD. This is also commercial licensed software, where there is a free version with no support. We have not tried this yet. If it works for you, please let us know.

Subversion

If you are running 10.7 (Lion) or earlier, skip this step. For 10.8 (Mountain Lion) you must install the subversion (svn) package. To do this install one of the following: Apple's Command Line Tools, or Apple's Xcode development environment, a 3rd party SVN package, or build from source code, see ​http://subversion.apache.org/download/. The Command Line Tools and Xcode can be downloaded from the Apple Developer's web site (​https://developer.apple.com/) or can possibly be found on the OS X install DVD. A free 3rd party version of Subversion from WANdisco is here: ​http://www.wandisco.com/get/?f=subversion-binaries/1.7/Subversion-1.7.7_10.8.x.pkg.

Compiling Fortran Code

Please skip this step, unless you have an older computer running OS X 10.4 or a PPC (G4, etc.) CPU.

GSAS-II requires a small number of Fortran routines that are incorporated as Python packages (.so files). If you use Python 2.7 and ac OS X 10.5 and 10.6+, GSAS-II should run with distributed files. If you are using less common, you may need to compile the Fortran routines yourself using the NumPy f2py routine and the compiler of your choice. Both G77 and GFortran have worked on the Mac.

To help with compiling the programs, use the python scons routine inside the GSASII/fsource directory. If you are lucky, this routine will find the needed compiler and python program, set all options correctly for you and run all steps needed to prepare the .so files. This is done by

(1) opening a Terminal or xterm window,

(2) using the cd command to set your working directory to .../GSASII/fsource and

(3) simply typing "scons" in the window.

If you need to change any options, type "scons help" to see a list of the possible command-line arguments and the values for the options. For testing, help can be used with command-line options to see how they will change the variables.

Installation

We prefer that GSAS-II be installed using subversion so that it is easy to get updates (which are frequent). Fortunately, with OS X 10.5, 10.6 or 10.7, Macs come with subversion installed. (10.8 see above.) This procedure loads GSAS-II using subversion:

1. Create a folder where you want to install GSAS-II.

2. Download file bootstrap.py file using this link:

​https://subversion.xray.aps.anl.gov/trac/pyGSAS/browser/install/bootstrap.py?format=txt

or use this command:

curl https://subversion.xray.aps.anl.gov/pyGSAS/install/bootstrap.py > bootstrap.py

3. Move the bootstrap.py file into the newly created GSAS-II folder

4. Run the bootstrap.py file by double-clicking on it or using the command python bootstrap.py

5. This creates a GSASII.app file that can be used to start GSAS-II either by clicking on the app or by dragging a file onto the app. Note that the app file can be dragged to the doc, but it cannot be moved to another folder. Instead, create an alias and move the alias where desired.

Note that GSAS-II can be updated at any time by reusing the bootstrap.py file. This will download any newly created and modify any updated program files.

Errors from GSASII.app

The error messages from the GSASII.app are placed in a file named GSASIIerrors in the user's home directory

---

If you can help expand any of these instructions, discover new mechanisms for installing Python, or have problems getting this to work, please let me know.