Skip to content

Commit bc59423

Browse files
committed
still more work on web docs
1 parent a7e0ad6 commit bc59423

File tree

2 files changed

+26
-27
lines changed

2 files changed

+26
-27
lines changed

webdocs/install_dev.rst

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -169,25 +169,23 @@ will also work as GSAS-II is run directly from the git repo.
169169

170170
.. tip::
171171

172-
If using pixi, be sure to use the ``pixi run install-editable`` command (Windows,
172+
If using pixi, be sure to use the ``pixi run install-editable`` command (on Windows,
173173
``pixi run install-editable-win``) to install GSAS-II. With ``pixi run install``,
174174
because the files used to run GSAS-II are versions present when the install
175175
command was last run, not the latest versions. If you modified the repo
176176
files, you would need to rerun the ``pixi run install`` command to
177177
see the latest changes. Likewise, do not use pip to install GSAS-II for the
178178
same reasons.
179179

180-
One could possibly modify the installed GSAS-II files, in a
181-
directory along the lines of
182-
``.../pixi/.pixi/envs/default/Lib/site-packages/GSASII``, but then
183-
changed files would need to be copied over to the git repo and
184-
would be at risk for an accidental overwrite if the install command
185-
were used.
180+
While one could modify the installed GSAS-II files, in a directory along the lines of
181+
``.../pixi/.pixi/envs/default/Lib/site-packages/GSASII`` during code development, but then
182+
the revised files would need to be copied over to the git repo to upload them and
183+
would be at risk for an accidental overwrite if the install command were used.
186184

187185
Once GSAS-II is installed and is running, one uses git to change the
188186
GSAS-II files over to the version in your copy of the repo. Before
189187
doing that, note if you will be using `ssh or https access
190-
<gitauthenticate>`_ to GitHub. With ssh access you will use these
188+
<#gitauthenticate>`_ to GitHub. With ssh access you will use these
191189
commands::
192190

193191
cd GSAS-II
@@ -226,7 +224,7 @@ Install GSAS-II directly from your forked repo
226224

227225
If you are on MacOS or Linux, you can use steps indicated in the `pixi
228226
installer <install_pixi.html>`_ to install pixi. Again, knowing if you
229-
will use `ssh or https access <gitauthenticate>`_ to GitHub. With ssh
227+
will use `ssh or https access <#gitauthenticate>`_ to GitHub. With ssh
230228
access, the commands to download GSAS-II and install it and Python (as
231229
well as compile) and will be::
232230

@@ -305,7 +303,8 @@ binaries, which can be done by copying the binary directory,
305303
in the development installation. Alternately the GSASII-bin directory
306304
can be moved to ``~/.GSASII`` (``%HOMEPATH%\.GSASII`` on Windows).
307305

308-
Running the development version of GSAS-II
306+
307+
Running the development version of GSAS-II
309308
----------------------------------------------------------------------------
310309

311310
If GSAS-II is run from a directly installed version of Python or a
@@ -364,7 +363,7 @@ The command to do this is::
364363

365364
git checkout -b g2newfeature
366365

367-
Note that this creates a branch named ``g2newfeature`` (do choose a better name.)
366+
Note that this creates a branch named ``g2newfeature`` (do choose a better name.)
368367

369368
When your changes are complete and you are ready to communicate them
370369
back, you will commit them locally and use ``git push`` to upload them

webdocs/install_pixi.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -243,8 +243,8 @@ prerequisites, pixi and git.
243243

244244
powershell -ExecutionPolicy ByPass -Command "irm -useb https://pixi.sh/install.ps1 | iex"
245245
246-
Close the cmd.exe window (to get access to the newly-installed git and
247-
pixi programs) and open new cmd.exe window where these commands are entered::
246+
* Close the cmd.exe window (to get access to the newly-installed git
247+
and pixi programs) and open new cmd.exe window where these commands are entered::
248248

249249
git clone --depth 1 https://github.com/AdvancedPhotonSource/GSAS-II.git G2
250250
cd G2\pixi
@@ -277,17 +277,27 @@ entered::
277277
pixi run test
278278
pixi run ui
279279

280-
Linux RHEL 9.6
280+
Ubuntu 22.04.2
281+
----------------
282+
283+
See the instructions above for Linux Mint 21.2, except that curl needs
284+
to be installed, so the second command should be changed to::
285+
286+
sudo apt install gfortran git curl
287+
288+
Linux RHEL 9.6
281289
==================
282290

283291
The first command requires admin access (sudo authorization). If you
284292
need to login to a separate account to run sudo commands (which I
285293
consider a good security practice), you will
286-
want to run only the first command from the admin account. The
287-
``curl`` command to install pixi should be run from the account where
288-
you will run GSAS-II::
294+
want to run this command from the admin account::
289295

290296
sudo dnf install gfortran
297+
298+
The second command that downloads and installs pixi should be run from
299+
the account where you will run GSAS-II::
300+
291301
curl -fsSL https://pixi.sh/install.sh | bash
292302
293303
Close the terminal window (to get access to the newly-installed pixi
@@ -299,13 +309,3 @@ entered::
299309
pixi run install
300310
pixi run test
301311
pixi run ui
302-
303-
Ubuntu 22.04.2
304-
----------------
305-
306-
See the instructions above for Linux Mint 21.2, except that curl needs
307-
to be installed, so the second command should be::
308-
309-
sudo apt install gfortran git curl
310-
311-

0 commit comments

Comments
 (0)