|
4 | 4 | :align: right |
5 | 5 |
|
6 | 6 | ====================================== |
7 | | -Documentation for GSAS-II Developers |
| 7 | +Notes for GSAS-II Developers |
8 | 8 | ====================================== |
9 | 9 |
|
10 | | -Note the `documentation web page <documentation.html>`_, as the |
11 | | -"Developer's Documentation" document, available in several formats, is |
12 | | -of very significant value for code development. |
| 10 | +We welcome cooperation from people interested in developing or |
| 11 | +extending GSAS-II. The code is open source and we are happy to review |
| 12 | +submitted code or consider collaborations. The ideal mechanism for |
| 13 | +contributions is to clone the |
| 14 | +`GitHub repo <https://github.com/AdvancedPhotonSource/GSAS-II>`_ and |
| 15 | +then create a pull request, but small changes can be considered via |
| 16 | +e-mail. |
| 17 | + |
| 18 | +Note that you can have multiple copies of GSAS-II installed on your |
| 19 | +computer so that you can compare running a local development version |
| 20 | +against the latest distribution. See the web page on |
| 21 | +`Installing GSAS-II for code development <install_dev.html>`_ for more |
| 22 | +details. |
| 23 | + |
| 24 | +The Sphinx documentation for the GSAS-II source code will be of |
| 25 | +significant value for people attempting to work their way through the |
| 26 | +codebase. This is found on the wonderful “Read The Docs” web |
| 27 | +site. These documents are available in a number of ways: |
| 28 | + |
| 29 | +* `Access online <https://gsas-ii.readthedocs.io>`_ (HTML) |
| 30 | +* `Download as a PDF document |
| 31 | + <https://gsas-ii.readthedocs.io/_/downloads/en/latest/pdf/>`_ (~450 pages) |
| 32 | +* `Download as an electronic book |
| 33 | + <https://gsas-ii.readthedocs.io/_/downloads/en/latest/epub/>`_ (Epub format). |
13 | 34 |
|
14 | 35 | If you use any of the self-installer options (gsas2full, gsas2pkg or gitstrap.py), GSAS-II will be installed using https from https://github.com/AdvancedPhotonSource/GSAS-II.git. This is fine for downloading, but to be able to write to the repository, you will probably need to switch to using ssh, |
15 | 36 | the command for this is:: |
16 | 37 |
|
17 | 38 | git remote set-url origin [email protected]:AdvancedPhotonSource/GSAS-II.git |
18 | 39 |
|
19 | | - |
| 40 | +More on this is in the `Installing GSAS-II for code development <install_dev.html>`_ |
| 41 | +web page, which discusses changing the origin to your forked copy of GSAS-II. |
0 commit comments