Skip to content

Commit 12126c8

Browse files
committed
missed files
1 parent dd03d6c commit 12126c8

File tree

3 files changed

+71
-3
lines changed

3 files changed

+71
-3
lines changed

webdocs/help.rst

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
While I hope this never happens again, there have been occasions where a
2+
version of GSAS-II has a bug that prevents the program from starting.
3+
If this version is installed, it is then not possible to access the
4+
Help/Update menu command to obtain the different version of
5+
GSAS-II. The same thing can also happen if you make changes to the
6+
files yourself and introduce an error. Also, if you make changes to
7+
the GSAS-II Python (.py) files, you can no longer obtain updates.
8+
9+
A script is provided that can be used to reset any locally made
10+
changes and then install the lastest version of GSAS-II. If you have
11+
made changes that you wish to retain, you should make a copy of them
12+
either using a utility to place a copy elsewhere, or you can use the
13+
git stash, branch or commit commands. The commands below will
14+
overwrite your changes with the latest GSAS-II version.
15+
16+
On windows
17+
----------------
18+
19+
At present, two windows .BAT files are created in the directory where
20+
GSAS-II is installed, one named `Reset2FreshGSASII.bat` the other
21+
`start_G2_bootstrap.bat`. Thus, if GSAS-II is installed in directory
22+
`C:\Users\toby\gsas2full` the files will be named
23+
`C:\Users\toby\gsas2full\Reset2FreshGSASII.bat` and
24+
`C:\Users\toby\gsas2full\start_G2_bootstrap.bat`.
25+
Either will restore the GSAS-II files, but the
26+
`Reset2FreshGSASII` file, will ask you to confirm before acting. The
27+
files can run by locating them in the Windows File Explorer and
28+
double-clicking on it or by typing the file name into the cmd.exe
29+
window.
30+
31+
On MacOS and Linux
32+
------------------------
33+
34+
At the time this is being written, an error prevents the script from
35+
running, but this can be corrected by editing the `reset-gsasII.sh`
36+
file manually (see below). Note that this file is placed in the `bin` directory
37+
immediately below the GSAS-II installation directory. Thus, if
38+
GSAS-II is installed at location `/Users/toby/G2/gsas2full` then the
39+
file will be named `/Users/toby/G2/gsas2full/bin/reset-gsasII.sh`. (It
40+
will appear in the path if conda is initialized.) Depending on the OS,
41+
it may be possible to locate and run this file in a system-supplied
42+
file browser, or type the file name into a terminal window.
43+
44+
The error in the script is that the second line is incorrect. If the
45+
lines appear as::
46+
47+
# Commands to run GSAS-II load/update process
48+
source /bin/activate base
49+
/Users/toby/G2/gsas2full/bin/python /Users/toby/G2/gsas2full/gitstrap.py --reset
50+
51+
The second line should be changed as follows::
52+
53+
# Commands to run GSAS-II load/update process
54+
source /Users/toby/G2/gsas2full/bin/activate base
55+
/Users/toby/G2/gsas2full/bin/python /Users/toby/G2/gsas2full/gitstrap.py --reset

webdocs/index.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,8 @@ well as extensive visualization capabilities.
2929
help.rst
3030
mailinglist.rst
3131
bug.rst
32+
options.rst
3233
developers.rst
33-
compile.rst
34-
install-pip.rst
35-
proxy.rst
3634

3735
.. tip::
3836
Please help us by citing:

webdocs/options.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. image:: ./images/gsas2.png
2+
:scale: 25 %
3+
:alt: GSAS-II logo
4+
:align: right
5+
6+
====================================
7+
Customizing GSAS-II
8+
====================================
9+
10+
There are many ways that GSAS-II operations can be tailored, if the way it operates "out of the box" is not ideal for how you use the program. In the File/Preferences menu (this is called menus is labeled as Settings on Macs, and is found both in the File menu, as well as the normal location for Settings as part of the first menu item). This menu offers access to >40 different options that change how GSAS-II operates, allowing aspects of the program to operate according to preferences of different users.
11+
Examples of customization options include plotting colors, default options for image masking and integration, locations for add-on programs and options used for debugging. A complete list of the available preference options are listed in file ``config_example.py`` where the contents of that file is
12+
`documented here <https://gsas-ii.readthedocs.io/en/latest/GSASIIutil.html#config-example-py-configuration-options>`_.
13+
Note that these preferences are saved locally in file ``config.py``.
14+
15+
GSAS-II is open source, so you may want to change other aspects of how GSAS-II operates to be more convenient for your own use. Should you implement something along those lines, we would be interested in making that available to others as a preference option. Please consider submitting a pull request on GitHub.

0 commit comments

Comments
 (0)