Changeset 41 for trunk/doc/expgui_cfg.html

Timestamp:

Dec 4, 2009 4:59:23 PM (14 years ago)

Author:

toby

Message:

# on 1999/01/21 18:30:17, toby did:
1st draft done

File:

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

trunk/doc/expgui_cfg.html

@@ -16 +16 @@
 significant reprogramming. 
 <P>
-<H3>expgui</H3>
+<H3>EXPGUI</H3>
 The main GUI is created by file expgui, which in turn uses the following files
 sequentially:
@@ -34 +34 @@
 The <TT>localconfig</TT> file also is read from this directory, if it exists.
 The final file, <TT>.gsas_config</TT>, is read from the user's login directory (UNIX) or <TT>C:\</TT> (Windows). 
-No error occurs if either <TT>localconfig</TT> or <TT>.gsas_config</TT> is
-not present.
+The <TT>localconfig</TT> and <TT>.gsas_config</TT> are intended to 
+contain system-wide and user-level default values for parameters 
+that are described in this document. Most routines have 
+a "Save Options" command that writes some of the current parameters to 
+file  <TT>.gsas_config</TT>. Note that information in <TT>.gsas_config</TT>
+overrides that in <TT>localconfig</TT>.
+No error occurs if either of these files are not found.
+
 <P>
 The <TT>readexp.tcl</TT> and <TT>gsascmds.tcl</TT> files contain 
@@ -50 +56 @@
 <TT>.gsas_config</TT> files.
 
-The variables in the <TT>gsasmenu.tcl</TT> are:
+The important variables defined in the <TT>gsasmenu.tcl</TT> file are:
 <DL><DL>
 <DT>expgui(menunames)<DD>
@@ -86 +92 @@
 a small number of array for other configuration options. They are:
 <DL><DL>
-<DT>expgui(archive)<DD>
-set expgui(coordfont) "-*-courier-bold-r-normal--12-*"
-set expgui(histfont) "-*-courier-bold-r-normal--12-*"
-set liveplot(hst) 1
-set liveplot(legend) 1
-set expgui(filesort) 1
-set expgui(scriptdir) [file dirname $expgui(script) ]
-set expgui(gsasdir) [file dirname $expgui(scriptdir)]
-set expgui(gsasexe) [file join $expgui(gsasdir) exe]
-set expgui(asorttype) $expgui(asorttype)"
-set expgui(hsorttype) $expgui(hsorttype)"
-set expgui(filesort) $expgui(filesort)"
-set env(GSASBACKSPACE) $env(GSASBACKSPACE)"
-
-This determines where files menulist, cmdlist, helplist 
-and buttonlist, as well as widplt and lstview are located. 
-Rarely needs to be changed.
-<LI><B>gsasexe</B>:
+
+<DT>expgui(scriptdir)<DD>
+This determines where files such as <TT>readexp.tcl</TT>, etc.
+are located. This defaults to the location where <TT>expgui</TT> is located so
+it rarely needs to be changed.
+
+<DT>expgui(gsasdir)<DD>
+This contains the location of the GSAS directory, if it is not the
+parent director where expgui is found.
+This determines where a number of GSAS data files will be located. If expedt
+crashes when you try to add new atoms, this is probably wrong.
+
+<DT>expgui(gsasexe)<DD>
 This determines where the GSAS executable files are located.
 You might want to change this is you keep multiple versions of GSAS
@@ -109 +110 @@
 the default or want to keep the tcl files somewhere other than 
 in a subdirectory of the GSAS files.
-<LI><B>env(GSASEXE)</B>: This sets an environment variable which is 
-probably not used.
-<LI><B>env(ATOMDATA)</B>: This sets an environment variable which 
-defines the location of a data file (.../gsas/data/atomdata.dat)
-needed by EXPEDT and probably other programs.
-<LI><B>env(ATMXSECT)</B>: This sets an environment variable which 
-defines the location of a data file (.../gsas/data/atmxsect.dat)
-needed by program FPRIME.
-<LI><B>env(LENPAGE)</B>: This sets an environment variable which defines
-the number of lines per page used in the .LST file. You may want to 
-change this to match your favorite print format to save paper.
-<LI><B>env(PGPLOT_DIR)</B>: This sets an environment variable needed by the
-<A HREF="http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://astro.caltech.edu/~tjp/pgplot/" target=_top>PGPLOT</A> 
-graphics library.
-<LI><B>env(GSASBACKSPACE)</B>: This determines if the default definition
+
+<DT>expgui(coordfont)<DD>
+Sets the font used for the coordinates scroll box
+
+<DT>expgui(histfont)<DD>
+Sets the font used for the histogram scroll box
+
+<DT>liveplot(hst)<DD>
+Sets the default histogram used for liveplot
+
+<DT>liveplot(legend)<DD>
+Sets the default value for display of the legend in liveplot
+
+</DL></DL>
+
+The following variables are written to <tt>.gsas_config</tt> when 
+"Save Options" is used. These variables are all set from the GUI and therefore
+do not need to be edited manually. 
+
+<DL><DL>
+<DT>expgui(archive)<DD>
+This defines the default state for the archive flag, 
+where 0 is off and 1 is on. When archive is on, a copy of the .EXP file
+is saved before a new version of the file is saved and before EXPEDT is run.
+
+<DT>expgui(asorttype)<DD>
+This determines the atom sort mode.
+
+<DT>expgui(hsorttype)<DD>
+This determines the histogram sort mode.
+
+<DT>expgui(filesort)<DD>
+This determines the file sorting mode for the expnam command.
+
+<DT>env(GSASBACKSPACE)<DD>
+Used only for UNIX: This determines if the default definition
 for the backspace key is overridden; some UNIX systems need this so that 
 expedt and other terminal-oriented programs work correctly and 
-other systems do not. You can toggle this option using the "sets an environment variable needed by the "Override Backspace" option on the file menu. To 
-set the variable to default as "off" use 
-<PRE>
-        setenv GSASBACKSPACE 0
-</PRE>
-in your <tt>~/.cshrc</tt> file or include 
-<PRE>
-        set env(GSASBACKSPACE) 0
-</PRE>
-in your <tt>~/.gsas_config</tt> or <tt>localconfig</tt> file.
-<LI><B>archive</B>: This defines the default state for the archive flag, 
-where 0 is off and 1 is on. When archive is on, a copy of the .EXP file
-is saved as <expnam>.EXP.nnn and compressed before EXPEDT is run.
-<LI><B>compressprog</B>: This defines a compression program used to 
-reduce the size of archived .EXP files.
-<LI><B>debug</B>: Setting debug to 1 turns on a number of annoying 
-warning messages.
-</LI></UL>
-
-<H3>lstview</H3>
-The following options are available for customization
-<UL>
-<LI><B>txtvw(followcycle)</B>: This sets the initial value for the 
+other systems do not. You can toggle this option using the "sets an environment variable needed by the "Override Backspace" option on the file menu.
+
+</DL></DL>
+
+<HR><H3>LSTVIEW</H3>
+The <TT>localconfig</TT> and <TT>.gsas_config</TT> files are read, if present.
+The following options are available for customization in these files:
+<DL><DL>
+<DT>txtvw(menulength)<DD>
+This limits the number of entries that can
+exist in a menu. For example, the default is 25, so when more than 25 cycles
+are found in a .LST file, only the last 25 are listed in the 
+"Go To"/cycle submenu.
+<DT>txtvw(maxchars)<DD>
+This limits the maximum number of 
+characters that will be read from an existing .LST file to speed
+the start of the program. The default is ~1Mb 
+for UNIX systems and ~200K for Windows.
+</DL></DL>
+
+The following variable is written to <tt>.gsas_config</tt> when 
+"Save Options" is used. These variable is set from the GUI and therefore
+does not need to be edited manually. 
+
+<DL><DL>
+<DT>txtvw(followcycle)<DD>
+This sets the initial value for the 
 "Auto Advance" button in the "Go To" menu. When this is true,
 the program will show the last cycle in the file. As new cycles are
 added, the "view" is advanced.
-<LI><B>txtvw(menulength)</B>: This limits the number of entries that can
-exist in a menu. For example, the default is 25, so when more than 25 cycles
-are found in a .LST file, only the last 25 are listed in the 
-"Go To"/cycle submenu.
-<LI><B>txtvw(maxchars)</B>: This limits the maximum number of 
-characters that will be read from an existing .LST file to speed
-the start of the program. The default for txtvw(maxchars) is ~1Mb 
-for UNIX systems and ~200K for Windows.
-</LI></UL>
-One additional variable is present that I don't suggest using:
+</DL></DL>
+
+One additional variable is present that I don't suggest using at present:
 <UL>
-<LI><B>plotvars</B>: I am in the process of developing code that tracks 
+<LI>plotvars: I am in the process of developing code that tracks 
 and plots shifts and R values as a function cycle number. Setting plotvars to 1
 allows this code to be tested.
 </LI></UL>
-<A NAME="notroot"></A>
-<H3>liveplot</H3>
-This program can be customized by overriding definitions for the 
-following variables in file <tt> ~/.liveplotrc</tt>.
-<UL>
-<LI><B>graph(printout)</B>: This is set to 1 if PostScript files 
-will be printed and 0 if they will be written to disk.
-<LI><B>graph(outname)</B>: This is the default for the file name used
+
+<hr><H3>LIVEPLOT</H3><A NAME="liveplot"></A>
+The <TT>localconfig</TT> and <TT>.gsas_config</TT> files are read, if present.
+<P>
+The following options are available for customization in these files:
+<DL><DL>
+<DT>peakinfo(color<i>n</i>)<DD>
+These variables define the default colors for 
+reflections in phase "<i>n</i>"
+</DL></DL>
+
+The following variables are written to <tt>.gsas_config</tt> when 
+"Save Options" is used. These variables are all set from the GUI and therefore
+do not need to be edited manually. 
+
+<DL><DL>
+<DT>graph(printout)<DD>
+This is set to 1 if PostScript files 
+will be printed and 0 if they will be written to disk (for Windows all
+files should be written to disk).
+
+<DT>graph(outname)<DD>
+This is the default for the file name used
 when PostScript files will be written to disk.
-<LI><B>graph(outcmd)</B>: This is the default for the command used
-to print PostScript files. 
-<LI><B>peakinfo(color</B><i>n</i><B>)</B>: These variables define the default colors for 
-reflections in phase "<i>n</i>"
-</LI></UL>
-<P>
+
+<DT>graph(outcmd)<DD>
+This is the default for the command used
+to print PostScript files (Unix only). 
+
+<DT>graph(legend)<DD>
+Sets the default value for display of the legend in liveplot and widplt.
+
+</DL></DL>
+
+<P>
+<B>Combining CMPR and EXPGUI.</B>
 If you have <A HREF="http://rrdjazz.nist.gov/~toby/cmpr.html">CMPR</A>
-installed on your computer, you can use superimpose on liveplot the peaks
-for an arbitrary unit cell with space group extinctions show, if desired.
-This is pretty neat! To enable this feature, you must have a version of the
-GSAS GUI routines downloaded after 4 May 1998 and have installed 
+installed on your computer, you can use superimpose on the GSAS results 
+the peaks for an arbitrary unit cell. If desired, space group extinctions 
+can even be shown.
+This is pretty neat! To enable this feature, you must have a version 
 a version of CMPR downloaded after 4 May 1998 
 <A HREF="http://rrdjazz.nist.gov/~toby/cmpr.html">
 (see the CMPR installation instructions.)</A>
-Then create a link from in the GSAS GUI 
+For UNIX, create a link from in the expgui
 directory to file cellgen.tcl in the CMPR directory. For example:
 <PRE>
-         ln -s /usr/local/cmpr/cellgen.tcl /usr/local/gsas/tcl/cellgen.tcl 
-</PRE>
-
-<P>
+         ln -s /usr/local/cmpr/cellgen.tcl /usr/local/gsas/expgui/cellgen.tcl 
+</PRE>
+For Windows, copy all the CMPR .tcl and .exe files into the expgui directory.
+<P>
+<B>Combining LOGIC and EXPGUI.</B>
 If you have <A HREF="http://rrdjazz.nist.gov/~toby/logic.html">LOGIC</A>
-installed on your computer, you can use superimpose peaks
+installed on your computer, you can superimpose peaks
 for a entry from the ICDD/JCPDS database on a pattern in LIVEPLOT.
 This is also pretty neat! 
-To enable this feature, you must have a version of the
-GSAS GUI routines downloaded after 4 May 1998 and have installed 
+To enable this feature, you must have 
 a version of LOGIC downloaded after 4 May 1998 
 <A HREF="http://rrdjazz.nist.gov/~toby/logic.html">
 (see the LOGIC installation instructions.)</A>
-Then create a link from in the GSAS GUI 
+For UNIX, create a link from in the GSAS GUI 
 directory to file icddcmd.tcl in the LOGIC directory. For example:
 <PRE>
          ln -s /usr/local/powdersuite/icddcmd.tcl /usr/local/gsas/tcl/icddcmd.tcl 
 </PRE>
-
-<H3>widplt</H3>
+For Windows, copy all the LOGIC files into the expgui directory.
+<HR>
+<H3>WIDPLT</H3>
 The widplt script is used to display the FWHM for one or more histograms
-from a .EXP file. It is often convenient to add for reference the expected
+from a .EXP file. 
+At this point it only works for CW data.
+It is often convenient to add for reference the expected
 instrumental curves as options to the menu. This can be done by creating a
 file called widplot_<i>name</i>. For example, renaming the 
@@ -234 +277 @@
 </PRE>
 Array element UVWP(item) contains the (Gaussian) GU, GV, GW and GP values, 
-while XY(item) contains the (Lorentzian) LX and Ly terms. Array element 
+while XY(item) contains the (Lorentzian) LX and LY terms. Array element 
 wave(item) contains a wavelength, array element lblarr(item) contains
 the text to be shown on the "Plot Contents" menu and ttrange(item)
 defines the range the function is valid.
 <P>
-Note that this script will
-probably need some work to be used with TOF diffraction.
+The following variables are written to <tt>.gsas_config</tt> when 
+"Save Options" is used. These variables are all set from the GUI and therefore
+do not need to be edited manually. 
+
+<DL><DL>
+<DT>graph(printout)<DD>
+This is set to 1 if PostScript files 
+will be printed and 0 if they will be written to disk (for Windows all
+files should be written to disk).
+
+<DT>graph(outname)<DD>
+This is the default for the file name used
+when PostScript files will be written to disk.
+
+<DT>graph(outcmd)<DD>
+This is the default for the command used
+to print PostScript files (Unix only). 
+
+<DT>graph(legend)<DD>
+Sets the default value for display of the legend in liveplot and widplt.
+
+<DT>graph(plotunits)<DD>
+Sets the units used for displaying the data. Values are "d", "q", "", 
+for d-space, Q and 2-theta, respectively.
+<DT>graph(equivwave)<DD>
+Sets the wavelength used for displaying data, if blank, no conversion is
+done and data are shown in their original wavelength.
+</DL></DL>
 
 <HR>GSAS is written by: Allen C. Larson and Robert B. Von Dreele MS-H805,