Changeset 773

Timestamp:

Dec 4, 2009 5:11:47 PM (11 years ago)

Author:

toby

Message:

# on 2004/01/30 00:47:28, toby did:
revise to match new version

File:

• trunk/doc/osx.html (modified) (6 diffs, 3 props)

trunk/doc/osx.html

@@ -30 +30 @@
 
 
-These are approximate directions for installing GSAS & EXPGUI on a 
-Macintosh OS X machine. The software has been built using OS X 10.2.6 
+This page contains information on installing and running GSAS & EXPGUI
+on Macintosh OS X computers. The software has been built using OS X 10.2.6 
 and has been installed successfully on 10.2 and 10.3 machines. 
-Note that most users will probably have already installed X11 and 
-FINK on their computers. Most OS X books can provide more information
-on how to do this.
+
+<h2>Installation</H2>
+The following summarizes the steps needed to load prerequisite software
+as well as the GSAS/EXPGUI distribution.
+I presume that most Mac users will probably have already installed X11 and 
+FINK on their computers. I have very limited experience with this, so please 
+do not contact me for help with steps 1-3. However, 
+most OS X books can provide more details beyond what is given here.
 
 <OL>
@@ -46 +51 @@
 >http://www.apple.com/macosx/features/x11/download/
 </A>. </I>
-(Please do not contact me for help with this -- I have never done it).
 </DL></DL>
 
 <P><LI>Install FINK
 <DL><DL><I>
-This software can be downloaded from 
+To do this, you will need to install the Development Tools, 
+which are distributed with OS X as well as the FINK package, 
+which can be downloaded from 
 <a href="http://www.nist.gov/cgi-bin/exit_nist.cgi?url=
 http://fink.sourceforge.net/"
 >http://fink.sourceforge.net/
 </A>. Download the package and then double-click on it.
-</I>(Please do not contact me for help with this -- I have never done it).
+</I>
 </DL></DL>
 
@@ -62 +68 @@
 <P><LI>Download and install required packages.
 <DL><DL><I>
-GSAS requires a the "Portable Network Graphics" (libpng3) library. 
-EXPGUI requires the X11 (not Aqua) Tcl/Tk and BLT packages. 
-There is more than one way to install them. For example, you can use the 
-fink command to compile and install packages from source code. The
-easier way is to simply download binary versions. With FINK installed
-this is easy, use this command in a terminal or X11 xterm window:</I>
-<PRE>
-     sudo apt-get install tcltk blt libpng3-shlibs
-</PRE>
-(I am probably not the best person to provide help on this either.)
-</DL></DL>
-
-<P><LI>Download the GSAS & EXPGUI programs. 
-<DL><DL><I>
-Download this file from the NIST website:
-</I>
-<a href="ftp://ftp.ncnr.nist.gov/pub/cryst/gsas/osx_gsaskit.tar.gz">
-ftp://ftp.ncnr.nist.gov/pub/cryst/gsas/osx_gsaskit.tar.gz</a> (~7 Mb)
-<I>
-These files can also be downloaded from the CCP14 mirrors</I>
+GSAS requires the "Portable Network Graphics" (libpng3) library.
+EXPGUI requires the X11 (not Aqua) version of Tcl/Tk package;  
+installation of the BLT add-on for Tcl/Tk is needed for plotting 
+from EXPGUI (for example, <A Href="liveplot.html">LIVEPLOT</A>). 
+There are many ways to install this software. 
+One way is to type in <a href="#FinkAptGet">Fink (apt-get) commands, as 
+described below.</a>
+A more "Mac-appropriate" approach is to avoid use of the command line
+completely and with a user-friendly front-end, 
+<a href="#FinkCommander">FinkCommander, also described below.</a></I>
+</DL></DL>
+
+<P><LI>Download the GSAS & EXPGUI programs as a Mac disk image. 
+<DL><DL>
+<I>Download this file from the NIST website:</I>
+<BR>
+<a href="ftp://ftp.ncnr.nist.gov/pub/cryst/gsas/osx_gsaskit.dmg">
+ftp://ftp.ncnr.nist.gov/pub/cryst/gsas/osx_gsaskit.dmg</a> (~7 Mb)
+<BR>
+<I>These files can also be downloaded from the CCP14 mirrors:</I>
 [(<a href="http://www.nist.gov/cgi-bin/exit_nist.cgi?url=
-http://www.ccp14.ac.uk/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/osx_gsaskit.tar.gz"
+http://www.ccp14.ac.uk/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/osx_gsaskit.dmg"
 >UK</a>),   
 (<a href="http://www.nist.gov/cgi-bin/exit_nist.cgi?url=
-http://ccp14.sims.nrc.ca/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/osx_gsaskit.tar.gz"
+http://ccp14.sims.nrc.ca/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/osx_gsaskit.dmg"
 >Canada</a>), 
 (<a href="http://www.nist.gov/cgi-bin/exit_nist.cgi?
-url=http://ccp14.semo.edu/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/osx_gsaskit.tar.gz"
+url=http://ccp14.semo.edu/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/osx_gsaskit.dmg"
 >US</a>) or 
 (<a href="http://www.nist.gov/cgi-bin/exit_nist.cgi?url=
-http://ccp14.minerals.csiro.au/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/osx_gsaskit.tar.gz"
+http://ccp14.minerals.csiro.au/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/osx_gsaskit.dmg"
 >Australia</a>)].
 <P>
-<I>
-Note that if you have StuffIt installed, the compressed osx_gsaskit.tar.gz
-may be expanded to osx_gsaskit.tar and the contents (folder gsas) 
-may be created automatically. 
-In this case you can simply move this folder to the desired 
-location.</I>
-<P>
-<I>
-If you need to expand and extract the files from the tar.gz file "manually"
-you can do this in a terminal or X11 xterm window.
-Assuming that you downloaded the above file to your desktop and wish to install
-the files in directory </I>/Users/[me]/Programs/gsas<I>
-(where </I>[me]<I> is your username), you will use commands like this:
-</I>
-<PRE>
-     cd 
-     mkdir -p Programs/gsas
-     cd Programs
-     tar xvzf ~/Desktop/osx_gsaskit.tar.gz
-</PRE>
-If you wish to retrieve the files from the expanded osx_gsaskit.tar file, 
-replace the last command with this:
-<PRE>
-     tar xvf ~/Desktop/osx_gsaskit.tar
-</PRE>
-</DL></DL>
-
-<LI>Make shortcuts to run EXPGUI
-<DL><DL><I>
+
+<I>What happens when you download this file depends on your method for 
+downloading. Some browsers will automatically perform the next step for 
+you:</I>
+<P>
+Mount this file by double-clicking on it. This should create a new volume in 
+your top-level ("Computer") called "GSASvol"; clicking on this device will open
+a finder window with a single folder ("gsas") present. 
+<P>
+<I>While you can run GSAS & EXPGUI from this location, you are strongly 
+suggested to instead copy the entire package to your computer by dragging the 
+gsas folder icon to another finder window, or by clicking on it and using 
+Copy and Paste.</I>
+<P>
 At this point you are able to run EXPGUI using the full command name 
 from inside an X11 window -- by typing a command such as this:
+<PRE>
+     /MyApps/gsas/expgui/expgui
+</PRE>
+or
+<PRE>
+     /sw/bin/wish /MyApps/gsas/expgui/expgui
+</PRE>
+
+
+but this gets old fast -- see the following section for a better way. 
+</DL></DL>
+
+<LI>Install a "shortcut" to launch EXPGUI
+<DL><DL>
+<I>The following 
+instructions describe ways that the EXPGUI program can be integrated 
+into the Mac environment.
+</I><P>
+<IMG SRC="expgui_osx.jpg" ALT="EXPGUI AppleScript icon" ALIGN="RIGHT">
+The OSX version of GSAS & EXPGUI has an EXPGUI AppleScript application 
+in the "gsas" folder with the icon shown 
+to the right. This AppleScript will start X11, 
+if needed and then lauch EXPGUI. (If you have ideas for improving the script, 
+the code can be found in file expgui_applescript.txt.)
+The EXPGUI AppleScript can be used in three ways:
+<UL>
+<P><LI>Double-clicking on the icon will launch EXPGUI so that it starts 
+with the "file open" window in your home directory. This 
+window can then be used to navigate to 
+access/create experiments in other folders.
+<P><LI>Dropping one or more GSAS Experiment (.EXP) files onto the EXPGUI icon
+will cause the experiment files to be opened. If more than one file is dropped,
+each file will open in a separate EXPGUI session. 
+<P><LI>Dropping one or more folders onto the EXPGUI icon will cause EXPGUI to be 
+started with the "file open" window in that folder.
+</UL>
+<P>
+You may find it convenient to drag the EXPGUI icon to the dock, 
+for easy access.
+Note, that this <B><U>EXPGUI app will not 
+work correctly if copied or moved to another folder</U></B> -- instead 
+create an alias (for example using the Finder Command-L key). An alias 
+can be moved where desired -- for example, to 
+the desktop or to the Application folder.
+</DL></DL>
+
+<LI>Make a command-line "shortcut" to run EXPGUI
+<DL><DL>
+<I>
+If you are a "Unix enthusiast," you might be interested in setting up 
+command line short-cuts to the gsas script and the EXPGUI program; however,
+my presumption is that most people buy Mac's to avoid using the command line. 
+Those people who wish to define a command line short-cut should 
+see section 2.2 in the 
+<A Href="expgui_Unix_readme.html">Unix installation notes</A>.
 </I>
-<PRE>
-     /Users/[me]/Programs/gsas/expgui/expgui
-</PRE>
-<I>
-but this gets old fast. Here are some different approaches that can be used
-to make EXPGUI easier to run:
-</I>
-</DL></DL>
-<UL>
-<P><LI><B>Create alias commands</B>
-<DL><DL>
-<P><I>Do this by placing alias commands into your ~/.cshrc file:</I>
-<PRE>
-   alias expgui      /sw/bin/wish /Applications/gsas/expgui/expgui
-   alias gsas        /Applications/gsas/gsas
-</PRE>
-(where /Applications is the location where you have installed GSAS.)
-<I>The above applies to users of the csh & tcsh shells. (You can find what 
-shell you use by typing</I>
-<PRE>     echo $SHELL</PRE>
-<I>If you use bash, etc., you will put the commands in 
-your ~/.profile file and the syntax is this:</I>
-<PRE>
-   alias expgui='/sw/bin/wish /Applications/gsas/expgui/expgui'
-   alias gsas='/Applications/gsas/gsas'
-</PRE>
-<P>
-<I>When this is done, restart X11 and from an X11 window you can type </I>
-<PRE>    gsas</PRE> or 
-<PRE>    expgui</pre> 
-<I>Note that this will also work:</I>
-<PRE>    expgui EXPFILE.EXP</pre>
-
-</DL></DL>
-<a name="AppleScript">
-</a><P><LI><B>Create an AppleScript to run EXPGUI</B>
-<DL><DL>
-<IMG SRC="osx1.jpg" ALT="EXPGUI menu" ALIGN="RIGHT">
-When run in OS X, a special menu appears in the EXPGUI file menu, 
-"Create AppleScript," as shown to the right. When this is selected,
-you are asked to select a default starting directory for EXPGUI (this 
-is for convenience; you can move to and work with .EXP files located 
-in any directory.) You also select a directory and file name to save 
-the script. Note that the default for this, ~/Library/Scripts/EXPGUI.scpt, 
-will place the script in your "Script Menu" (see 
-<a href="http://www.nist.gov/cgi-bin/exit_nist.cgi?url=
-http://www.apple.com/applescript/scriptmenu/">
-http://www.apple.com/applescript/scriptmenu</A>).
-<BR CLEAR="ALL">
-</DL></DL>
-
-<a name="CompileAppleScript">
-<P><LI><B>Create an Applet/Droplet to run EXPGUI</B>
-<DL><DL>
-If you double-click on the EXPGUI AppleScript, created above, you 
-will open it in the Script Editor, where you can convert it from
-a "Compiled Script" to a "Application". This application can then be 
-used to start EXPGUI if doubled-clicked in a Finder window or on the desktop.
-You can also drag experiment (.EXP) files onto the icon to launch EXPGUI on 
-those files (if you drag more than one .EXP file, an EXPGUI window is opened 
-for each file -- use with care if you are short on memory).
-<P>
-To create an application from within the Script Editor, use the 
-"File/Save As" menu option and be sure to select "Application" as the Format,
-as is shown below. I suggest that you also select the 
-"Never Show Startup Screen" option, as is also shown below. 
-You can call the file anything, although EXPGUI makes a 
-certain amount of sense. You can put this file anywhere you choose, 
-but either placing it on the dock or desktop makes a lot of sense.
-<P>
-</DL></DL>
-<IMG SRC="osx2.jpg" ALT="Script Editor save as options" ALIGN="TEXTTOP">
-<DL><DL>
-<P>
-To change the icon, you can to the following:
-<UL>
-<IMG SRC="expgui.jpg" ALIGN=RIGHT ALT="Sample 128x128 EXPGUI icon">
-<LI>copy into the clipboard whatever image you would like to use, 
-such as the image to the right, which can also be 
-found as file .../gsas/expgui.icns. (I am hoping 
-that someone with more talent can contribute something better.)
-<LI>Control-click on the EXPGUI app file
-<LI>Click on the tiny icon under the word "general"
-<LI>Paste the picture from the clipboard (Edit/Paste or Apple-V)
-<BR CLEAR="ALL">
-</UL>
-</DL></DL>
-
-
-<P>
-<B>Open questions:</B> I am far from a Mac expert. Several problems 
-I would like to solve are: 
-<OL>
-<LI>Is there a way to create an application, as opposed to a compiled script,
-directly from an AppleScript, so I can do this for the user?
-<LI>Can I associate an icon with an app/script from within an AppleScript 
-(so I can do it automatically)? 
-<LI>Are there other (better?) ways to integrate AppleScripts into 
-OS X for easy use.
+</DL></DL>
+
 </OL>
-If you have any advice, please send it my way.
-</OL>
-
-<HR><HR>
+
+<HR noshade><HR noshade>
+<h4>EXPGUI Enhancements specific to the Mac</H4>
+
+EXPGUI will automatically designate the EXPGUI AppleScript 
+as the "open with" application for every GSAS experiment (.EXP) file 
+that is read or written by EXPGUI, provided that the Development Tools program 
+Rez is found in /Developer/Tools. 
+At the same, EXPGUI will also designate an icon for the .EXP file. 
+After this is done, EXPGUI can be invoked by simply double-clicking on 
+a GSAS experiment file.
+<P>
+If for some reason you would prefer this not be done 
+(I would be interested to hear why) -- deselect the 
+"Assign app to .EXP files" checkbox in the Options menu.
+
+<HR noshade><HR noshade>
 <h4>Mac ideosyncracies</H4>
 <P>
-Unlike the Windows & Unix ports, Mac windows may not be updated
-until you click on them. This is seems to be the case for PGPLOT 
-windows (in POWPLOT, RAWPLOT,...) after the first plot. After typing the 
-command to update the graph, click on the window bar and the plot will 
+Unlike in the Windows & Unix versions of GSAS, Mac windows may not be updated
+until they are brought to the top of the screen by clicking on them
+(given focus). This is most noticible for PGPLOT 
+graphics (in POWPLOT, RAWPLOT,...). 
+When you type graphics commands in a terminal window, the plot does not 
+appear to change. However, click on the PGPLOT's window bar and the plot will 
 update.
-<HR><HR>
+
+<HR noshade><HR noshade>
+<a name="FinkAptGet"></a><h4>Installing software from the command line</H4>
+With FINK installed, it is possible to download and install binary
+versions of the required programs by entering the following command 
+in a terminal or xterm window:</I>
+<PRE>
+     sudo apt-get install tcltk blt libpng3-shlibs
+</PRE>
+
+<HR noshade><HR noshade>
+
+<a name="FinkCommander"></a><h4>Installing software using FinkCommander</H4>
+  <p><em>A second method, which is recommended for everyone other than UNIX
+        gurus, is to use instead the &quot;FinkCommander&quot; application,
+        which is provided in a separate directory
+    (of the same name: see picture below). After installing the fink package
+        (&quot;Fink... Installer.pkg&quot;),
+     launch &quot;FinkCommander&quot;. &quot;FinkCommander&quot; 
+     which is a 
+     GUI interface for fink (that allows you to avoid having to 
+     remember these ugly-, long-, obsure and esoteric
+     UNIX-styled commands)</em>
+  <p>
+    In &quot;FinkCommander&quot;, with your computer connected to the
+    internet, simply use &quot;Update-all&quot; 
+    (in the &quot;Source&quot; menu) 
+    the first time you run &quot;FinkCommander&quot;, 
+    then be patient while Fink tabulates a list of the latest versions of 
+    all available OS X software packages.
+
+  <p>Then, in the "binary" menu, select
+      the &quot;blt&quot; package and ask to install it 
+      (from a binary distribution) using the "install" command,
+      as shown in the picture below. 
+      Since FinkCommander will automatically load the packages required by 
+      blt (dependencies), this will also cause Tcl/Tk to be loaded or
+      updated.
+      <P>
+      Repeat this step to install the &quot;libpng3&quot; library.
+      <P>
+  <table width="75%" border="1">
+    <tr>
+      <td width="55%">
+      <a href="FinKComImage2.jpg" target="_blank">
+      <img src="FinKComImage2.jpg" width="400" height="300" border="0">
+      </a></td>
+      <td width="45%"><p>The &quot;FinkCommander&quot; folder on
+            the desktop (back window) and application (front window) showing
+         the installation of the binary
+            &quot;blt&quot; package.
+        <p>(click to enlarge)</p></td>
+    </tr>
+  </table>
+  <dt></dt>
+  <p><em>Depending on which version of OS X you have, and the 
+         versions of the available binary distributions, it is possible that 
+         the above may not work. If this occurs, 
+          simply repeat the process, but this time use the install command
+          from the source menu. 
+        The will achieve the same result, but will take much longer 
+        (say 15-45 minutes) as Fink will download and compile the source codes
+        for the various packages.</em>
+
+<HR noshade><HR noshade>
+
 <h4>Problems</H4>
 If you cannot get EXPGUI or the GSAS graphics programs to work, 
-you may have a setup problem with X-windows (X11). As an example, when I start
-a terminal window, there is no definition for the X11 display (this does
-work correctly by starting an xterm session in X11).
-A quick test is to type xclock at the prompt:
+you may have a setup problem with X-windows (X11). 
+One common reason for this is that X11 must be restarted any time 
+your computer's IP address changes. This can happen when you connect your 
+Mac to a network directly or with a modem. Your IP address can change even 
+while your computer is wired into a network. 
+
+If exiting and restarting X11 does not address your problem, 
+the following paragraphs
+may help you diagnose problems.
+<OL><LI>
+One possible problem is the definition for the X11 display (shell
+environment variable DISPLAY). 
+On my machine, this variable is set correctly in an X11 xterm window, but 
+is not set by default within an Aqua terminal window.
+<P>
+A quick test for this is to type xclock at the shell prompt:
 
 <PRE>
@@ -273 +314 @@
      [d120234:~] toby% setenv DISPLAY localhost:0.0
 </PRE>
-
+<P><LI>
+A second possible problem relates to the installation of the 
+Tcl/Tk and BLT packages. 
 You can test if Tcl/Tk and the BLT package are installed correctly using the 
 following commands:
@@ -288 +331 @@
 "pack [blt::graph .g]" command is entered, a set of x- and y-axes should appear
 in this window. The window should disappear after "exit" is typed.
+</OL>
 <P>
 <HR>
+<P>
+  The EXPGUI icon, the original version of the EXPGUI AppleScript 
+  and help with this documentation was provided by 
+  Francois Farges -- many thanks!
+
 <P>GSAS is Copyright, 1984-2000, by 
 the Regents of the University of California.
@@ -318 +367 @@
 </BODY>
 </HTML>
-