Skip to content

Commit be0bb27

Browse files
committed
fixes to install docs
1 parent 947a154 commit be0bb27

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

webdocs/install.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Note that on MacOS, a Mac app is also created and is displayed in the Finder
9595

9696
.. index:: Installing GSAS-II with gitstrap.py
9797

98-
Installing GSAS-II with separate Python Installation
98+
Installing GSAS-II with Separate Python Installation
9999
======================================================
100100

101101
A small number of users or sites prefer to use Python distributions supplied via other routes (such as Debian packages) or using `PyPi <https://pypi.org>`_, etc. or prefer to handle use of conda on their own. Some discussion on Python installation is
@@ -117,7 +117,7 @@ will not be installed. However, when GSAS-II is first run, it will provide an op
117117

118118
.. index:: Installing GSAS-II from GitHub
119119

120-
Installing directly from GitHub
120+
Installation Info for Developers
121121
==============================================
122122

123123
While all of the above approaches will clone a copy of the GSAS-II repository from GitHub, software developers may find it more convenient to clone the repo themselves. This will typically be done as part of a process where a copy of GSAS-II is forked on GitHub. This is described in a `separate page <install_dev.html>`_ (outline below).
@@ -129,7 +129,7 @@ While all of the above approaches will clone a copy of the GSAS-II repository fr
129129
install_dev.rst
130130

131131

132-
Older installers
132+
Older Installers
133133
=================================
134134

135135
Previously GSAS-II was provided via an Advanced Photon Source-maintained subversion (svn) server, with differing installation processes. The subversion server is not longer being updated, so those installers should not be used because if GSAS-II is installed from subversion, you will not be able to update to the current GSAS-II version.
@@ -143,7 +143,7 @@ install GSAS-II from that branch, you will be
143143
be offered the opportunity to add needed Python packages and switch to
144144
the ``main`` branch when trying to update GSAS-II from the help menu.
145145

146-
Installation details
146+
Installation Details
147147
====================================
148148

149149
Most people will not need these details, but some specific

webdocs/install_dev.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313

1414
.. tip::
1515

16-
At the time this is being edited (late April, 2025), the default branch for GSAS-II is being changed from ``master`` to a branch called ``main``. Development tasks should be made on the ``main`` branch rather than ``master``, but if changes are made to ``master`` they can be merged into ``main`` on a case-by-case basis if requested.
16+
At the time this is being updated (April 22, 2025), the default branch for GSAS-II has been changed from ``master`` to a branch called ``main``. Development tasks should be made on the ``main`` branch rather than ``master``, but if changes are made to ``master`` they can be merged into ``main`` on a case-by-case basis if requested.
1717

18-
While bug fixes are sometimes applied directly to the ``main`` branch (and previously the ``master`` branch). The better way to make changes to GSAS-II is to make a private copy of the ``main`` branch on GitHub, this private copy is called a "fork." When you have a working version with the changes or additions that you want to make, you then issue an invitation to have your changes incorporated into the ``main`` branch. That invitation is called a "pull request" on GitHub, as you wish to have your changes pulled into the central GSAS-II version. You are very much encouraged to try your hand at working on improvements to GSAS-II.
18+
While bug fixes are sometimes applied directly to the ``main`` branch (and previously the ``master`` branch). The better way to make changes to GSAS-II is to make a private copy of the ``main`` branch on GitHub; this private copy is called a "fork." When you have a working version with the changes or additions that you want to make, you then issue an invitation to have your changes incorporated into the ``main`` branch. That invitation is called a "pull request" on GitHub, as you wish to have your changes pulled into the central GSAS-II version. You are very much encouraged to try your hand at working on improvements and fixes to GSAS-II.
1919

2020
This documentation section describes the steps needed to "fork a copy" of the GSAS-II repository in your own GitHub account. This means you will establish a private copy of GSAS-II. When you have reached a good point to share what you have done, and provide a "pull request" it allows the GSAS-II developers access to your working version so that the changes can be considered and potentially included into the main distribution.
2121

@@ -75,8 +75,8 @@ To clone GSAS-II from your forked copy use commands similar to the following::
7575
git clone [email protected]:MyRepo/GSAS-II.git
7676
cd GSAS-II
7777

78-
This will create directory ``dev/GSAS-II`` with a copy of your fork. The GSAS-II Python files will be in ``dev/GSAS-II/GSASII``. Note that when the GSAS-II Python files are cloned from a GitHub repo, the GSAS-II binary files are not be downloaded. However, when GSAS-II is first run, it will provide an opportunity to do this, provided you have used supported combinations of Python and numpy. If not, you may compile the binary files yourself, `as described here
79-
<https://advancedphotonsource.github.io/GSAS-II-tutorials/compile.html>`_. The
78+
This will create directory ``dev/GSAS-II`` with a copy of your fork. The GSAS-II Python files will be in ``dev/GSAS-II/GSASII``. Note that when the GSAS-II Python files are cloned from a GitHub repo, the GSAS-II binary files are not be downloaded. However, when GSAS-II is first run, it will provide an opportunity to do this, provided you have used supported combinations of Python and numpy. If not, you may compile the binary files yourself,
79+
`as described here. <https://advancedphotonsource.github.io/GSAS-II-tutorials/compile.html>`_ The
8080
:ref:`section below on use of pixi <pixi installation>` provides an alternate way install GSAS-II including compilation of the binaries. It is both very quick and quite convenient.
8181

8282
To run this copy of GSAS-II, you will use a command such as::
@@ -181,7 +181,7 @@ After one of the above install commands is used, the following commands can be u
181181
``pixi run test``
182182

183183
Runs the GSAS-II self-test suite (takes 1-2 minutes typically to complete.)
184-
See :ref:`example output here<example_pytest_output>`.
184+
See :ref:`example output here<example_pytest_output>`_.
185185

186186
``pixi run ui``
187187

@@ -212,7 +212,7 @@ By default, the commands above will install and run GSAS-II with Python 3.13 (at
212212
Developing GSAS-II inside VSCode
213213
==============================================
214214

215-
Visual Studio Code (VSCode) is a free code development environment that is available on all major platforms where GSAS-II runs. Yuanpeng Zhang (ORNL) has written some notes on how to :ref:`make GSAS-II run in the VSCode debugger <https://iris2020.net/2025-04-21-gsasii_dev_new/>`.
215+
Visual Studio Code (VSCode) is a free code development environment that is available on all major platforms where GSAS-II runs. Yuanpeng Zhang (ORNL) has written some notes on how to :ref:`make GSAS-II run in the VSCode debugger <https://iris2020.net/2025-04-21-gsasii_dev_new/>`_.
216216

217217
Note that if you have used the gsas2main installer to place GSAS-II at ``~/g2main`` then you can use the Python installation there (Mac/Linux: ``/Users/toby/G2/g2main/bin/python``; Windows: ``c:\\Users\\toby\\g2main\\python.exe``)
218218
to run the debugger rather than install a new conda environment as he does.

0 commit comments

Comments
 (0)