Skip to content

Commit 0a8d317

Browse files
committed
make some minor help & web changes in part to test the .html help generation workflow
1 parent 0cd907c commit 0a8d317

2 files changed

Lines changed: 26 additions & 7 deletions

File tree

MDhelp/docs/others.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,25 @@
55
<a name="MacOS"></a>
66
## Macintosh notes:
77

8-
GSAS-II can be run on Windows, Linux and Macintosh/OS X computers, but the GUI follows the native style of Mac OS X. On Windows and some versions of Linux, the menu bars appears on top of the main window. On the Mac, the menu appears at the location that has been configured for menus (usually at the top of the screen).
9-
At present, two versions of GSAS-II are provided. One is for older, Intel CPUs and the other for "Apple Silicon" (ARM or M1, M2,...) CPUs. Eventually only ye ARM CPUs will be supported. At present, the Intel version will run on ARM machines under Rosetta, but eventually that too will go away.
8+
GSAS-II can be run on Windows, Linux and Macintosh/OS X computers, but the GUI follows the native style of the window manager where it is run, so GSAS-II will look more like a Mac application on that platform and more like a Windows application there. On Windows and some versions of Linux, the menu bars appears on top of the main window. On the Mac, the menu appears at the location that has been configured for menus (usually at the top of the screen).
9+
At present, two versions of GSAS-II are provided. One is for older, Intel CPUs and the other for "Apple Silicon" (ARM or M1, M2,...) CPUs. Eventually only ARM CPUs will be supported. At present, the Intel version will run on ARM machines under Rosetta, but eventually Rosetta will also go away.
1010

11-
GSAS-II defines actions for both the left and right and middle buttons assuming that a three-button mouse is available. If a two or three-button mouse is used with a Mac, the "extra" mouse buttons will work as intended. If using a Mac touchpad or single-button mouse, clicking the touchpad or mouse button will generate a "left button" click. Hold down the control-key to generate a "right button" click or for a right-button drag, hold down control while pressing on the mouse button or touchpad. I do not know how to generate a middle-button click or drag with a single-button mouse, but with a MacBook touchpad, pressing with two fingers generates the equivalent of a right-mouse drag and moving two fingers without pressure is the equivalent of a middle-button drag action.
11+
GSAS-II defines actions for both the left and right and middle buttons assuming that a three-button mouse is available. If a two or three-button mouse is used with a Mac, the "extra" mouse buttons will work as intended. If using a Mac touchpad or single-button mouse, clicking the touchpad or pressing the mouse button will generate a "left button" click. Hold down the control-key to generate a "right button" click or for a right-button drag, hold down control while pressing on the mouse button or touchpad. I do not know how to generate a middle-button click or drag with a single-button mouse, but with a MacBook touchpad, pressing with two fingers generates the equivalent of a right-mouse drag and moving two fingers without pressure is the equivalent of a middle-button drag action.
12+
13+
<a name="Windows"></a>
14+
## Windows notes:
15+
16+
When GSAS-II is installed through most of the conventional installation methods, the `GSASII\install\MakeBat.py` file is run and this creates two "Windows .bat" files that can be used to make running GSAS-II easier as well as making some minor Windows registry changes. This script can be run manually by people who are installing GSAS-II directly from GitHub.
17+
18+
The `MakeBat.py` script creates a file named `RunGSASII.bat` file, which is placed in the directory where GSAS-II is installed and a shortcut to this file is placed on the Windows desktop. The shortcut can be moved, renamed etc. Clicking on this file or shortcut will start GSAS-II.
19+
20+
Another file, `2Reset2FreshGSASII.bat` is created in the same directory.
21+
Ideally, this will not be needed, but might be of use if GSAS-II cannot be started due
22+
to changes made in the files locally or because we have put out a bad version.
23+
By double-clicking on the `2Reset2FreshGSASII.bat` file, the `gitstrap.py`
24+
script that is used to install GSAS-II will be updated to the latest version and then
25+
run that in a mode that will reset any changes that have been made to the GSAS-II
26+
files on your computer. It will also rerun the `MakeBat.py` script.
1227

1328
<a name="config"></a>
1429
<a name="Preferences"></a>
@@ -63,9 +78,6 @@ With coordinates that match the space group operations, the correct Ti-O distanc
6378

6479
![xform](./images/xform.png)
6580

66-
67-
68-
6981
<a name="FPA"></a><a name=FPAinput></a>
7082
## Fundamental Parameters as used to derive instrumental parameters
7183

webdocs/help.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,14 @@ file or created a similarly named file that would not work. If the
4242
file ``2Reset2FreshGSASII.bat`` is not present, download and reinstall
4343
GSAS-II. You can use a new location and keep the old version or delete
4444
the old version and install the new one in the location used
45-
previously.
45+
previously.
46+
47+
For now, the gsas2main installer will also create two other similar
48+
files, ``G2_bootstrap.bat`` and ``G2_start.bat``. These have the
49+
installation location hard-coded. The ``G2_bootstrap.bat`` file should
50+
download and rerun the ``gitstrap.py`` updating GSAS-II, very
51+
similarly to the ``2Reset2FreshGSASII.bat``script. The
52+
``G2_start.bat`` simply starts the GSAS-II GUI.
4653

4754
On MacOS and Linux
4855
------------------------

0 commit comments

Comments
 (0)