source: trunk/doc/expgui_Unix_readme.html @ 930

Last change on this file since 930 was 930, checked in by toby, 11 years ago

rcs:* properties removed

  • Property svn:keywords set to Author Date Revision Id
File size: 16.0 KB
Line 
1<HTML>
2<HEAD>
3   <TITLE>UNIX Installation notes for EXPGUI</TITLE>
4   <meta name="keywords" content="crystallography, Rietveld, diffraction,
5   GSAS, EXPGUI, Windows">
6</HEAD>
7<style>
8A:link {text-decoration:none}
9A:vlink {text-decoration:none}
10</style>
11
12<BODY BGCOLOR="#FFFFFF"
13      topmargin="0" leftmargin="0" marginwidth="0" marginheight="0" 
14      text="#000000" link="#0033ff" vlink="#0033ff" alink="#0033ff">
15
16<?
17   include("/var/www/include/navigation.inc");
18   include("/var/www/include/utility.inc");
19?>
20<blockquote><font face="arial, helvetica, sans-serif">
21
22<TABLE BORDER BGCOLOR="#FFFF40" ALIGN=RIGHT>
23<TR><TH><A  Href="expgui.html">EXPGUI home</A> 
24</TH></TR></TABLE><BR CLEAR=ALL>
25
26<CENTER><H1>
27<HR noshade width="75%" size="2" align="center">
28Installing
29<A HREF="expgui.html">
30EXPGUI
31</A>
32on <BR>SGI & Linux Computers
33<HR noshade width="75%" size="2" align="center">
34</H1></CENTER>
35Note that root access is not required to load this GSAS/EXPGUI package.
36You may choose to do this work as root, so that the files may be installed
37a central location (such as <tt>/usr/local</tt>).
38
39<H2>1. Prerequisites</H2>
40
41Installation of GSAS & EXPGUI requires X windows, which is loaded with
42the operating system on virtually all Linux and SGI systems.
43It also requires only the shared libraries typically found on standard
44install configurations (tell me if I am wrong).
45The Linux version is compiled with g77 v2.96 on a Redhat 7.1 machine.
46It should be compatible with most modern versions of Linux.
47The SGI version has been compiled with f77 on a SGI running IRIX 6.5. It should
48be compatible with most recent versions of IRIX.
49<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">
50This GSAS & EXPGUI is now distributed with a version of Tcl/Tk,
51so installation of Tcl/Tk is no longer a prerequisite.
52
53<H2>2. Download the GSAS/EXPGUI Distribution</H2>
54<I>Make a note of where you download the file. In the following section
55it will be assumed the file was placed in</I> <tt>/tmp/</tt>.
56<DL>
57<DT>SGI:
58<DD>download file
59<A HREF="ftp://ftp.ncnr.nist.gov/pub/cryst/gsas/SGI_gsas+expgui.tar.gz">
60ftp://ftp.ncnr.nist.gov/pub/cryst/gsas/SGI_gsas+expgui.tar.gz</A> (~11 Mb)
61by shift-clicking on the previous link.
62(<I>Alternately this file can also be downloaded from the CCP14 mirrors in</I>
63<a href="
64http://www.ccp14.ac.uk/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/SGI_gsas+expgui.tar.gz"
65>UK</a>,
66
67<a href="
68http://ccp14.sims.nrc.ca/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/SGI_gsas+expgui.tar.gz"
69>Canada</a>,
70
71or
72
73<a href="
74http://ccp14.minerals.csiro.au/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/SGI_gsas+expgui.tar.gz"
75>Australia</a>).
76
77<DT>LINUX:
78<DD>download file
79<A HREF="ftp://ftp.ncnr.nist.gov/pub/cryst/gsas/LINUX_gsas+expgui.tar.gz">
80ftp://ftp.ncnr.nist.gov/pub/cryst/gsas/LINUX_gsas+expgui.tar.gz</A> (~10 Mb)
81by shift-clicking on the previous link.
82(<I>Alternately this file can also be downloaded from the CCP14 mirrors in</I>
83<a href="
84http://www.ccp14.ac.uk/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/LINUX_gsas+expgui.tar.gz"
85>UK</a>,
86(<a href="
87http://ccp14.sims.nrc.ca/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/LINUX_gsas+expgui.tar.gz"
88>Canada</a>,
89
90or
91
92<a href="
93http://ccp14.minerals.csiro.au/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/LINUX_gsas+expgui.tar.gz"
94>Australia</a>).
95
96</DL>
97
98<P>
99<H2>
1003. Unpack the distribution</H2>
101<I>In this step,
102it is assumed that you downloaded the distribution file in
103directory</I> <tt>/tmp/</tt>.
104
105<UL>
106<LI>Determine a directory where the software should be installed.
107<I>If you do not have root access, this will likely be in your
108own working area, typically</I> <tt>/usr/people/</tt>account
109<I>or</I> <tt>/home/</tt>account. Note that the files will be
110placed in a subdirectory named <tt>gsas</tt> in this location.
111<pre>
112      cd
113      mkdir Programs
114      cd Programs
115</Pre>
116or
117<pre>
118      cd /usr/local
119</Pre>
120
121<LI>Expand the files:
122<P><DL>
123<DT>SGI, use command
124<DD><PRE>gunzip < /tmp/SGI_gsas+expgui.tar.gz | tar xvf -</PRE>
125<DT>LINUX, use command
126<DD><PRE>tar xvzf /tmp/LINUX_gsas+expgui.tar.gz</PRE>
127</DL>
128</UL>
129
130<H2>
1314. Installing a shortcut to EXPGUI</H2>
132While it is possible to invoke EXPGUI by typing
133<FONT FACE="COURIER"><PRE>
134    /usr/local/gsas/tcltk84+ /usr/local/gsas/expgui/expgui
135</PRE></FONT>
136or
137<FONT FACE="COURIER"><PRE>
138   /home/toby/myprogs/gsas/tcltk84+ /home/toby/myprogs/gsas/expgui/expgui
139</PRE></FONT>
140(etc.) this would get old fast. Rather, you will likely want to
141create an easier command to type.
142Below are three ways to do this. Note that only one is needed. Do not use all
143three. You could also create a startbar or desktop icon that can be clicked
144to start EXPGUI.
145The way this is done depends on how your system is set up and cannot
146be described here.
147
148<em>Note that in the commands below, it is assumed that
149GSAS has been installed in <tt>/myprogs/gsas</tt>.
150Also, note that in the commands below,
151</em><FONT FACE="COURIER">^D</FONT><em> means control-D.</em>
152
153
154<UL><H4>
1554.1 Installing an alias for EXPGUI</H4>
156<P>
157One way to create a easy way to invoke EXPGUI is to add an alias to your
158default shell.
159First, determine what shell you are using. Type
160<PRE>
161    echo $SHELL
162</PRE>
163
164The response will likely be something like /usr/bin/bash (the bash shell) or
165/usr/bin/tcsh (the tcsh shell).
166<P>
167<DL>
168<DT>If you use tcsh or csh:
169<DD>to add an alias to your ~/.cshrc file, type these commands
170(change <tt>/myprogs</tt> as needed):
171<FONT FACE="COURIER"><PRE>
172         cat >> ~/.cshrc
173         alias expgui "/myprogs/gsas/tcltk84+ /myprogs/gsas/expgui/expgui"
174         ^D
175</PRE></FONT>
176
177<DT>If you use bash:
178<DD>to add an alias to your ~/.bash_profile, type these commands
179(change <tt>/myprogs</tt> as needed):
180<FONT FACE="COURIER"><PRE>
181         cat >> ~/.bash_profile
182         alias expgui="/myprogs/gsas/tcltk84+ /myprogs/gsas/expgui/expgui"
183         ^D
184</PRE></FONT>
185</DL>
186
187<H4>
1884.2 Installing EXPGUI in the path</H4>
189<P>
190Another way to simplify access to EXPGUI
191is to create a file that will invoke the GUI script.
192The file must be placed in a directory in your path and
193flagged as executable. You can examine the directories in your path by typing:
194<PRE>
195    echo $PATH
196</PRE>
197Also, check to see that you do not alreay have expgui command in your path
198by typing:
199<PRE>
200    which expgui
201</PRE>
202You should get a response "expgui not found in...". A response of
203<tt>/usr/bin/expgui</tt> tells you there is already a shortcut to expgui
204in that location. Either replace it or choose a name other than expgui.
205<P>
206The commands to create this executable file will be:
207<FONT FACE="COURIER"><PRE>
208        cat > /usr/bin/expgui
209        /myprogs/gsas/tcltk84+ /myprogs/gsas/expgui/expgui
210        ^D
211        chmod +x /usr/bin/expgui
212</PRE></FONT>
213(change <tt>/myprogs</tt> and <tt>/usr/bin</tt> as needed).
214
215<I>Note that this step (4.2) is incompatible with the one below (4.3).</I>
216<H4>
2174.3 Linking EXPGUI into the path</H4>
218<P>
219Another way to simplify access to EXPGUI
220is to create a link in your system's path to the GUI script.
221First, you will need to edit the 3rd line in the EXPGUI script from
222<PRE>
223      exec wish "$0" "$@"
224</PRE>
225to
226<PRE>
227      exec /myprogs/gsas/tcltk84+ "$0" "$@"
228</PRE>
229(change <tt>/myprogs</tt> as needed).
230Then you will create a link using:
231                ln -s /myprogs/gsas/expgui/expgui /usr/bin/expgui
232</PRE></FONT>
233<I>Note that this step (4.3) is incompatible with the one above (4.2).</I>
234</UL>
235
236<HR noshade><HR noshade>
237<H2>Updating to a new GSAS release</H2>
238<DL><DL>
239It is quite common that Bob Von Dreele will release an update to the
240GSAS programs more frequently than the combination gsas+expgui
241is updated. It is possible to update only the
242GSAS software.
243To determine the date of the GSAS package release,
244run a GSAS program, such as EXPEDT or SPACEGRP and note the
245date where it says "Distributed on ..."
246To update,
247first determine where you have installed the GSAS/EXPGUI software
248(<tt>/myprogs</tt> in the previous example).
249You will want to install the GSAS distribution to the <tt>gsas</tt> 
250subdirectory in that location.
251Then download the latest GSAS release from CCP14:
252<DL>
253<DT>UK:<DD>
254<A HREF="http://www.ccp14.ac.uk/ccp/ccp14/ftp-mirror/gsas/public/gsas/">
255http://www.ccp14.ac.uk/ccp/ccp14/ftp-mirror/gsas/public/gsas/</A>
256<BR>or<BR>
257<A HREF="
258ftp://ftp.ccp14.ac.uk/ccp14/ftp-mirror/gsas/public/gsas/">ftp://ftp.ccp14.ac.uk/ccp14/ftp-mirror/gsas/public/gsas/</A>
259
260<DT>Canada:<DD>
261<A HREF="http://ccp14.sims.nrc.ca/ccp/ccp14/ftp-mirror/gsas/public/gsas/">http://ccp14.sims.nrc.ca/ccp/ccp14/ftp-mirror/gsas/public/gsas/</A>
262
263<DT>Australia:<DD>
264<A HREF="
265http://ccp14.minerals.csiro.au/ccp/ccp14/ftp-mirror/gsas/public/gsas/">
266http://ccp14.minerals.csiro.au/ccp/ccp14/ftp-mirror/gsas/public/gsas/</A>
267</DL>
268<P>Select and download the appropriate gsaskit.tar.gz (making sure that the
269listing date is significantly later than the distribution date
270you currently have).
271Then use commands like this:
272
273<P><DL>
274<DT>SGI, use command
275<DD><PRE>
276cd /myprogs/gsas
277gunzip < /tmp/gsaskit.tar.gz | tar xvf -</PRE>
278<DT>LINUX, use command
279<DD><PRE>
280cd /myprogs/gsas
281tar xvzf /tmp/gsaskit.tar.gz</PRE>
282</DL>
283<P>
284Finally, check that GSAS has indeed been updated by
285again running a GSAS program, such as EXPEDT or SPACEGRP and noting the
286date where it says "Distributed on ..."
287</DL></DL>
288
289<H2>Updating to a new EXPGUI release</H2>
290<DL><DL>
291It is also common that new features will be added to EXPGUI or
292bug fixes will be made without an update to the
293combination gsas+expgui
294package.
295The absolute latest release (which may not have gotten
296a lot of testing)
297is distributed as
298<A HREF="ftp://ftp.ncnr.nist.gov/pub/cryst/gsas/expgui_ALPHA.tar.gz">
299ftp://ftp.ncnr.nist.gov/pub/cryst/gsas/expgui_ALPHA.tar.gz</A>.
300You can find the number of the latest alpha release by looking at file
301<A Href="http://www.ncnr.nist.gov/xtal/software/expgui/alpha/wishlist.html">
302http://www.ncnr.nist.gov/xtal/software/expgui/alpha/wishlist.html</A>
303<P>
304To update,
305first determine where you have installed the GSAS/EXPGUI software
306(<tt>/myprogs</tt> in the previous example).
307You will want to install the GSAS distribution to the <tt>gsas/expgui</tt> 
308subdirectory in that location.
309Second, note the EXPGUI package date, by
310using the Help/About menu command in EXPGUI.
311You then want to download this file:
312<DL>
313<A HREF="ftp://ftp.ncnr.nist.gov/pub/cryst/gsas/expgui_ALPHA.tar.gz">
314ftp://ftp.ncnr.nist.gov/pub/cryst/gsas/expgui_ALPHA.tar.gz</A>
315<BR>
316(for mirrors, select file expgui_ALPHA.tar.gz from CCP14 sites in
317<A HREF="
318http://www.ccp14.ac.uk/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/">
319the UK</A>,
320
321<A HREF="http://ccp14.sims.nrc.ca/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/">
322Canada</A>, or
323
324<A HREF="
325http://ccp14.minerals.csiro.au/ccp/ccp14/ftp-mirror/briantoby/pub/cryst/gsas/">
326Australia</A>.)
327</DL><P>
328and unpack it to subdirectory <tt>.../gsas/expgui/</tt>
329using commands like this:
330
331<P><DL>
332<DT>SGI:
333<DD><PRE>
334cd /myprogs/gsas/expgui
335gunzip < /tmp/expgui_ALPHA.tar.gz | tar xvf -</PRE>
336<DT>LINUX:
337<DD><PRE>
338cd /myprogs/gsas/expgui
339tar xvzf /tmp/expgui_ALPHA.tar.gz</PRE>
340</DL>
341</DL></DL>
342
343<P>
344<H2>
345<a name="NoRPM"></a><H2>
346RPMs for GSAS/EXPGUI are not being updated</H2>
347I am no longer preparing an RPM distribution for GSAS & EXPGUI. This
348is because it was getting increasingly hard to find RPM distributions
349for Tcl/Tk and BLT. If one has to install & build these packages from
350source code, then one must also override the RPM package tracking
351system to install the GSAS & EXPGUI RPM.
352The current method, which includes the entire Tcl/Tk package is
353easier to deal with.
354<P>
355<h2>The Tcl/Tk Starkit</H2>
356<P>
357The GSAS-EXPGUI distribution now includes a single file version of the
358entire Tcl/Tk package, as well as a graphics package for Tcl/Tk, called
359BLT, that is used extensively within EXPGUI. The inclusion of this file
360within the package simplifies installation considerably.
361This file,
362<tt>tcltk84+</tt>, contains many other Tcl/Tk packages (that are
363not used within EXPGUI), but may be of value for use with other applications.
364
365<a name="testtcltk"></a><H2>
366Using other versions of Tcl/Tk</H2>
367If you have another version of Tcl/Tk installed on your computer,
368it must also have the BLT package installed and configured properly.
369To confirm this
370software is installed and working correctly on your system
371try the following commands. (Commands you type are in this <font face="courier">typewriter</font> 
372font, computer responses are this <font face="courier"><I>italic font</I></font>.
373My comments are provided in this text font and are <U>underlined</U>).
374<UL>
375<TABLE>
376<TR><TD width="50%"><font face="courier">[tammy@beryl]$ wish</font></TD>
377<TD><U>(note a window is created)</U></TD></TR>
378<TR><TD><font face="courier"><I>%</I> set tcl_version</font></TD></TR>
379<TR><TD><font face="courier"><I>8.0</I></font></TD>
380<TD><U>(8.0 is the Tcl/Tk version number. EXPGUI requires 8.0 or higher)</U></TD></TR>
381<TR><TD><font face="courier"><I>%</I> package require BLT</font></TD></TR>
382<TR><TD><font face="courier"><I>2.4</I></font></TD>
383<TD><U>(2.4 is the BLT package version number.
384EXPGUI requires 2.3 or higher.
385If you get "can't find package BLT" then
386BLT is not installed [properly] on your system)</U></TD></TR>
387<TR><TD><font face="courier"><I>%</I> blt::graph .g</font></TD></TR>
388<TR><TD><font face="courier"><I>.g</I></font></TD>
389<TD><U>(nothing happens. You should not get an error message here.)</U></TD></TR>
390<TR><TD><font face="courier"><I>%</I> pack .g</font></TD>
391<TD><U>(now a graph is displayed)</U></TD></TR>
392<TR><TD><font face="courier"><I>%</I> Blt_ZoomStack .g</font></TD>
393<TD><U>(if error message: invalid command name "Blt_ZoomStack" appears
394there is a problem with your BLT installation, see below.)</U></TD></TR>
395</TABLE>
396There is a common problem with the pkg_Index.tcl file in older
397versions BLT that makes
398the Blt_ZoomStack command inaccessible, see my updated copy
399<A HREF="ftp://ftp.ncnr.nist.gov/pub/cryst/tcltk/BLT2.4_pkgIndex.tcl">
400ftp://ftp.ncnr.nist.gov/pub/cryst/tcltk/BLT2.4_pkgIndex.tcl
401</A> for an example that works. Also see the
402<A HREF="http://www.ncnr.nist.gov/programs/crystallography/software/tclpkgs82linux.html">
403Compiling Tcl/Tk 8.2.3 & packages for Linux</A> example of how to install.
404</UL>
405<P>
406<HR noshade><HR noshade>
407<P><H2>
408Acknowledgements</H2>
409<P>Thanks to Paul Kienzle of the
410<a href="http://www.ncnr.nist.gov/dave/">
411NCNR DAVE project</A> for providing the "all in one file" (starkit)
412version of Tcl/Tk for SGI and Linux.
413<P>
414<A Href="http://www.ncnr.nist.gov/programs/crystallography/software/gsas.html">
415GSAS</A>
416is written by Allen C. Larson and
417Robert B. Von Dreele while at Los Alamos National Laboratory.
418Problems, questions
419or kudos concerning GSAS should be sent to Robert B. Von Dreele at
420<A HREF="MAILTO:vondreele@anl.gov">vondreele@anl.gov</A>
421
422<P>EXPGUI was written by Brian H. Toby while at the NIST Center for Neutron Research,
423<A HREF="MAILTO:Brian.Toby@ANL.GOV">Brian.Toby@ANL.GOV</A> 
424with help from Jonathan Wasserman.
425<P>
426<hr><blockquote>
427GSAS is Copyright, 1984-1997, The Regents of the University of California.
428The GSAS software was produced under a U.S. Government contract (W-7405-ENG-36)
429by the Los Alamos National Laboratory, which is operated by the University
430of California for the U.S. Department of Energy. The U.S. Government is
431licensed to use, reproduce, and distribute this software. Permission is
432granted to the public to copy and use this software without charge, provided
433that this notice and any statement of authorship are reproduced on all
434copies. Neither the Government nor the University makes any warranty, express
435or implied, or assumes any liability or responsibility for the use of this
436software.
437
438<P>EXPGUI is not subject to copyright. Have fun with it.
439
440<p>Neither the U.S. Government nor any author makes any warranty,
441expressed or implied, or assumes any liability or responsibility
442for the use of this information or the software described
443here. Brand names cited here are used for
444identification purposes and do not consitute an endorsement by NIST.
445</blockquote>
446<hr>
447<TABLE BORDER BGCOLOR="#FFFF40" ALIGN=RIGHT>
448<TR><TH><A  Href="expgui.html">EXPGUI home</A> 
449</TH></TR></TABLE>
450
451<P>
452<font size=-1><? lastmod(); ?> </font>
453<br>
454$Revision: 930 $ $Date: 2009-12-04 23:14:35 +0000 (Fri, 04 Dec 2009) $
455</blockquote>
456</body>
457</html>
Note: See TracBrowser for help on using the repository browser.