change install info from gsas2full to gsas2main

briantoby · briantoby · commit 947a15486ec5 · 2025-04-22T20:19:35.000-05:00
diff --git a/webdocs/compile.rst b/webdocs/compile.rst
@@ -90,17 +90,17 @@ needed for compilation (for example homebrew) and one can use separate
 environments for compilation and for running GSAS-II, below a single
 environment is used and all software is loaded via conda.
 
-Note that if the gsas2full installer is used, this can replace
+Note that if the gsas2main installer is used, this can replace
 steps (1) and (3), below. In that case use command::
 
-    source .../g2full/bin/activate
+    source .../g2main/bin/activate
 
-to activate Python/conda, where ``.../g2full`` is the location where gsas2full was
+to activate Python/conda, where ``.../g2main`` is the location where gsas2main was
 installed. And in place of step (3) use command::
 
-    cd .../g2full/GSAS-II
+    cd .../g2main/GSAS-II
     
-where again ``.../g2full`` is the location where gsas2full was installed. 
+where again ``.../g2main`` is the location where gsas2main was installed. 
 
 1.
 Install an initial, bare-bones Python environment
@@ -266,17 +266,17 @@ needed for compilation, but use of conda will be much simpler, but
 will require use of command-line commands (in a cmd.exe window, the
 commands have not been worked out if they will done with PowerShell). 
 
-Note that if the gsas2full installer is used, this can replace
+Note that if the gsas2main installer is used, this can replace
 steps (1) and (2), below. In that case, use command::
 
-    ...\g2full\Scripts\activate
+    ...\g2main\Scripts\activate
 
-to activate Python/conda, where ``...\g2full`` is the location where gsas2full was
+to activate Python/conda, where ``...\g2main`` is the location where gsas2main was
 installed. And in place of step (3) use command::
 
-    cd ...\g2full\GSAS-II
+    cd ...\g2main\GSAS-II
     
-where again ``...\g2full`` is the location where gsas2full was installed. 
+where again ``...\g2main`` is the location where gsas2main was installed. 
 
 1.
 Install miniforge
diff --git a/webdocs/developers.rst b/webdocs/developers.rst
@@ -32,7 +32,7 @@ site. These documents are available in a number of ways:
 * `Download as an electronic book
   <https://gsas-ii.readthedocs.io/_/downloads/en/latest/epub/>`_ (Epub format). 
 
-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,
+If you use any of the self-installer options (gsas2main, 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,
 the command for this is::
 
     git remote set-url origin git@github.com:AdvancedPhotonSource/GSAS-II.git
diff --git a/webdocs/help.rst b/webdocs/help.rst
@@ -28,9 +28,9 @@ On windows
 At present, two windows .BAT files are created in the directory where
 GSAS-II is installed, one named `Reset2FreshGSASII.bat` the other
 `start_G2_bootstrap.bat`. Thus, if GSAS-II is installed in directory 
-`C:\Users\toby\gsas2full` the files will be named
-`C:\Users\toby\gsas2full\Reset2FreshGSASII.bat` and
-`C:\Users\toby\gsas2full\start_G2_bootstrap.bat`.
+`C:\Users\toby\gsas2main` the files will be named
+`C:\Users\toby\gsas2main\Reset2FreshGSASII.bat` and
+`C:\Users\toby\gsas2main\start_G2_bootstrap.bat`.
 Either will restore the GSAS-II files, but the
 `Reset2FreshGSASII` file, will ask you to confirm before acting. The
 files can run by locating them in the Windows File Explorer and
@@ -44,8 +44,8 @@ At the time this is being written, an error prevents the script from
 running, but this can be corrected by editing the `reset-gsasII.sh`
 file manually (see below). Note that this file is placed in the `bin` directory
 immediately below the GSAS-II installation directory. Thus, if
-GSAS-II is installed at location `/Users/toby/G2/gsas2full` then the
-file will be named `/Users/toby/G2/gsas2full/bin/reset-gsasII.sh`. (It
+GSAS-II is installed at location `/Users/toby/G2/gsas2main` then the
+file will be named `/Users/toby/G2/gsas2main/bin/reset-gsasII.sh`. (It
 will appear in the path if conda is initialized.) Depending on the OS,
 it may be possible to locate and run this file in a system-supplied
 file browser, or type the file name into a terminal window. 
@@ -55,10 +55,10 @@ lines appear as::
 
   # Commands to run GSAS-II load/update process
   source /bin/activate base
-  /Users/toby/G2/gsas2full/bin/python /Users/toby/G2/gsas2full/gitstrap.py --reset
+  /Users/toby/G2/gsas2main/bin/python /Users/toby/G2/gsas2main/gitstrap.py --reset
 
 The second line should be changed as follows::
 
   # Commands to run GSAS-II load/update process
-  source /Users/toby/G2/gsas2full/bin/activate base
-  /Users/toby/G2/gsas2full/bin/python /Users/toby/G2/gsas2full/gitstrap.py --reset
+  source /Users/toby/G2/gsas2main/bin/activate base
+  /Users/toby/G2/gsas2main/bin/python /Users/toby/G2/gsas2main/gitstrap.py --reset
diff --git a/webdocs/index.rst b/webdocs/index.rst
@@ -58,7 +58,7 @@ bugs.
 Installing GSAS-II: Overview
 ============================================
 
-There are several different ways to install GSAS-II, as are outlined below. Most people will use the GSAS2FULL installer
+There are several different ways to install GSAS-II, as are outlined below. Most people will use the GSAS2MAIN installer
  
 .. toctree::
    :maxdepth: 3
diff --git a/webdocs/install-g2f-linux.rst b/webdocs/install-g2f-linux.rst
@@ -7,7 +7,7 @@
    :alt: GSAS-II logo
    :align: right
 
-Linux GSAS2FULL Installation Details
+Linux GSAS2MAIN Installation Details
 ========================================================
 The exact details for how the installation is performed will depend on "flavor" of Linux in use. Here I am using Ubuntu.
 
@@ -18,10 +18,10 @@ The exact details for how the installation is performed will depend on "flavor"
 
 1) In a terminal window paste the commands::
 
-     g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2full-Latest-Linux-x86_64.sh"
-     curl -L "$g2" > /tmp/g2.sh; bash /tmp/g2.sh -b -p ~/g2full
+     g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2main-Latest-Linux-x86_64.sh"
+     curl -L "$g2" > /tmp/g2.sh; bash /tmp/g2.sh -b -p ~/g2main
 
-   as seen to right. Note that I have chosen to install in location ``~/g2full`` (which is subdirectory ``g2full`` in my home directory), but you can install this where you prefer.
+   as seen to right. Note that I have chosen to install in location ``~/g2main`` (which is subdirectory ``g2main`` in my home directory), but you can install this where you prefer.
    
 .. raw:: html
 
diff --git a/webdocs/install-g2f-mac.rst b/webdocs/install-g2f-mac.rst
@@ -7,7 +7,7 @@
    :alt: GSAS-II logo
    :align: right
 
-MacOS GSAS2FULL Installation Details
+MacOS GSAS2MAIN Installation Details
 ========================================================
 
 .. image:: ./mac_inst_images/1.png
@@ -29,15 +29,15 @@ MacOS GSAS2FULL Installation Details
 
 2) Into the terminal window paste these commands (for an ARM aka "Apple Silicon" or M1, M2,... Mac)::
      
-     g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2full-Latest-MacOSX-arm64.sh"
-     curl -L "$g2" > /tmp/g2.sh; bash /tmp/g2.sh -b -p ~/g2full
+     g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2main-Latest-MacOSX-arm64.sh"
+     curl -L "$g2" > /tmp/g2.sh; bash /tmp/g2.sh -b -p ~/g2main
 
    Or on an older Intel Mac::
      
-     g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2full-Latest-MacOSX-x86_64.sh"
-     curl -L "$g2" > /tmp/g2.sh; bash /tmp/g2.sh -b -p ~/g2full
+     g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2main-Latest-MacOSX-x86_64.sh"
+     curl -L "$g2" > /tmp/g2.sh; bash /tmp/g2.sh -b -p ~/g2main
   
-   as seen to right. If you are not sure which you have, use "About This Mac" and look for the 1st line which will say "Chip" or "Processor" and will either list Intel or M1, M2,... Note that I have chosen to install in location ``~/g2full`` (which is subdirectory ``g2full`` in my home directory), but you can install where you prefer. Note that nothing happens until the Return key is pressed.   
+   as seen to right. If you are not sure which you have, use "About This Mac" and look for the 1st line which will say "Chip" or "Processor" and will either list Intel or M1, M2,... Note that I have chosen to install in location ``~/g2main`` (which is subdirectory ``g2main`` in my home directory), but you can install where you prefer. Note that nothing happens until the Return key is pressed.   
 
 .. raw:: html
 
diff --git a/webdocs/install-g2f-win.rst b/webdocs/install-g2f-win.rst
@@ -7,10 +7,10 @@
    :alt: GSAS-II logo
    :align: right
 
-Windows GSAS2FULL Installation Details
+Windows GSAS2MAIN Installation Details
 ========================================================
 
-1 ) In your favorite browser click on the link to the download file, https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2full-Latest-Windows-x86_64.exe.
+1 ) In your favorite browser click on the link to the download file, https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2main-Latest-Windows-x86_64.exe.
 
 .. image:: ./win_inst_images/1.png
    :scale: 25 %
diff --git a/webdocs/install.rst b/webdocs/install.rst
@@ -11,17 +11,17 @@ Installing GSAS-II: Overview
 
 Running GSAS-II requires a number of coordinated installation steps and there are many different ways this can be accomplished. One needs not only the necessary Python source code for GSAS-II, but a Python interpreter that includes a number of "add-on" Python packages for additional capabilities. This much match the operating system for the computer where the software will be run. Further, GSAS-II requires that a small amount of its code be compiled, typically for speed and this must be matched both the computer OS and to the Python version. Here I outline different a few different approaches.
 
-.. index:: gsas2full installer
+.. index:: gsas2main installer
 
-GSAS2FULL installer
+GSAS2MAIN installer
 =======================
 
-Most users of GSAS-II are seeking a simple way to install and run the software and can live with the idea that they may have duplicated Python installations (several hundreds of MB each) on their computer. The GSAS2FULL self-installer provides simple installation and can be `downloaded from here <https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/latest>`_. Brief installation instructions are outlined below with links to more complete instructions:
+Most users of GSAS-II are seeking a simple way to install and run the software and can live with the idea that they may have duplicated Python installations (several hundreds of MB each) on their computer. The GSAS2MAIN self-installer provides simple installation and can be `downloaded from here <https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/latest>`_. Brief installation instructions are outlined below with links to more complete instructions:
 
 Windows
 -----------
 
-For Windows download file https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2full-Latest-Windows-x86_64.exe and run it.
+For Windows download file https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2main-Latest-Windows-x86_64.exe and run it.
 After the installer is started 
 You will have a choice for where to install the software (the default is usually OK, but something like ``c:\software`` might be better, if your computer security allows that.)
 
@@ -32,42 +32,42 @@ MacOS
 
 For ARM (M1,...) MacOS use a command such as::
   
-    g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2full-Latest-MacOSX-arm64.sh"
+    g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2main-Latest-MacOSX-arm64.sh"
     curl -L "$g2" > /tmp/g2.sh; bash /tmp/g2.sh -b -p <install-loc>
 
 For older Intel MacOS use a command such as:: 
 
-    g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2full-Latest-MacOSX-x86_64.sh"
+    g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2main-Latest-MacOSX-x86_64.sh"
     curl -L "$g2" > /tmp/g2.sh; bash /tmp/g2.sh -b -p <install-loc>
 
   
 Note that the ``MacOSX-x86_64.sh`` installer will also run on "Apple Silicon" processors, but significantly more slowly.
    
 where:
 
- <install-loc> is where you want to install the software. (Use of ``~/g2full``, a subdirectory named ``g2full`` in your home directory is a good choice.) After installation is complete, you will be given a chance to place a shortcut for GSAS-II into the MacOS dock.
+ <install-loc> is where you want to install the software. (Use of ``~/g2main``, a subdirectory named ``g2main`` in your home directory is a good choice.) After installation is complete, you will be given a chance to place a shortcut for GSAS-II into the MacOS dock.
 
 More complete installation instructions are provided for `MacOS separately <install-g2f-mac.html>`_.
 
 Linux
 --------------------
 
-To install GSAS2FULL in Linux use a command such as::
+To install GSAS2MAIN in Linux use a command such as::
   
-  g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2full-Latest-Linux-x86_64.sh"
+  g2="https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/download/v1.0.1/gsas2main-Latest-Linux-x86_64.sh"
   curl -L "$g2" > /tmp/g2.sh; bash /tmp/g2.sh -b -p <install-loc>
   
 where:
 
- <install-loc> is where you want to install the software. (Use of ``~/g2full``, a subdirectory named ``g2full`` in your home directory is a good choice.) 
+ <install-loc> is where you want to install the software. (Use of ``~/g2main``, a subdirectory named ``g2main`` in your home directory is a good choice.) 
 
 More complete installation instructions are provided for `Linux separately <install-g2f-linux.html>`_.
 
 
-GSAS2FULL Additional Details
+GSAS2MAIN Additional Details
 ----------------------------------------
 
-The pages listed below go through the GSAS2FULL installation process on each identified platform in much greater detail.
+The pages listed below go through the GSAS2MAIN installation process on each identified platform in much greater detail.
 
 .. index:: gsas2pkg installer
 .. toctree::
@@ -91,7 +91,7 @@ After this command is run, use command ``conda activate GSASII`` to access the
 conda environment that has been created. On Linux and MacOS computers, two shortcut commands will then be available in the path, The first command, ``gsasII.sh``, which will start GSAS-II. This can optionally be used as ``gsasII.sh project.gpx`` to open existing project file ``project.gpx`` in GSAS-II. The second command, ``reset-gsasII.sh``  will rarely be used. This command will download the latest version of GSAS-II and update to that version, replacing any locally modified files with the original versions. This can be used to update GSAS-II when the program will not start, so the normal Help->Update menu command cannot be accessed. (Shortcuts available with gsas2pkg v5.1+.)
 
 Note that on MacOS, a Mac app is also created and is displayed in the Finder
-`see steps 5 & 6 here <install.html#macos-gsas2full-installation-details>`_. This app can be used to start GSAS-II from the dock or desktop.
+`see steps 5 & 6 here <install.html#macos-gsas2main-installation-details>`_. This app can be used to start GSAS-II from the dock or desktop.
 
 .. index:: Installing GSAS-II with gitstrap.py
 
@@ -133,7 +133,15 @@ Older installers
 =================================
 
 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.
-If you previously installed GSAS-II from that server, you will be shown a message when trying to update that you should reinstall GSAS-II as described above. 
+If you previously installed GSAS-II from that server, you will be
+shown a message when trying to update that you should reinstall
+GSAS-II as described above.
+
+Likewise, the gsas2full installer was used to install GSAS-II from the
+older ``master`` branch. Use of this installer is discouraged. If you
+install GSAS-II from that branch, you will be
+be offered the opportunity to add needed Python packages and switch to
+the ``main`` branch when trying to update GSAS-II from the help menu.
 
 Installation details
 ====================================
diff --git a/webdocs/install_dev.rst b/webdocs/install_dev.rst
