Skip to content

Commit a7e0ad6

Browse files
committed
more work on web docs
1 parent 751aaf6 commit a7e0ad6

File tree

3 files changed

+26
-21
lines changed

3 files changed

+26
-21
lines changed

webdocs/developers.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ have this code be executed only in debug mode::
118118
G2gr.UpdateGroup(G2frame,item)
119119

120120
---------------------------------------------------
121-
Adding startup commands
121+
Adding startup code
122122
---------------------------------------------------
123123

124124
When doing repetitive testing, it can be time consuming to have to run
@@ -131,4 +131,5 @@ directory with the rest of the GSAS-II files. As an example::
131131
G2frame = wx.App.GetMainTopWindow()
132132
G2frame.OnRefine(None)
133133

134-
134+
This triggers refinement of a .gpx file that is placed on the command
135+
line.

webdocs/install_dev.rst

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -170,14 +170,14 @@ will also work as GSAS-II is run directly from the git repo.
170170
.. tip::
171171

172172
If using pixi, be sure to use the ``pixi run install-editable`` command (Windows,
173-
``pixi run install-editable-win``) to install GSAS-II. With ``pixi run install``
173+
``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
180+
One could possibly modify the installed GSAS-II files, in a
181181
directory along the lines of
182182
``.../pixi/.pixi/envs/default/Lib/site-packages/GSASII``, but then
183183
changed files would need to be copied over to the git repo and
@@ -186,7 +186,7 @@ will also work as GSAS-II is run directly from the git repo.
186186

187187
Once GSAS-II is installed and is running, one uses git to change the
188188
GSAS-II files over to the version in your copy of the repo. Before
189-
doing that note if you will be using `ssh or https access
189+
doing that, note if you will be using `ssh or https access
190190
<gitauthenticate>`_ to GitHub. With ssh access you will use these
191191
commands::
192192

@@ -274,8 +274,8 @@ be specified in both, such as::
274274
Install GSAS-II directly from your repo using GSAS2MAIN Python
275275
----------------------------------------------------------------------------
276276

277-
If you have installed GSAS-II from GSAS2MAIN and wish to use that
278-
Python and the GSAS-II binaries, that is also possible.
277+
If you have installed GSAS-II from the GSAS2MAIN self-installer, it is fairly easy to make a separate installation of GSAS-II for use in development, redeploying the
278+
Python provided by the self-installer and copying the GSAS-II binaries.
279279

280280
* For Windows, if GSAS-II is installed at location ``C:\Users\Me\gsas2main`` then use this command to setup Python::
281281

@@ -295,17 +295,16 @@ To clone GSAS-II from your forked copy use commands similar to the following::
295295
git clone --depth 1 [email protected]:<your-fork>/GSAS-II.git
296296
cd GSAS-II
297297

298-
or with https the third command will be:
298+
or, with https rather than ssh, the third command will be::
299299

300300
git clone --depth 1 https://github.com/<your-fork>/GSAS-II.git
301301

302302
Before GSAS-II can be run, it is also necessary to provide GSAS-II
303303
binaries, which can be done by copying the binary directory,
304-
GSASII-bin, from the GSAS2MAIN installation to the equivalent location
304+
``GSASII-bin``, from the GSAS2MAIN installation to the equivalent location
305305
in the development installation. Alternately the GSASII-bin directory
306-
can be moved to ~/.GSASII (%HOMEPATH%\.GSASII on Windows).
306+
can be moved to ``~/.GSASII`` (``%HOMEPATH%\.GSASII`` on Windows).
307307

308-
----------------------------------------------------------------------------
309308
Running the development version of GSAS-II
310309
----------------------------------------------------------------------------
311310

@@ -337,20 +336,19 @@ Note that if you have cloned using https using a command like this::
337336

338337
but later set up for ssh authorization, you will need to change the
339338
upstream repo, as described in the next section. This can be done by
340-
editing the ``.../GSAS-II/.git/config`` file from::
339+
directly editing the ``.../GSAS-II/.git/config`` file from::
341340

342341
[remote "origin"]
343342
url = https://github.com/AdvancedPhotonSource/GSAS-II.git
344343
fetch = +refs/heads/master:refs/remotes/origin/master
345344

346-
to::
345+
to::
347346

348347
[remote "origin"]
349348
url = [email protected]:MyPersonalRepo/GSAS-II.git
350349
fetch = +refs/heads/*:refs/remotes/origin/*
351350

352-
These changes can be done directly by editing this file. Alternately,
353-
these git commands will do the same thing::
351+
Alternately, these git commands will do the same thing::
354352

355353
git config remote.origin.url [email protected]:MyPersonalRepo/GSAS-II.git
356354
git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*"
@@ -366,7 +364,7 @@ The command to do this is::
366364

367365
git checkout -b g2newfeature
368366

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

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

webdocs/install_pixi.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Overview: Installing GSAS-II with pixi
1717

1818
Due to royalty issues with use of Anaconda, Inc. conda packages (which
1919
GSAS-II does not use; GSAS-II only uses conda-forge packages, which are
20-
non-proprietary), some sites are encouraging use of `pixi
20+
non-proprietary). Some sites are encouraging use of `pixi
2121
<https://pixi.sh>`_, rather than
2222
conda. The pixi installer can be used directly after downloading
2323
GSAS-II from the GitHub site. The pixi program makes installation of
@@ -28,9 +28,11 @@ Linux. It is also helpful for GSAS-II development (see below).
2828

2929
Installation of GSAS-II with pixi requires a few prerequisite steps,
3030
depending on the platform. Note that on Windows and MacOS, pixi
31-
installs gfortran, but on Linux this must be done (typically with a
32-
Linux package manager such as apt or dnf, etc.). These are the steps
33-
that are typically needed:
31+
installs gfortran, but on Linux this must be done before running pixi (typically with a
32+
Linux package manager such as apt or dnf, etc.).
33+
34+
These are the steps that are typically needed to install GSAS-II using
35+
pixi.:
3436

3537
* installation of the pixi program
3638
* on Linux, installation of the gfortran (and gcc) compiler
@@ -134,8 +136,12 @@ following commands in a terminal window (Linux/Mac) or cmd.exe window
134136
cd <install-location>
135137
cd GSASII
136138
cd pixi
137-
``pixi run install-editable-win`` git pull
139+
git pull
138140
pixi run install
141+
142+
If you used ``pixi run install-editable-win`` or ``pixi run
143+
install-editable`` to install GSAS-II, the ``pixi run...`` command
144+
does not need to be repeated.
139145

140146
---------------------------------------------------
141147
Use of pixi for GSAS-II Development

0 commit comments

Comments
 (0)