Changeset 41


Ignore:
Timestamp:
Dec 4, 2009 4:59:23 PM (11 years ago)
Author:
toby
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/expgui_cfg.html

    • Property rcs:date changed from 1999/01/20 21:33:38 to 1999/01/21 18:30:17
    • Property rcs:rev changed from 1.1 to 1.2
    • Property rcs:lines set to +168 -99
    r36 r41  
    1616significant reprogramming.
    1717<P>
    18 <H3>expgui</H3>
     18<H3>EXPGUI</H3>
    1919The main GUI is created by file expgui, which in turn uses the following files
    2020sequentially:
     
    3434The <TT>localconfig</TT> file also is read from this directory, if it exists.
    3535The final file, <TT>.gsas_config</TT>, is read from the user's login directory (UNIX) or <TT>C:\</TT> (Windows).
    36 No error occurs if either <TT>localconfig</TT> or <TT>.gsas_config</TT> is
    37 not present.
     36The <TT>localconfig</TT> and <TT>.gsas_config</TT> are intended to
     37contain system-wide and user-level default values for parameters
     38that are described in this document. Most routines have
     39a "Save Options" command that writes some of the current parameters to
     40file  <TT>.gsas_config</TT>. Note that information in <TT>.gsas_config</TT>
     41overrides that in <TT>localconfig</TT>.
     42No error occurs if either of these files are not found.
     43
    3844<P>
    3945The <TT>readexp.tcl</TT> and <TT>gsascmds.tcl</TT> files contain
     
    5056<TT>.gsas_config</TT> files.
    5157
    52 The variables in the <TT>gsasmenu.tcl</TT> are:
     58The important variables defined in the <TT>gsasmenu.tcl</TT> file are:
    5359<DL><DL>
    5460<DT>expgui(menunames)<DD>
     
    8692a small number of array for other configuration options. They are:
    8793<DL><DL>
    88 <DT>expgui(archive)<DD>
    89 set expgui(coordfont) "-*-courier-bold-r-normal--12-*"
    90 set expgui(histfont) "-*-courier-bold-r-normal--12-*"
    91 set liveplot(hst) 1
    92 set liveplot(legend) 1
    93 set expgui(filesort) 1
    94 set expgui(scriptdir) [file dirname $expgui(script) ]
    95 set expgui(gsasdir) [file dirname $expgui(scriptdir)]
    96 set expgui(gsasexe) [file join $expgui(gsasdir) exe]
    97 set expgui(asorttype) $expgui(asorttype)"
    98 set expgui(hsorttype) $expgui(hsorttype)"
    99 set expgui(filesort) $expgui(filesort)"
    100 set env(GSASBACKSPACE) $env(GSASBACKSPACE)"
    101 
    102 This determines where files menulist, cmdlist, helplist
    103 and buttonlist, as well as widplt and lstview are located.
    104 Rarely needs to be changed.
    105 <LI><B>gsasexe</B>:
     94
     95<DT>expgui(scriptdir)<DD>
     96This determines where files such as <TT>readexp.tcl</TT>, etc.
     97are located. This defaults to the location where <TT>expgui</TT> is located so
     98it rarely needs to be changed.
     99
     100<DT>expgui(gsasdir)<DD>
     101This contains the location of the GSAS directory, if it is not the
     102parent director where expgui is found.
     103This determines where a number of GSAS data files will be located. If expedt
     104crashes when you try to add new atoms, this is probably wrong.
     105
     106<DT>expgui(gsasexe)<DD>
    106107This determines where the GSAS executable files are located.
    107108You might want to change this is you keep multiple versions of GSAS
     
    109110the default or want to keep the tcl files somewhere other than
    110111in a subdirectory of the GSAS files.
    111 <LI><B>env(GSASEXE)</B>: This sets an environment variable which is
    112 probably not used.
    113 <LI><B>env(ATOMDATA)</B>: This sets an environment variable which
    114 defines the location of a data file (.../gsas/data/atomdata.dat)
    115 needed by EXPEDT and probably other programs.
    116 <LI><B>env(ATMXSECT)</B>: This sets an environment variable which
    117 defines the location of a data file (.../gsas/data/atmxsect.dat)
    118 needed by program FPRIME.
    119 <LI><B>env(LENPAGE)</B>: This sets an environment variable which defines
    120 the number of lines per page used in the .LST file. You may want to
    121 change this to match your favorite print format to save paper.
    122 <LI><B>env(PGPLOT_DIR)</B>: This sets an environment variable needed by the
    123 <A HREF="http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://astro.caltech.edu/~tjp/pgplot/" target=_top>PGPLOT</A>
    124 graphics library.
    125 <LI><B>env(GSASBACKSPACE)</B>: This determines if the default definition
     112
     113<DT>expgui(coordfont)<DD>
     114Sets the font used for the coordinates scroll box
     115
     116<DT>expgui(histfont)<DD>
     117Sets the font used for the histogram scroll box
     118
     119<DT>liveplot(hst)<DD>
     120Sets the default histogram used for liveplot
     121
     122<DT>liveplot(legend)<DD>
     123Sets the default value for display of the legend in liveplot
     124
     125</DL></DL>
     126
     127The following variables are written to <tt>.gsas_config</tt> when
     128"Save Options" is used. These variables are all set from the GUI and therefore
     129do not need to be edited manually.
     130
     131<DL><DL>
     132<DT>expgui(archive)<DD>
     133This defines the default state for the archive flag,
     134where 0 is off and 1 is on. When archive is on, a copy of the .EXP file
     135is saved before a new version of the file is saved and before EXPEDT is run.
     136
     137<DT>expgui(asorttype)<DD>
     138This determines the atom sort mode.
     139
     140<DT>expgui(hsorttype)<DD>
     141This determines the histogram sort mode.
     142
     143<DT>expgui(filesort)<DD>
     144This determines the file sorting mode for the expnam command.
     145
     146<DT>env(GSASBACKSPACE)<DD>
     147Used only for UNIX: This determines if the default definition
    126148for the backspace key is overridden; some UNIX systems need this so that
    127149expedt and other terminal-oriented programs work correctly and
    128 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
    129 set the variable to default as "off" use
    130 <PRE>
    131         setenv GSASBACKSPACE 0
    132 </PRE>
    133 in your <tt>~/.cshrc</tt> file or include
    134 <PRE>
    135         set env(GSASBACKSPACE) 0
    136 </PRE>
    137 in your <tt>~/.gsas_config</tt> or <tt>localconfig</tt> file.
    138 <LI><B>archive</B>: This defines the default state for the archive flag,
    139 where 0 is off and 1 is on. When archive is on, a copy of the .EXP file
    140 is saved as <expnam>.EXP.nnn and compressed before EXPEDT is run.
    141 <LI><B>compressprog</B>: This defines a compression program used to
    142 reduce the size of archived .EXP files.
    143 <LI><B>debug</B>: Setting debug to 1 turns on a number of annoying
    144 warning messages.
    145 </LI></UL>
    146 
    147 <H3>lstview</H3>
    148 The following options are available for customization
    149 <UL>
    150 <LI><B>txtvw(followcycle)</B>: This sets the initial value for the
     150other systems do not. You can toggle this option using the "sets an environment variable needed by the "Override Backspace" option on the file menu.
     151
     152</DL></DL>
     153
     154<HR><H3>LSTVIEW</H3>
     155The <TT>localconfig</TT> and <TT>.gsas_config</TT> files are read, if present.
     156The following options are available for customization in these files:
     157<DL><DL>
     158<DT>txtvw(menulength)<DD>
     159This limits the number of entries that can
     160exist in a menu. For example, the default is 25, so when more than 25 cycles
     161are found in a .LST file, only the last 25 are listed in the
     162"Go To"/cycle submenu.
     163<DT>txtvw(maxchars)<DD>
     164This limits the maximum number of
     165characters that will be read from an existing .LST file to speed
     166the start of the program. The default is ~1Mb
     167for UNIX systems and ~200K for Windows.
     168</DL></DL>
     169
     170The following variable is written to <tt>.gsas_config</tt> when
     171"Save Options" is used. These variable is set from the GUI and therefore
     172does not need to be edited manually.
     173
     174<DL><DL>
     175<DT>txtvw(followcycle)<DD>
     176This sets the initial value for the
    151177"Auto Advance" button in the "Go To" menu. When this is true,
    152178the program will show the last cycle in the file. As new cycles are
    153179added, the "view" is advanced.
    154 <LI><B>txtvw(menulength)</B>: This limits the number of entries that can
    155 exist in a menu. For example, the default is 25, so when more than 25 cycles
    156 are found in a .LST file, only the last 25 are listed in the
    157 "Go To"/cycle submenu.
    158 <LI><B>txtvw(maxchars)</B>: This limits the maximum number of
    159 characters that will be read from an existing .LST file to speed
    160 the start of the program. The default for txtvw(maxchars) is ~1Mb
    161 for UNIX systems and ~200K for Windows.
    162 </LI></UL>
    163 One additional variable is present that I don't suggest using:
     180</DL></DL>
     181
     182One additional variable is present that I don't suggest using at present:
    164183<UL>
    165 <LI><B>plotvars</B>: I am in the process of developing code that tracks
     184<LI>plotvars: I am in the process of developing code that tracks
    166185and plots shifts and R values as a function cycle number. Setting plotvars to 1
    167186allows this code to be tested.
    168187</LI></UL>
    169 <A NAME="notroot"></A>
    170 <H3>liveplot</H3>
    171 This program can be customized by overriding definitions for the
    172 following variables in file <tt> ~/.liveplotrc</tt>.
    173 <UL>
    174 <LI><B>graph(printout)</B>: This is set to 1 if PostScript files
    175 will be printed and 0 if they will be written to disk.
    176 <LI><B>graph(outname)</B>: This is the default for the file name used
     188
     189<hr><H3>LIVEPLOT</H3><A NAME="liveplot"></A>
     190The <TT>localconfig</TT> and <TT>.gsas_config</TT> files are read, if present.
     191<P>
     192The following options are available for customization in these files:
     193<DL><DL>
     194<DT>peakinfo(color<i>n</i>)<DD>
     195These variables define the default colors for
     196reflections in phase "<i>n</i>"
     197</DL></DL>
     198
     199The following variables are written to <tt>.gsas_config</tt> when
     200"Save Options" is used. These variables are all set from the GUI and therefore
     201do not need to be edited manually.
     202
     203<DL><DL>
     204<DT>graph(printout)<DD>
     205This is set to 1 if PostScript files
     206will be printed and 0 if they will be written to disk (for Windows all
     207files should be written to disk).
     208
     209<DT>graph(outname)<DD>
     210This is the default for the file name used
    177211when PostScript files will be written to disk.
    178 <LI><B>graph(outcmd)</B>: This is the default for the command used
    179 to print PostScript files.
    180 <LI><B>peakinfo(color</B><i>n</i><B>)</B>: These variables define the default colors for
    181 reflections in phase "<i>n</i>"
    182 </LI></UL>
    183 <P>
     212
     213<DT>graph(outcmd)<DD>
     214This is the default for the command used
     215to print PostScript files (Unix only).
     216
     217<DT>graph(legend)<DD>
     218Sets the default value for display of the legend in liveplot and widplt.
     219
     220</DL></DL>
     221
     222<P>
     223<B>Combining CMPR and EXPGUI.</B>
    184224If you have <A HREF="http://rrdjazz.nist.gov/~toby/cmpr.html">CMPR</A>
    185 installed on your computer, you can use superimpose on liveplot the peaks
    186 for an arbitrary unit cell with space group extinctions show, if desired.
    187 This is pretty neat! To enable this feature, you must have a version of the
    188 GSAS GUI routines downloaded after 4 May 1998 and have installed
     225installed on your computer, you can use superimpose on the GSAS results
     226the peaks for an arbitrary unit cell. If desired, space group extinctions
     227can even be shown.
     228This is pretty neat! To enable this feature, you must have a version
    189229a version of CMPR downloaded after 4 May 1998
    190230<A HREF="http://rrdjazz.nist.gov/~toby/cmpr.html">
    191231(see the CMPR installation instructions.)</A>
    192 Then create a link from in the GSAS GUI
     232For UNIX, create a link from in the expgui
    193233directory to file cellgen.tcl in the CMPR directory. For example:
    194234<PRE>
    195          ln -s /usr/local/cmpr/cellgen.tcl /usr/local/gsas/tcl/cellgen.tcl
    196 </PRE>
    197 
    198 <P>
     235         ln -s /usr/local/cmpr/cellgen.tcl /usr/local/gsas/expgui/cellgen.tcl
     236</PRE>
     237For Windows, copy all the CMPR .tcl and .exe files into the expgui directory.
     238<P>
     239<B>Combining LOGIC and EXPGUI.</B>
    199240If you have <A HREF="http://rrdjazz.nist.gov/~toby/logic.html">LOGIC</A>
    200 installed on your computer, you can use superimpose peaks
     241installed on your computer, you can superimpose peaks
    201242for a entry from the ICDD/JCPDS database on a pattern in LIVEPLOT.
    202243This is also pretty neat!
    203 To enable this feature, you must have a version of the
    204 GSAS GUI routines downloaded after 4 May 1998 and have installed
     244To enable this feature, you must have
    205245a version of LOGIC downloaded after 4 May 1998
    206246<A HREF="http://rrdjazz.nist.gov/~toby/logic.html">
    207247(see the LOGIC installation instructions.)</A>
    208 Then create a link from in the GSAS GUI
     248For UNIX, create a link from in the GSAS GUI
    209249directory to file icddcmd.tcl in the LOGIC directory. For example:
    210250<PRE>
    211251         ln -s /usr/local/powdersuite/icddcmd.tcl /usr/local/gsas/tcl/icddcmd.tcl
    212252</PRE>
    213 
    214 <H3>widplt</H3>
     253For Windows, copy all the LOGIC files into the expgui directory.
     254<HR>
     255<H3>WIDPLT</H3>
    215256The widplt script is used to display the FWHM for one or more histograms
    216 from a .EXP file. It is often convenient to add for reference the expected
     257from a .EXP file.
     258At this point it only works for CW data.
     259It is often convenient to add for reference the expected
    217260instrumental curves as options to the menu. This can be done by creating a
    218261file called widplot_<i>name</i>. For example, renaming the
     
    234277</PRE>
    235278Array element UVWP(item) contains the (Gaussian) GU, GV, GW and GP values,
    236 while XY(item) contains the (Lorentzian) LX and Ly terms. Array element
     279while XY(item) contains the (Lorentzian) LX and LY terms. Array element
    237280wave(item) contains a wavelength, array element lblarr(item) contains
    238281the text to be shown on the "Plot Contents" menu and ttrange(item)
    239282defines the range the function is valid.
    240283<P>
    241 Note that this script will
    242 probably need some work to be used with TOF diffraction.
     284The following variables are written to <tt>.gsas_config</tt> when
     285"Save Options" is used. These variables are all set from the GUI and therefore
     286do not need to be edited manually.
     287
     288<DL><DL>
     289<DT>graph(printout)<DD>
     290This is set to 1 if PostScript files
     291will be printed and 0 if they will be written to disk (for Windows all
     292files should be written to disk).
     293
     294<DT>graph(outname)<DD>
     295This is the default for the file name used
     296when PostScript files will be written to disk.
     297
     298<DT>graph(outcmd)<DD>
     299This is the default for the command used
     300to print PostScript files (Unix only).
     301
     302<DT>graph(legend)<DD>
     303Sets the default value for display of the legend in liveplot and widplt.
     304
     305<DT>graph(plotunits)<DD>
     306Sets the units used for displaying the data. Values are "d", "q", "",
     307for d-space, Q and 2-theta, respectively.
     308<DT>graph(equivwave)<DD>
     309Sets the wavelength used for displaying data, if blank, no conversion is
     310done and data are shown in their original wavelength.
     311</DL></DL>
    243312
    244313<HR>GSAS is written by: Allen C. Larson and Robert B. Von Dreele MS-H805,
Note: See TracChangeset for help on using the changeset viewer.