Preparing to release ASP 3.1.0

Author: oleg-alexandrov

INSTALLGUIDE.rst

@@ -19,8 +19,8 @@ from:
 No installation steps or administrative rights are necessary.  Extract
 the archive, and run the executables in the ``bin`` subdirectory as::
 
-    tar -xvf StereoPipeline-3.0.0-2021-10-15-x86_64-Linux.tar.bz2
-    ./StereoPipeline-3.0.0-2021-10-15-x86_64-Linux/bin/stereo --help
+    tar -xvf StereoPipeline-3.1.0-2022-05-18-x86_64-Linux.tar.bz2
+    ./StereoPipeline-3.1.0-2022-05-18-x86_64-Linux/bin/stereo --help
 
 The result of the last command should be a help message.
 
@@ -63,9 +63,9 @@ found.  To do so, follow the ISIS installation instructions, but
 create a new conda environment (not the one with your current ISIS),
 and right before you would run ``conda install isis``, run ``conda
 search isis`` to find all of the versions of ISIS available for
-installation.  For example, if you wanted to install ISIS 5.0.1, and
+installation.  For example, if you wanted to install ISIS 6, and
 it is available in the ``conda search isis`` listing, you can run
-``conda install isis=5.0.1`` and then follow the remainder of the ISIS
+``conda install isis=6`` and then follow the remainder of the ISIS
 installation instructions.
 
 In closing, running the Stereo Pipeline executables only requires
@@ -176,7 +176,7 @@ Fetching pre-compiled ASP with conda
 ------------------------------------
 
 ASP's official releases can be fetched with ``conda``. The latest such
-release is version 3.0.0, published on July 27, 2021.  See
+release is version 3.1.0, published on May 18, 2022.  See
 :numref:`news` for what changed since then.  The newer functionality
 is available only with the daily build (:numref:`precompiled_binaries`).
 
@@ -237,9 +237,9 @@ environments, which you don't want.
 
 Install ASP with the command::
 
-    conda install stereo-pipeline==3.0.0
+    conda install stereo-pipeline==3.1.0
 
-This will install ASP 3.0.0 together with ISIS 5.0.1. Note that the
+This will install ASP 3.1.0 together with ISIS 6. Note that the
 latest build (see above) may have more fixes or features than this
 official release.
 
@@ -258,11 +258,11 @@ found as a set of .yaml files in the ``conda`` subdirectory of the
 Stereo Pipeline GitHub repository. So, alternatively, the installation
 can happen as::
 
-    conda env create -f asp_3.0.0_linux_env.yaml
+    conda env create -f asp_3.1.0_linux_env.yaml
 
 or::
 
-    conda env create -f asp_3.0.0_osx_env.yaml
+    conda env create -f asp_3.1.0_osx_env.yaml
 
 depending on your platform. Then invoke, as earlier::
 
@@ -293,11 +293,11 @@ The environments having the ASP dependencies are in the ``conda``
 directory of the Stereo Pipeline repository, as above. After
 downloading those, one can run on Linux::
 
-    conda env create -f asp_deps_3.0.0_linux_env.yaml
+    conda env create -f asp_deps_3.1.0_linux_env.yaml
 
 or on the Mac::
 
-    conda env create -f asp_deps_3.0.0_osx_env.yaml
+    conda env create -f asp_deps_3.1.0_osx_env.yaml
 
 This will create an ``asp_deps`` environment. Activate it with::
 
@@ -337,7 +337,7 @@ Building VisionWorkbench and Stereo Pipeline on Linux::
     $envPath/bin/git clone \
         git@github.com:visionworkbench/visionworkbench.git
     cd visionworkbench
-    git checkout 3.0.0 # check out the desired commit
+    git checkout 3.1.0 # check out the desired commit
     mkdir -p build
     cd build
     $envPath/bin/cmake ..                                             \
@@ -354,7 +354,7 @@ Building VisionWorkbench and Stereo Pipeline on Linux::
     $envPath/bin/git clone \
     git@github.com:NeoGeographyToolkit/StereoPipeline.git
     cd StereoPipeline
-    git checkout 3.0.0 # check out the desired commit
+    git checkout 3.1.0 # check out the desired commit
     mkdir -p build
     cd build
     $envPath/bin/cmake ..                                             \
@@ -374,7 +374,7 @@ Building VisionWorkbench and ASP on OSX (just as above, but omitting the compile
     $envPath/bin/git clone \
       git@github.com:visionworkbench/visionworkbench.git
     cd visionworkbench
-    git checkout 3.0.0 # check out the desired commit
+    git checkout 3.1.0 # check out the desired commit
     mkdir -p build
     cd build
     $envPath/bin/cmake ..                      \
@@ -389,7 +389,7 @@ Building VisionWorkbench and ASP on OSX (just as above, but omitting the compile
     $envPath/bin/git clone \
       git@github.com:NeoGeographyToolkit/StereoPipeline.git
     cd StereoPipeline
-    git checkout 3.0.0 # check out the desired commit
+    git checkout 3.1.0 # check out the desired commit
     mkdir -p build
     cd build
     $envPath/bin/cmake ..                             \

NEWS.rst

@@ -1,5 +1,5 @@
-Additions to the latest build (since last official release)
------------------------------------------------------------
+RELEASE 3.1.0, May 18, 2022
+----------------------------
 
 New camera additions:
   * Added support for the USGSCSM Frame, SAR, and PushFrame sensors
@@ -27,6 +27,19 @@ New tool additions:
     alignment transform type (translation, rigid, similarity, affine,
     and homography).
 
+isis:
+  * Using ISIS 6.0.0.
+
+csm:
+  * Save the camera state on multiple lines. On reading both the
+    single-line and multiple-line formats are accepted.
+  * Bundle adjustment, mapproject, and SfS with the CSM model can be
+    7-15 times faster than done with the corresponding ISIS model.
+    It is strongly suggested to use CSM for large-scale processing.
+  * Bugfix in CSM linescan implementation for some LRO NAC sensors.
+    Also replaced the fixed-point method with the secant method in the 
+    ground-to-image logic for CSM linescan cameras, which is faster. 
+
 parallel_stereo:
   * Many fixes for reliability of stereo with local epipolar alignment.
   * Added the option ``--resume-at-corr``. Start at the correlation stage
@@ -118,16 +131,6 @@ bundle_adjust:
   * Add new options for reusing a previous run:
     ``--match-files-prefix`` and ``--clean-match-files-prefix``.
 
-csm:
-  * Save the camera state on multiple lines. On reading both the
-    single-line and multiple-line formats are accepted.
-  * Bundle adjustment, mapproject, and SfS with the CSM model can be
-    7-15 times faster than done with the corresponding ISIS model.
-    It is strongly suggested to use CSM for large-scale processing.
-  * Bugfix in CSM linescan implementation for some LRO NAC sensors.
-    Also replaced the fixed-point method with the secant method in the 
-    ground-to-image logic for CSM linescan cameras, which is faster. 
-
 sfs:
   * SfS was made to work with any camera model supported by ASP,
     including for Earth. For non-ISIS and non-CSM cameras, the option

README.rst

@@ -54,7 +54,7 @@ you can add the following line to your shell configuration (e.g.,
 ``~/.bashrc``), replacing ``/path/to/StereoPipeline/bin`` with the location
 on your filesystem: ``export PATH=${PATH}:/path/to/StereoPipeline/bin``
 
-*ISIS Users*: Please install USGS ISIS version 5.0.1 or later if you
+*ISIS Users*: Please install USGS ISIS version 6 or later if you
 would like to process NASA non-terrestrial images. Users wishing to
 process Earth images, such as Digital Globe, satellites with RPC
 cameras, or various frame/pinhole cameras do not need to download

RELEASEGUIDE

@@ -95,7 +95,7 @@ https://semver.org for guidance).
     Test all binary releases on different machines by running
     StereoPipelineTest.
 
-    NOTE: The step above is done automatically by running on lunokhod2
+    NOTE: The step above is done automatically by running on lunokhod1
     the script
 
       $HOME/projects/BinaryBuilder/auto_build/launch_master.sh
@@ -108,22 +108,22 @@ The resulting release tarballs will go to BinaryBuilder/asp_tarballs.
 
 8.) Commit and tag the release in the VW and ASP repos. Example: 
 
-  git tag 3.0.0
+  git tag 3.1.0
 
 Push the tags to the remote server with: 
 
- git push origin 3.0.0 # commit to your branch
- git push god    3.0.0 # commit to main branch
+ git push origin 3.1.0 # commit to your branch
+ git push god    3.1.0 # commit to main branch
 
 (Here it is assumed that 'origin' points to your own fork and 'god'
 points to the parent repository.)
 
 If more commits were made and it is desired to apply this tag to a
 different commit, first remove the exiting tag with:
 
-  git tag -d 3.0.0
-  git push origin :refs/tags/3.0.0
-  git push god    :refs/tags/3.0.0
+  git tag -d 3.1.0
+  git push origin :refs/tags/3.1.0
+  git push god    :refs/tags/3.1.0
 
 9.) Upload the builds and the pdf documentation to GitHub, in the
 release area.
@@ -160,9 +160,9 @@ development, by updating the version number in:
 
 in both the VW and ASP repositories. 
 
-If you just released version 3.0.0, we expect that the next feature
-release will be 3.1.0, if a major release, or 3.0.1 if a minor
-release, so the version tag should be updated to 3.1.0-alpha in
+If you just released version 3.1.0, we expect that the next feature
+release will be 3.2.0, if a major release, or 3.1.1 if a minor
+release, so the version tag should be updated to 3.2.0-alpha in
 anticipation (see https://semver.org for guidance).
 
 13.) Reflect any changes in release policy by modifying this document.