Changeset 364


Ignore:
Timestamp:
Dec 4, 2009 5:04:56 PM (11 years ago)
Author:
toby
Message:

# on 2000/12/22 21:14:32, toby did:
document error highlighting
new section on invocation of GSAS programs
new tcl section
minor other changes

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/expgui.html

    • Property rcs:date changed from 2000/10/18 00:11:17 to 2000/12/22 21:14:32
    • Property rcs:lines changed from +94 -17 to +136 -48
    • Property rcs:rev changed from 1.15 to 1.16
    r329 r364  
    4141GSAS package such as EXPEDT, GENLES, FOURIER...
    4242These programs can be run from a menu or in many cases by pressing buttons.
    43 
     43EXPGUI is written using the
     44<A href="#tcltk">Tcl/Tk</A> scripting language.
    4445<P>
    4546This documentation describes the different actions that
     
    6768<DL><DL>
    6869When an experiment (.EXP) file is read, a copy is made in local
    69 computer memory. The values in memory can then be edited
    70 by selecting different
    71 panes ("pages" or "panels") from the tabbed list, where
    72 each pane is reserved for a different section of the .EXP file.
    73 The changes values are written back out to the .EXP file when the
    74 "File/Save" or "File/Save as" <A Href="expguic.html#1">menu bar options</A>
    75 are used. The .EXP file is also automatically written before running any GSAS
    76 programs, such as GENLES or EXPEDT.
    77 
     70computer memory. In most cases, values are changed in this
     71"in memory" copy of the experiment file
     72as this information is changed by the user on the screen.
     73<img SRC="rederror.gif" align=LEFT BORDER=3 alt="EXPGUI Screen snapshot">
     74<IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">
     75If there is an error in the typed value, (for example if "1..0" is typed, or
     76"1.5" is typed where an integer is expected), these values are
     77not saved. In this case, the text is turned red, to indicate
     78that an error is present, as shown in the figure to the left, where "90.000x"
     79has been entered for alpha.
     80The edited version of the experiment file is written back out to
     81disk when the "File/Save" or "File/Save as"
     82<A Href="expguic.html#1">menu bar options</A>
     83are used. The File/Save operation is done automatically before any GSAS
     84programs, such as GENLES or EXPEDT, are run.
     85<P>
     86
     87Since the GSAS experiment file is quite complex,
     88values are grouped together by function, approximately
     89following the outline of the EXPEDT program.
     90Each set of values is given a
     91"tabbed pane" on a window that has the appearance of a notebook (see below).
    7892<center><B>
    7993<br>The notebook pane tabs.
    8094<br><img SRC="panebar1.gif"  BORDER=3 alt="EXPGUI Screen snapshot">
    8195</center></B>
    82 More information about each pane can be found using the links below.
     96In some cases, where values are
     97too numerious or complex to fit onto the notebook pane, one or more buttons
     98may be present on a pane that will create a separate window,
     99where the associated values can be modified.
     100These values are not recorded in the
     101"in memory" copy of the experiment file unless the "Save" button on this window
     102is pressed. If "Cancel" is pressed, no changes are made.
     103Each notebook pane is listed below with a link to the web page documenting
     104that pane.
    83105
    84106<A Href="expgui1.html">
     
    97119<h3>A.7 Preferential Orientation Pane</h3>
    98120</A>
    99 <P>
    100 <img SRC="rederror.gif" align=LEFT BORDER=3 alt="EXPGUI Screen snapshot">
    101 <IMG SRC="new.gif" HEIGHT=13 WIDTH=36 alt="New!">
    102 Values changed in the entry boxes in these panes are
    103 immediately transferred to the "in memory" copy of the .EXP file, unless
    104 there is an error in the typed value, (for example if "1..0" is typed, or
    105 "1.5" is typed where an integer is expected.) When a value is invalid, it is
    106 not saved. In this case, the text is turned red, to indicate
    107 that an error is present, as shown in the figure to the left, where "90.000x"
    108 has been entered for alpha.
    109121<br clear=all>
    110122</DL></DL>
     
    179191</center></B>
    180192
     193<h3>Invoking of GSAS programs</h3>
     194When GSAS programs are invoked, in most cases EXPGUI is suspended while
     195the GSAS program is run in a terminal (or DOS) window. When the terminal
     196window is closed, EXPGUI is restarted. If desired (see the
     197<A Href="expguic.html#Autoicon">
     198"Iconify during GSAS"</A>
     199option) while this occurs, EXPGUI can be made into an icon
     200to save screen space.
     201<P>
     202<img src="powpref4a.gif" align=left>
     203Once the GSAS program has finished, if the program has modified
     204the .EXP file,
     205<a Href="expguierr.html#Overwrite">
     206"File has been modified..."</a>message box
     207similar to the one to the left is displayed (also see the more complete
     208discussion on the <a Href="expguierr.html#Overwrite">messages page</A>.
     209Note that this message can be avoided if the
     210<A Href="expguic.html#Autoupdate">
     211"Autoload EXP"</A>
     212option is used.
     213<BR clear=all>
     214<P>
     215Note that in both Windows-95 and Windows-NT, a file named <tt>EXPGUI.LCK</tt>
     216is created while the GSAS program runs. The presence of this file is used
     217to suspend the LIVEPLOT program, since LIVEPLOT has sometimes crashed
     218when run at the same time as GENLES (no such problem has been seen in Unix).
     219This file is deleted when the GSAS program completes.
     220<P>
     221<img src="lock.gif" align=left>
     222In Windows-9x, the <a Href="expgui_Win_readme.html#Winexec">Winexec</a>
     223package is used to execute a command that creates a DOS window.
     224The GSAS programs are then run by a batch file in this DOS window.
     225Due to limitations in Tcl/Tk & Windows, the DOS window runs independently
     226of EXPGUI, so the lock file (<tt>EXPGUI.LCK</tt>) is also used to suspend
     227EXPGUI. While EXPGUI is waiting, the
     228<a Href="expguierr.html#lock">
     229Please wait...
     230</a>
     231window shown to the left is displayed. When the GSAS program completes, the
     232lock file is deleted, the window automatically disappears and EXPGUI resumes.
     233Should a problem arise where the file is not deleted, EXPGUI can be resumed by
     234pressing the "Continue" button.
     235
     236<BR clear=all>
     237<h3>GSAS menus</h3>
     238
    181239A description of the EXPGUI menus follows. Use the links to obtain
    182240more information, including a very
     
    255313
    256314<br clear=all>
    257 <H3>LSTVIEW</H3>
     315<H3>D.1 LSTVIEW</H3>
    258316
    259317<DL><DL>
     
    264322
    265323<br clear=all>
    266 <H3>LIVEPLOT</H3>
     324<H3>D.2 LIVEPLOT</H3>
    267325<DL><DL>
    268326liveplot shows the observed, calculated and difference plots for powder
     
    289347
    290348<br clear=all>
    291 <H3>WIDPLT</H3>
     349<H3>D.3 WIDPLT</H3>
    292350<DL><DL>
    293351WIDPLT can be used to plot the actual peak widths generated by the profile
     
    301359<br clear=all>
    302360<a name="ConvertUnix"></a>
    303 <h3>Unix File Conversions</h3>
    304 <DL><DL>
    305 In UNIX, GSAS data, experiment and instrument parameter files are expected to
     361<h3>D.4 File Conversions</h3>
     362<DL><DL>
     363<B>In UNIX</B>,
     364GSAS data, experiment and instrument parameter files are expected to
    306365have a format with exactly 80 characters per line and no line
    307366separators (no carriage returns or linefeeds). Files in this format
     
    315374direct access for use in GSAS or to convert direct access files to
    316375sequential, for use in standard UNIX programs, such as editors or e-mail.
    317 </DL></DL>
    318 
    319 <br clear=all>
     376<P>
    320377<a name="ConvertWin"></a>
    321 <h3>Windows File Conversions</h3>
    322 <DL><DL>
    323 In Windows, GSAS data, experiment and instrument parameter files are
     378<B>In Windows</B>, GSAS data, experiment and instrument parameter files are
    324379expected to have a format with exactly 80 characters per line followed
    325380by a carriage returns and a linefeed (82 characters total per line).
     
    333388<br clear=all>
    334389<a name="Composition"></a>
    335 <h3>Compute Composition</h3>
     390<h3>D.5 Compute Composition</h3>
    336391<DL><DL>
    337392The composition box shows the unit cell and asymmetric unit composition
     
    342397<br clear=all>
    343398<a name="ExportMSI"></a>
    344 <h3>Export coordinates in MSI .xtl format</h3>
     399<h3>D.6 Export coordinates in MSI .xtl format</h3>
    345400<DL><DL>
    346401The Export/exp2xtl routine writes a .xtl file, as is used in Insight-II and
     
    353408<br clear=all>
    354409<a name="DeleteHistoryRecords"></a>
    355 <h3>Delete History Records</h3>
     410<h3>D.7 Delete History Records</h3>
    356411<DL><DL>
    357412Every time a GSAS program (including EXPGUI) is run, an entry is added to
     
    370425</DL></DL>
    371426
     427<A name=tcltk>
     428<H2>
     429<A Href="http://www.ncnr.nist.gov/programs/crystallography/software/tclpkgs.html">
     430Tcl/Tk</A></H2>
     431The
     432<A Href="http://www.ncnr.nist.gov/programs/crystallography/software/tclpkgs.html">
     433Tcl/Tk program</A> is a platform-independent scripting language that is
     434used to implement most of EXPGUI. This software is available for free
     435and must be loaded in order to use EXPGUI. See the
     436installation notes for
     437<A HREF="expgui_Win_readme.html">Windows</A>,
     438and for
     439<A HREF="expgui_Unix_readme.html">UNIX</A> for information on how to do this.
     440While learning Tcl/Tk is a great thing to do, it is not a requirement
     441for using or installing EXPGUI.
     442
     443<A name=winexec>
     444<H3>
     445WINEXEC</H3>
     446<UL>
     447The WINEXEC package is needed under Windows-95 and its offspring
     448(-98 and -ME). See the <A HREF="expgui_Win_readme.html">Windows installation
     449notes</A> for more details.
     450</UL>
     451
    372452<A name=blt>
    373 <H2>
    374 BLT</H2>
     453<H3>
     454BLT</H3>
     455<UL>
    375456The BLT graphics package is used by the WIDPLT and LIVEPLOT routines. If the
    376 package can not be loaded these routines, an error message,
    377 "Error -- Unable to load the BLT package", will be displayed. A frequent
    378 problem is the package is installed, but not configured so that common
    379 support routines are loaded automatically. If this is the case,
    380 a message, "BLT Setup Error: could not access a Blt_ routine...",
    381 will be displayed.
    382 Please see
     457package can not be found these routines, an error message,
     458"Error -- Unable to load the BLT package", will be displayed. It is also
     459possible for the package to be installed, but not configured properly.
     460If this is the case, a message,
     461"BLT Setup Error: could not access a Blt_ routine...", will be displayed.
     462This is most common in UNIX and is discussed further in the
     463<A HREF="expgui_Unix_readme.html">UNIX installation notes</A>. Also see
    383464<A HREF="http://www.ncnr.nist.gov/programs/crystallography/software/tclpkgs.html">
    384465http://www.ncnr.nist.gov/programs/crystallography/software/tclpkgs.html
    385466</A> for more information on installation of BLT.
     467</UL>
    386468
    387469<H2>
     
    394476for convincing me to learn Tcl/Tk
    395477and Jonathan Wasserman for helping get this project started.
    396 Large sections of the Preferred Orientation GUI were written by
    397 Pamela Whitfield of the NRC (Canada).
     478Thanks also to
     479Pamela Whitfield of the NRC (Canada) for writing large
     480sections of the
     481<A Href="expgui7.html">Preferential Orientation Pane</A>
     482and the
     483<A Href="expgui6.html">Profile Constraints pane</A>
     484code.
    398485<P>
    399486<A Href="http://www.ncnr.nist.gov/programs/crystallography/software/gsas.html">
     
    420507software.
    421508
    422 <P>EXPGUI is not subject to copyright. Have fun with it. Modify it. Write
     509<P>The author of EXPGUI is a U.S. Government employee which means that
     510EXPGUI is not subject to copyright. Have fun with it. Modify it. Please write
    423511new sections and make them available to the rest of the world.
    424512
     
    426514expressed or implied, or assumes any liability or responsibility
    427515for the use of this information or the software described
    428 here. Brand names cited here are used for
     516here. Brand names cited herein are used for
    429517identification purposes and do not consitute an endorsement by NIST.
    430518
Note: See TracChangeset for help on using the changeset viewer.