Skip to content

Commit

Permalink
missed files
Browse files Browse the repository at this point in the history
  • Loading branch information
briantoby committed Oct 12, 2024
1 parent dd03d6c commit 12126c8
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 3 deletions.
55 changes: 55 additions & 0 deletions webdocs/help.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
While I hope this never happens again, there have been occasions where a
version of GSAS-II has a bug that prevents the program from starting.
If this version is installed, it is then not possible to access the
Help/Update menu command to obtain the different version of
GSAS-II. The same thing can also happen if you make changes to the
files yourself and introduce an error. Also, if you make changes to
the GSAS-II Python (.py) files, you can no longer obtain updates.

A script is provided that can be used to reset any locally made
changes and then install the lastest version of GSAS-II. If you have
made changes that you wish to retain, you should make a copy of them
either using a utility to place a copy elsewhere, or you can use the
git stash, branch or commit commands. The commands below will
overwrite your changes with the latest GSAS-II version.

On windows
----------------

At present, two windows .BAT files are created in the directory where
GSAS-II is installed, one named `Reset2FreshGSASII.bat` the other
`start_G2_bootstrap.bat`. Thus, if GSAS-II is installed in directory
`C:\Users\toby\gsas2full` the files will be named
`C:\Users\toby\gsas2full\Reset2FreshGSASII.bat` and
`C:\Users\toby\gsas2full\start_G2_bootstrap.bat`.
Either will restore the GSAS-II files, but the
`Reset2FreshGSASII` file, will ask you to confirm before acting. The
files can run by locating them in the Windows File Explorer and
double-clicking on it or by typing the file name into the cmd.exe
window.

On MacOS and Linux
------------------------

At the time this is being written, an error prevents the script from
running, but this can be corrected by editing the `reset-gsasII.sh`
file manually (see below). Note that this file is placed in the `bin` directory
immediately below the GSAS-II installation directory. Thus, if
GSAS-II is installed at location `/Users/toby/G2/gsas2full` then the
file will be named `/Users/toby/G2/gsas2full/bin/reset-gsasII.sh`. (It
will appear in the path if conda is initialized.) Depending on the OS,
it may be possible to locate and run this file in a system-supplied
file browser, or type the file name into a terminal window.

The error in the script is that the second line is incorrect. If the
lines appear as::

# Commands to run GSAS-II load/update process
source /bin/activate base
/Users/toby/G2/gsas2full/bin/python /Users/toby/G2/gsas2full/gitstrap.py --reset

The second line should be changed as follows::

# Commands to run GSAS-II load/update process
source /Users/toby/G2/gsas2full/bin/activate base
/Users/toby/G2/gsas2full/bin/python /Users/toby/G2/gsas2full/gitstrap.py --reset
4 changes: 1 addition & 3 deletions webdocs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,8 @@ well as extensive visualization capabilities.
help.rst
mailinglist.rst
bug.rst
options.rst
developers.rst
compile.rst
install-pip.rst
proxy.rst

.. tip::
Please help us by citing:
Expand Down
15 changes: 15 additions & 0 deletions webdocs/options.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. image:: ./images/gsas2.png
:scale: 25 %
:alt: GSAS-II logo
:align: right

====================================
Customizing GSAS-II
====================================

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.
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
`documented here <https://gsas-ii.readthedocs.io/en/latest/GSASIIutil.html#config-example-py-configuration-options>`_.
Note that these preferences are saved locally in file ``config.py``.

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 comments on commit 12126c8

Please sign in to comment.