source: trunk/docs/source/GSASII.rst

Last change on this file was 5579, checked in by toby, 5 months ago

Sphinx docs build: add version to html; generate vars tbl (3.2); minor fixes

File size: 2.7 KB
Line 
1Main routine: GSASII.py
2===========================
3
4*GSASII: GSAS-II GUI*
5----------------------------------------
6
7File GSASII.py is the script to start the GSAS-II graphical user
8interface (GUI).
9This script imports GSASIIpath, which does some minor initialization
10and then (before any wxPython calls can be made) creates a wx.App application.
11A this point :func:`GSASIIpath.SetBinaryPath` is called to establish
12the directory where GSAS-II binaries are found. If the binaries
13are not installed or are incompatible with the OS/Python packages,
14the user is asked if they should be updated from the subversion site.
15The wxPython app is then passed to :func:`GSASIIdataGUI.GSASIImain`,
16which creates the GSAS-II GUI and finally the event loop is started.
17
18Keyboard Menu Shortcuts
19----------------------------------------
20
21Shortcuts for commonly-used menu commands are created by adding a
22menu command with a "\\tCtrl+" addition such as::
23
24        item = parent.Append(wx.ID_ANY,'&Refine\tCtrl+R','Perform a refinement')
25
26This will allow the above menu command to be executed with a "Control-R"
27keyboard command (on MacOS this will be "Command+R" rather than "Control-R") as well as using the menu to access that action. The following table lists the
28keyboard letters/numbers that have GSAS-II assigned actions.
29are system assigned. Note that there are also plotting keyboard commands that are
30implemented in :mod:`GSASIIplot`.
31These can be discovered from the "K" button on the plot menu bar, as they
32vary depending on the type of plot.
33
34.. tabularcolumns:: |c|p{4in}|
35
36==========  ====================================================
37  key         explanation
38==========  ====================================================
39 O           Open project (File menu)
40 E           Reopen recent (File menu)
41 S           Save project (File menu)
42 B           Project browser (File menu)
43 Q           Quit (File menu). This is system assigned on MacOS 
44 F4          Quit (File menu). This is system-assigned
45             on Windows 
46
47 L           View LS parms (Calculate menu)
48 R           Refine/Sequential Refine (Calculate menu)
49 I           Parameter Impact (Calculate menu)
50
51 U           Check for updates (Help menu)
52 T           Tutorials (Help menu)
53 F1          Help on current tree item (Help menu).
54             This is system-assigned
55
56 P           Peakfit (Peak Fitting menu, requires selection of
57             Histogram Peak)
58
59 M           Minimize GSAS-II windows (MacOS Windows menu).
60             This is system-assigned
61==========  ====================================================
62
63GSAS-II contents
64----------------------------------------
65
66
67.. automodule:: GSASII
68    :members: 
69    :private-members:
70    :special-members:
Note: See TracBrowser for help on using the repository browser.