add a statistics section to the web docs; misc web cleanup

Author: briantoby

webdocs/About.notes

@@ -0,0 +1,18 @@
+cd 
+wc -l *.py imports/*.py exports/*.py
+wc -l *GUI.py
+wc -l *.f* powsubs/*.f* spsubs/*.f* texturesubs/*.f* 
+wc -l fmask.c
+
+
+wc -l NIST_profile/*.py k_vec_solve/*.py G2shapes.py
+wc -l  pydiffax.for DIFFaXsubs/* NISTlatsubs/*
+
+ls ~/G2/GSASII-tutorials/*/*.ht* ~/G2/GSASII-tutorials/MDtutorials/*/*.md | wc
+wc ~/G2/GSASII-tutorials/MDtutorials/*/*.md
+wc -l ~/G2/GSASII-tutorials/*/*.ht*
+
+wc  ~/G2/GSASII-tutorials/MDhelp/docs/*.md
+
+wc  ~/G2/GSASII-tutorials/webdocs/*.rst
+figure

webdocs/AboutGSASII.rst

@@ -0,0 +1,50 @@
+.. image:: ./images/gsas2.png
+   :scale: 25 %
+   :alt: GSAS-II logo
+   :align: right
+           
+GSAS-II Citations
+====================================
+
+.. index:: Impact
+
+The GSAS-II usage statistics must be considered in the context of the software that it replaced, GSAS/EXPGUI. It is difficult to catalog citations to GSAS, since it was
+only published as a Los Alamos document report starting in 1985. However, EXPGUI, a graphical user interface to GSAS, was published and captures a large fraction of the GSAS user base. While GSAS-II was started as a project in ~2008, it was far from complete until around 2013 when first published:
+
+     Toby, B. H., & Von Dreele, R. B. (2013). "GSAS-II: the genesis of a modern open-source all purpose crystallography software package". *Journal of Applied Crystallography*, **46**\(2), 544-549. `doi: 10.1107/S0021889813003531 <https://doi.org/10.1107/S0021889813003531>`_
+
+Citations to this paper and the 2001 paper by B.H. Toby are tracked by the Web of Science and are our best way to track use of GSAS/EXPGUI and GSAS-II. Google Scholar citation rates are significantly higher, but their accuracy is unknown.      
+While GSAS-II has been recommended as a replacement for GSAS/EXPGUI since ~2015, when GSAS-II incorporated pretty much all of the GSAS/EXPGUI capabilities judged still relevant, but for quite a few years after that, both EXPGUI and GSAS-II usage continued to grow, as shown in the citation rate plot below:
+
+.. image:: ./images/EG_Cites.pdf
+   :alt: Citations of EXPGUI and GSAS-II 
+   :align: right
+
+Only in the past few years has EXPGUI use started to fall. GSAS-II use continues to grow and at a rate considerably higher than the fall-off in EXPGUI use. 
+           
+GSAS-II Code Statistics
+====================================
+
+.. index:: Code statistics
+
+As of October 2025, GSAS-II codebase contains:
+
+  * 170,000 lines of Python code, of which 65,000 are used for the GUI.
+  * 6,000 lines of Fortran code
+  * 450 lines of C code
+
+  Some of the compiled code (Fortran and C) provides computational kernels for that would be too slow if completed in Python. The majority of the Fortran code is a group theory analysis routine developed by Allen Larson to derive symmetry from Hermann-Mauguin space group symbols (short or long and including non-standard settings) developed for the NRCVAX program. This code was also used in GSAS, but has been updated to correct for errors. 
+
+The documentation material consists of:
+ 
+  * 14,000 words of web documentation
+  * 50,000 words of context-specific help (~100 pages formatted)
+  * 62 tutorials (140,000 lines of HTML and 500 words of MarkDown)
+  * ~450 pages (as .pdf) of code documentation, generated by Sphinx from the Python source code
+
+  
+Vendored (externally produced, but distributed with GSAS-II) utilities included are composed of:
+
+  * 4,000 lines of Python code
+  * 10,000 lines of Fortran code
+  * 100 lines of Cython

webdocs/conf.py

@@ -6,10 +6,10 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'GSAS-II web documentation'
-copyright = '2024 by Argonne National Laboratory'
+project = 'GSAS-II'
+copyright = '2025 by Argonne National Laboratory'
 author = 'Brian H. Toby'
-release = '1.0'
+release = 'v5.6.0'
 
 
 # -- General configuration ---------------------------------------------------

webdocs/documentation.rst

@@ -28,7 +28,8 @@ distributed with the program, as well as can be `viewed here
 <help/index.html>`_. These help pages are not complete for all
 sections of the code,
 but do provide at least some information on how every section of the program
-works. The help information can also be viewed `as a PDF document
+works. The help information can also be viewed as a PDF document
+`(Help as PDF)
 <https://advancedphotonsource.github.io/GSAS-II-tutorials/docs/GSASII-help.pdf>`_.
 
 Note that the help documentation was recently reformatted and updated
@@ -46,10 +47,10 @@ Developer's Documentation
 and RestructuredText documentation files are found on the `"Read The
 Docs" web site <https://gsas-ii.readthedocs.io>`_. The documentation
 can also be downloaded as a
-`PDF document <https://gsas-ii.readthedocs.io/_/downloads/en/latest/pdf/>`_
+PDF document `(Code Manual as PDF) <https://gsas-ii.readthedocs.io/_/downloads/en/latest/pdf/>`_
 or as
-`an electronic book <https://gsas-ii.readthedocs.io/_/downloads/en/latest/epub/>`_
-(Epub format). 
+an electronic book `(Code Manual as e-book
+<https://gsas-ii.readthedocs.io/_/downloads/en/latest/epub/>`_, Epub format). 
 Regardless of the format, this provides very useful documentation for
 code developers, for people interested in creating GSAS-II scripts, or
 incorporating GSAS-II capabilities into their software, or for those
@@ -65,10 +66,10 @@ Documentation described immediately above, but an
 `abridged version of the web site
 <https://gsas-ii-scripting.readthedocs.io/en/latest/>`_ with 
 only sections relevant to scripting is also available. This abridged
-version can also be downloaded as a `PDF document
+version can also be downloaded as a PDF document `(Scripting Manual as PDF) 
 <https://gsas-ii-scripting.readthedocs.io/_/downloads/en/latest/pdf/>`_ or as
-`an electronic book
-<https://gsas-ii-scripting.readthedocs.io/_/downloads/en/latest/epub/>`_  (Epub
+an electronic book `(Scripting Manual as e-book
+<https://gsas-ii-scripting.readthedocs.io/_/downloads/en/latest/epub/>`_,  Epub
 format). 
 
 

webdocs/images/EG_Cites.pdf

@@ -41,13 +41,15 @@ well as extensive visualization capabilities.
    compile.rst 
    misc.rst 
    master2main.rst 
+   AboutGSASII.rst
 
 .. tip::
     Please help us by citing:
 
      .. index:: Citation
 
-    Toby, B. H., & Von Dreele, R. B. (2013). "GSAS-II: the genesis of a modern open-source all purpose crystallography software package". *Journal of Applied Crystallography*, **46**\(2), 544-549. doi:10.1107/S0021889813003531
+    Toby, B. H., & Von Dreele, R. B. (2013). "GSAS-II: the genesis of a modern open-source all purpose crystallography software package". *Journal of Applied Crystallography*, **46**\(2), 544-549. `DOI: 10.1107/S0021889813003531 <https://doi.org/10.1107/S0021889813003531>`_
+
 
        Note that some sections of the program utilize externally provided
        codes or reference later work, with citations provided
@@ -163,3 +165,13 @@ Other things related to GSAS-II can be found here.
 .. toctree::
 
    master2main.rst 
+
+
+GSAS-II Statisics: Usage & Size
+======================================
+
+Some statistics about GSAS-II are included here.
+
+.. toctree::
+
+   AboutGSASII.rst

webdocs/index.rst

@@ -140,7 +140,7 @@ The code in the ``main`` includes setup files for `Pixi <https://pixi.sh>`_, whi
 It is particularly convenient for GSAS-II software development. 
 There are many ways to install Pixi, as listed `here <https://pixi.sh>`_, or by using the ``conda install pixi`` command, or homebrew, etc. 
 
-Once pixi is installed, it can be used to setup and run GSAS-II, with commands as described below. These commands download GSAS-II from GitHub, install it, including compiling the files locally, then runs the self-tests and then finally starts the GSAS-II GUI: 
+Once pixi is installed, it can be used to setup and run GSAS-II, with commands as described below. These commands download GSAS-II from GitHub, install it, including compiling the files locally, then runs the self-tests and then finally starts the GSAS-II GUI:: 
 
         cd <install-location>
         git clone --depth 1 [email protected]:AdvancedPhotonSource/GSAS-II.git

webdocs/install_dev.rst

@@ -36,8 +36,7 @@ On April 22, 2025 GSAS-II made a transition from development on a branch named "
 
 * Scripting API: several commands now can read input files supplied as a URL; preferred orientation correction now are available in the API.
 
-* Scripting: Slightly different code is now needed to access the GSASIIscriptable module. The developers documentation for GSAS-II (on https://gsas-ii.readthedocs.io and 
-https://gsas-ii-scripting.readthedocs.io) has been revised to show this. 
+* Scripting: Slightly different code is now needed to access the GSASIIscriptable module. The developers documentation for GSAS-II (on https://gsas-ii.readthedocs.io and https://gsas-ii-scripting.readthedocs.io) has been revised to show this. 
 
 Below is the e-mail sent to the GSAS-II mailing list concerning the above changes.