source: trunk/doc/expgui_Unix_readme.html

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

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