Changeset 114

Timestamp:

Dec 4, 2009 5:00:38 PM (14 years ago)

Author:

toby

Message:

# on 1999/10/11 20:27:13, toby did:
Customization examples

File:

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

trunk/doc/expgui_cfg.html

@@ -14 +14 @@
 ways quite easily.
 This document describes how the GUI works and how to modify the menus without
-significant reprogramming. 
-<P>
+significant reprogramming. A little bit of programmaning in Tcl/Tk can go a
+long way in adding new features. See the 
+<a HREF="#Customizing">Customizing</A> examples, below.
+
 <H3>EXPGUI</H3>
 The main GUI is created by file expgui, which in turn uses the following files
@@ -368 +370 @@
 
 <hr>
+<a name="Customizing"><H2>
+Customizing Example 1: Adding a new button to the button bar
+</H2></A>
+When a LeBail extraction is used to refine lattice constants, profile 
+terms, ... It is always a good idea to run GENLES a few times after running 
+POWPREF. This is because GENLES sets the extracted intensities back to their
+crystallographic values, during the first GENLES cycle after POWPREF has been 
+run. Refining anything until the extracted intensities return to reasonable
+values is a really bad idea. Forturnately, running GENLES with the number of
+cycles set to zero gives the Le Bail extraction a head start.
+<P>
+The code below can be used to define a new command, <tt>leBail</tt>. The first
+command adds a command to the button bar and the second one defines what will
+be done when it is invoked (the number of cycles is set to zero and 
+GENLES is run three times). It also defines the help entry. Note that commands must start with a lower case letter even though Armel LeBail's last name 
+does not.
+
+<PRE>
+    lappend expgui(buttonlist) leBail
+    set expgui_cmdlist(leBail) {
+        {set entryvar(cycles) 0; runGSASwEXP "genles genles genles"}
+        {Converges GENLES with LeBail extractions; 
+          Sets the number of cycles to zero and runs GENLES 3 times.}
+    }
+
+</PRE>
+To make this customization, put the above in the <TT>localconfig</TT> 
+file or the 
+<TT>~/.gsas_config</TT> or (or <TT>C:\GSAS\EXPGUI\.gsas_config</TT>)
+file.
+<hr>
+<H2>
+Customizing Example 2: Adding a new button to the button bar
+</H2>
+Barbara Reisner has been asking me to put the output from DISAGL in a separate
+window. Sounds like a pretty reasonable request. Here is the code to do that.
+
+<PRE>
+  set expgui(disaglSeparateBox) 1
+  set expgui_cmdlist(disagl) {rundisagl {Hacked Distance/angle calculations}}
+  proc rundisagl {} {
+    global expgui txtvw tcl_version tcl_platform
+    if {$expgui(disaglSeparateBox)} {
+        set root [file root $expgui(expfile)] 
+        catch {file rename $root.LST $root.OLS}
+        runGSASwEXP disagl
+        catch {file rename $root.LST $root.DIS}
+        catch {file rename $root.OLS $root.LST}
+
+        # open a new window
+        catch {toplevel .disagl}
+        catch {eval grid forget [grid slaves .disagl]}
+        text .disagl.txt -width 100 -wrap none \
+                -yscrollcommand ".disagl.yscroll set" \
+                -xscrollcommand ".disagl.xscroll set" 
+        if {$tcl_version >= 8.0} {.disagl.txt config -font $txtvw(font)}
+        scrollbar .disagl.yscroll -command ".disagl.txt yview"
+        scrollbar .disagl.xscroll -command ".disagl.txt xview" -orient horizontal
+        grid .disagl.xscroll -column 0 -row 2 -sticky ew
+        grid .disagl.txt -column 0 -row 1 -sticky nsew
+        grid .disagl.yscroll -column 1 -row 1 -sticky ns
+        grid columnconfigure .disagl 0 -weight 1
+        grid rowconfigure .disagl 1 -weight 1
+        wm title .disagl "DISAGL results $expgui(expfile)"
+        wm iconname .disagl "DISAGL $root"
+        set in [open $root.DIS r]
+        .disagl.txt insert end [read $in]
+        close $in
+        bind all <Control-KeyPress-c> {destroy .disagl}
+        bind .disagl <KeyPress-Prior> ".disagl.txt yview scroll -1 page"
+        bind .disagl <KeyPress-Next> ".disagl.txt yview scroll 1 page"
+        bind .disagl <KeyPress-Right> ".disagl.txt xview scroll 1 unit"
+        bind .disagl <KeyPress-Left> ".disagl.txt xview scroll -1 unit"
+        bind .disagl <KeyPress-Up> ".disagl.txt yview scroll -1 unit"
+        bind .disagl <KeyPress-Down> ".disagl.txt yview scroll 1 unit"
+        bind .disagl <KeyPress-Home> ".disagl.txt yview 0"
+        bind .disagl <KeyPress-End> ".disagl.txt yview end"
+        # don't disable in Win as this prevents the highlighting of selected text
+        if {$tcl_platform(platform) != "windows"} {
+            .disagl.txt config -state disabled
+        }
+    } else {
+        runGSASwEXP disagl
+    }
+  }
+
+</PRE>
+To make this customization, put the above in the <TT>localconfig</TT> 
+file or the 
+<TT>~/.gsas_config</TT> or (or <TT>C:\GSAS\EXPGUI\.gsas_config</TT>)
+file.
+<P>
+Note that an even better customization might be to add these commands into 
+the expgui file somewhere near the beginning and then near the end, 
+add
+<PRE>
+   $expgui(fm).option.menu add checkbutton  -label "DISAGL window" \
+        -variable expgui(disaglSeparateBox) -underline 0 
+</PRE>
+so that there is an option to turn the "separate DISAGL window mode" 
+on and off.
+<hr>
 GSAS is written by Allen C. Larson and <A HREF="http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://lansce.lanl.gov/lujan/staff12/vondreele.htm">
 Robert B. Von Dreele</A>, MS-H805,