Skip to content

Commit b7bf65e

Browse files
committed
update install web pages (admin & command-line)
1 parent fe8c263 commit b7bf65e

File tree

4 files changed

+89
-15
lines changed

4 files changed

+89
-15
lines changed

webdocs/install-g2f-linux.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,17 @@ there the meson instructions.
6464

6565
Clicking on the icon will open GSAS-II. Likewise a GSAS-II project (.gpx) file can be dragged onto the icon to open that file in GSAS-II.
6666

67+
68+
Command-line options
69+
----------------------
70+
71+
The bash installation command above uses two options:
72+
73+
* `-b` for batch mode, so that no questions are asked and
74+
* `-p <path>` which specifies where GSAS-II will be installed.
75+
76+
One other option is available:
77+
78+
* `-f` for force, which will cause the GSAS-II installation to proceed
79+
even when there are files in the installation location. This should
80+
only be used to reinstall GSAS-II if needed.

webdocs/install-g2f-mac.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,16 @@ MacOS: Detailed GSAS2MAIN Installation Instructions
108108

109109
Note: When the icon is first used, you will likely see one or more Mac security warnings asking you to confirm that you do want to give GSAS-II access to components in your computer, as shown to the right. GSAS-II will not run properly unless you press "Allow". Each warning should only be shown once.
110110

111+
Command-line options
112+
----------------------
113+
114+
The bash installation command above uses two options:
115+
116+
* `-b` for batch mode, so that no questions are asked and
117+
* `-p <path>` which specifies where GSAS-II will be installed.
118+
119+
One other option is available:
120+
121+
* `-f` for force, which will cause the GSAS-II installation to proceed
122+
even when there are files in the installation location. This should
123+
only be used to reinstall GSAS-II if needed.

webdocs/install-g2f-win.rst

Lines changed: 57 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ Windows: Detailed GSAS2MAIN Installation Instructions
3030

3131
<div class="clear"></div>
3232

33-
#. I needed to then rename the file to end in .exe (the rest of the name is not important) so that I could run it. Double-clicking on the file causes the window to the right to be displayed briefly and then the window below it opens.
33+
#. I needed to then rename the file to end in .exe (the rest of the
34+
name is not important) so that I could run it. Double-clicking on
35+
the file causes the window to the right to be displayed briefly and
36+
then the window below it opens.
3437

3538
.. image:: ./win_inst_images/3a.png
3639
:scale: 40 %
@@ -52,7 +55,10 @@ Windows: Detailed GSAS2MAIN Installation Instructions
5255

5356
<div class="clear"></div>
5457

55-
#. Click on next to start the installation process. You will be shown information on the installation process and software licensing. Please review it. You must click on "I Agree" to continue.
58+
#. Click on next to start the installation process. You will be shown
59+
information on the installation process and software
60+
licensing. Please review it. You must click on "I Agree" to
61+
continue.
5662

5763
.. image:: ./win_inst_images/3.png
5864
:scale: 25 %
@@ -63,7 +69,8 @@ Windows: Detailed GSAS2MAIN Installation Instructions
6369

6470
<div class="clear"></div>
6571

66-
#. Select "Just Me" for the installation type. It is not clear if "All Users" will even work for computers shared between multiple users.
72+
#. Select "Just Me" for the installation type. It is not clear if "All
73+
Users" will even work for computers shared between multiple users.
6774

6875
.. image:: ./win_inst_images/4.png
6976
:scale: 25 %
@@ -74,7 +81,10 @@ Windows: Detailed GSAS2MAIN Installation Instructions
7481

7582
<div class="clear"></div>
7683

77-
#. The default installation folder is usually fine, but I often prefer to change this to ``C:\G2`` or something short. Some compters have been set so you must place the GSAS-II files within your account, however.
84+
#. The default installation folder is usually fine, but I often prefer
85+
to change this to ``C:\G2`` or something short. Some computers have
86+
been set so you must place the GSAS-II files within your account,
87+
however.
7888

7989
.. image:: ./win_inst_images/5.png
8090
:scale: 25 %
@@ -85,7 +95,10 @@ Windows: Detailed GSAS2MAIN Installation Instructions
8595

8696
<div class="clear"></div>
8797

88-
#. For the "Advanced Install Options", I recommend unselecting the first option, leaving the first three options unchecked. Note that the start menu choice offered in the first option creates shortcuts for starting Python, not GSAS-II.
98+
#. For the "Advanced Install Options", I recommend unselecting the
99+
first option, leaving the first three options unchecked. Note that
100+
the start menu choice offered in the first option creates shortcuts
101+
for starting Python, not GSAS-II.
89102

90103
.. image:: ./win_inst_images/6.png
91104
:scale: 25 %
@@ -96,7 +109,10 @@ Windows: Detailed GSAS2MAIN Installation Instructions
96109

97110
<div class="clear"></div>
98111

99-
Installation then starts and may take at least a few minutes to complete, depending on computer speed and in one section, internet speed (as GSAS-II is updated). You may see a cmd.exe screen briefly as some GSAS-II Python commands are executed.
112+
Installation then starts and may take at least a few minutes to
113+
complete, depending on computer speed and in one section, internet
114+
speed (as GSAS-II is updated). You may see a cmd.exe screen briefly
115+
as some GSAS-II Python commands are executed.
100116

101117
.. image:: ./win_inst_images/7.png
102118
:scale: 25 %
@@ -118,7 +134,7 @@ Windows: Detailed GSAS2MAIN Installation Instructions
118134

119135
<div class="clear"></div>
120136

121-
Clicking on "Next" causes the window below it to open. Press "Finish" there.
137+
Clicking on "Next" causes the window below it to open. Press "Finish" there.
122138
The GSAS-II installation is now complete. If the computer has internet access,
123139
then GSAS-II should have been updated to the most recent version. If not, no warning
124140
message is displayed, but GSAS-II can still be updated later, when internet access is
@@ -157,26 +173,55 @@ If GSAS-II has already been installed in a separate location, the icon will be n
157173

158174
<div class="clear"></div>
159175

176+
Installing as admin
177+
---------------------------------------------------------------
178+
179+
It is not necessary to install GSAS-II from an admin account. As long
180+
as the user has write access to the location where the files will be
181+
written, it should be possible to install GSAS-II from an ordinary
182+
user account and this is what we recommend.
183+
184+
Some users or system managers might prefer to install GSAS-II from an
185+
admin account, so they can write the files to an area of their disk
186+
where a normal user account my not have access or to prevent
187+
accidental modification of GSAS-II files. This strategy will usually
188+
work fine and does have some good reasoning behind it, but this choice
189+
will require that some options that require
190+
changing installed files, such as updating GSAS-II, installation of a
191+
GSASIIscriptable shortcut, or installing optional Python packages will
192+
fail unless run from the admin account as well.
193+
160194

161-
Notes on GSAS2MAIN Installation for Windows
195+
GSAS2MAIN installation for servers/classrooms
162196
---------------------------------------------------------------
163197

164-
If you want to install on multiple Windows computerss, you can install GSAS-II
198+
If you want to install on multiple Windows computers, you can install GSAS-II
165199
into shared directory or a file server, but the path where the
166-
software is installed is recorded in the files that are
200+
software is installed is recorded in files that are
167201
installed. This means that the path used to access GSAS-II
168202
should be the same on all systems
169203
where GSAS-II will be used. Likewise, it is possible to install GSAS-II
170-
on one computer and then copy the directory contents where GSAS-II has been
204+
on one computer and then copy the directory contents from where GSAS-II has been
171205
installed to other computers, but again the full path for installation
172206
should be the same on all computers. E.g., if GSAS-II is installed
173207
in ``C:\software\GSASII`` it can be copied to a directory with the
174208
same name on other computers and used from that location, but not to
175209
``E:\software\GSASII`` or ``C:\Users\someone\GSASII``. A supplied
176-
script (`...\GSASII\installl\makeBat.py`) can be run to register the
210+
script (`...\GSASII\install\makeBat.py`) can be run to register the
177211
`.gpx` extension so that clicking on a GSAS-II project will open it in GSAS-II.
178212

213+
214+
Command-line options
215+
----------------------
216+
179217
It should be possible to run the GSAS-II self-installer in NSIS "silent
180218
mode," which would allow it to be run inside a script, but that does
181219
not seem to work and I am not sure why. Ref:
182220
https://github.com/conda/constructor/blob/main/CONSTRUCT.md#installer_type
221+
222+
Potentially useful commands would be:
223+
224+
* `/S` for "silent" (batch) mode, so that no questions are asked and
225+
* `/D=<path>` which specifies the location where GSAS-II will be
226+
installed (`/D=E:\software\GSASII`)
227+
* `/?` displays the available options.

webdocs/install.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,13 @@ GSAS2MAIN installer for Windows
3838
==================================
3939

4040
For Windows download file https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2main-Latest-Windows-x86_64.exe and run it.
41-
After the installer is started
42-
You will have a choice for where to install the software (the default is usually OK, but something like ``c:\software`` might be better, if your computer security allows that.)
41+
After the installer is started, you will have a choice for where to
42+
install the software (the default is usually OK, but something like
43+
``c:\software`` might be better, if your computer security allows that.)
4344

4445
You do not need to have administrator access to your computer to
45-
install GSAS-II, but apparently the newest windows security makes it
46+
install GSAS-II, and installing from an admin account is not
47+
recommended, but apparently the newest windows security makes it
4648
hard to install software that is not registered with Microsoft: I am
4749
told you have to first right click, go to Properties, and check the “Unblock” box.
4850

0 commit comments

Comments
 (0)