v3.1 updates to changes log and release note

doc/DRAGONS/changes.rst

@@ -6,6 +6,200 @@
 Change Logs
 ***********
 
+3.1.0
+=====
+
+This release includes new science-approved support for GMOS longslit data,
+along with new interactive tools to optimize the spectroscopic reduction.
+The calibration service has also been refactored with significant changes that
+the user need to be aware of.  Please read on.
+
+New Features
+------------
+
+Science quality support for GMOS longslit spectroscopy.
+  Please refer to the tutorial, |GMOSLSTut|.  DRAGONS is now the official
+  software for reducing GMOS longslit data.
+
+New browser-base interactive tools to support spectroscopy.
+  The following primitives have an interactive mode that can be activated with
+  the ``-p interactive=True`` flag:
+
+  * normalizeFlat
+  * determineWavelengthSolution
+  * skyCorrectFromSlit
+  * findApertures
+  * traceApertures
+  * calculateSensitivity
+
+The GSAOI alignment and stacking is now done in DRAGONS.
+  The package ``disco_stu`` is no longer needed.  The default GSAOI recipe
+  will align and stack.  See the tutorial,  |GSAOIImgTut|
+
+The bad pixel masks are now handled as the other calibration files.
+  They are distributed through the archive instead of with the package.  They
+  are also fully integrated into the calibration service.  See the various
+  tutorials for details.
+
+The calibration service has been through a large refactor.
+  It is now possible to have the processed calibrations stored automatically
+  (was a user step before), and it possible to serially search more than one
+  database. See below for details on the new configuration file,
+  :ref:`interface_3.1`.  For usage examples, see the various tutorials.
+
+New imaging recipes.
+   For Flamingos-2, GSAOI, NIRI:
+       ``ultradeep``  See |F2ImgTut| for an example.
+   GMOS:
+       ``reduceSeparateCCDs`` and ``reduceSeparateCCDCentral`` (See |GMOSImgTut|
+       for an example.
+
+.. _interface_3.1:
+
+Interface Modifications
+-----------------------
+**recipe_system**
+
+* There has been many changes to the calibration service.  Most of them are
+  internal but the one big change for the users is the configuration file.
+  The configuration file now ``~/.dragons/dragonrc`` (was
+  ~/.geminidr/rsys.cfg).  The syntax inside the file has changed a bit too.
+
+  * New ``[interactive]`` section.  This is used to set the browser that the
+    interactive tools will use.  Valid browsers: "safari", "chrome", "firefox"::
+
+       [interactive]
+       browser = safari
+  * New format for the ``[calib]`` section.  The variable is now named
+    ``databases``, plural, and multiple databases can be defined to be searched
+    serially.  One database per line.  The name of the database can now be
+    set by the user instead of being hardcoded to ``cal_manager.db``.  Two
+    new flags can be set ``get`` and ``store`` to, respectively, "get"
+    processed calibrations for that database, and "store" them to it. ::
+
+      [calib]
+      databases = /Users/someone/data/myprogramcal.db get store
+                  https://archive.gemini.edu get
+
+
+**geminidr**
+
+* You must now ensure that the bad pixel masks (BPMs) can be found in a
+  database.  The BPMs are no longer distributed with the software.  They are
+  downloadable from the archive.  See the "Tips and Tricks" section of any
+  tutorial (except Flamingos-2).
+
+
+Improvements
+------------
+
+**geminidr**
+
+* As mentioned above, the BPMs are now stored in archive.  Using the archive to
+  distribute the BPMs will allow us to make new BPMs available rapidly, for
+  example, when new bad columns appear in GMOS CCDs, after a catastrophic event
+  like the amplifier 5 failure in January 2022, or when the CCDs are replaced.
+
+* Several new or improved algorithms compared to 3.0.x.
+
+Documentation
+-------------
+**geminidr**
+
+* There has been some restructuring of the tutorials to better present
+  multiple examples within a tutorial.
+
+* Several new examples for Flamingos-2 and GMOS imaging tutorials.
+
+* Several science quality examples for the new GMOS longslit spectroscopy
+  support.
+
+**astrodata**
+
+* The three previously separated ``astrodata`` manuals, "Cheat Sheet",
+  "User Manual", and "Programmer Manual" have been consolidated into one
+  master document.  Please fix your link, |ADMaster|.
+
+
+Compatibility
+-------------
+* DRAGONS v3.1 is compatible with Python 3.7 to 3.10.  The pre-release tests
+  were done with Python 3.10.  Please note that DRAGONS v3.1.x will the last
+  minor version to support Python v3.7.
+
+* The conda package was built and tested against conda-forge dependencies.
+  STScI has dropped support of the astroconda channel.  Make sure that you
+  adjust your conda channels.
+
+  If you already have a ``~/.condarc`` file, make sure that the channels are
+  set as follows::
+
+    channels:
+      - http://astroconda.gemini.edu/public
+      - https://conda.anaconda.org/conda-forge
+      - defaults
+
+  If you are installing conda for the first time, see the installation
+  instructions here:  |RSUserInstall|
+
+3.0.4
+=====
+
+Bug Fixes
+---------
+
+**geminidr.gmos**
+
+* Allow ``maskFaultyAmp`` to work on astrodata objects with no mask.
+
+* Fix ``maskFaultyAmp`` to work on central stamp ROI.
+
+**geminidr.core**
+
+* Adjust minimal dither separation for fringe frame creation.
+
+**astrodata**
+
+* Fix AstroData ``info()`` method to handle extensions with no pixels.  Required
+  for upcoming GHOST data.
+
+Improvements
+------------
+
+**geminidr.gmos**
+
+* Update to the GMOS-S Hamamatsu 4x4 imaging illumination mask.
+
+**geminidr.core**
+
+* Improve behavior of ``addIllumMaskToDQ`` to cope with larger shifts due to
+  recent GMOS misalignment.
+
+* Add provenance for the flux calibration step.
+
+**gemini_instruments.f2**
+
+* Switched to using WAVELENG for central_wavelength for F2 to be better aligned
+  with the instrument and observatory software.
+
+**gempy**
+
+* In ``dataselect``, make the disperser selection default to the "pretty"
+  mode rather than requiring the full component ID.
+
+Quality Assessment Pipeline
+---------------------------
+
+* Increase robustness of measureIQ for 2D spectra.
+
+* Interface improvements to the QAP Specviewer.
+
+* Fix missing ``maskFaultyAmp`` in some QAP recipes.
+
+* Limit the number of aperture/spectra selected in GMOS LS QA recipes for
+  performance reasons.
+
+
 3.0.2 and 3.0.3
 ===============
 

doc/DRAGONS/conf.py

@@ -50,7 +50,7 @@
 
 # General information about the project.
 project = 'DRAGONS'
-copyright = '2021, Association of Universities for Research in Astronomy'
+copyright = '2023, Association of Universities for Research in Astronomy'
 
 # Note that AURA owns the Copyright, not you.
 
@@ -61,7 +61,7 @@
 # The short X.Y version.
 version = '3.1'
 # The full version, including alpha/beta/rc tags.
-release = '3.1.0-dev'
+release = '3.1.0'
 #rtdurl = 'v'+release
 #rtdurl = 'release-'+release
 rtdurl = 'latest'
@@ -295,7 +295,7 @@ def setup(app):
 
 .. |GMOSLSTut| replace:: :raw-html:`<a href="http://GMOSLS-DRTutorial.readthedocs.io/en/{v}">GMOS Longslit Data Reduction Tutorial</a>`
 
-
+.. |ADMaster| replace:: :raw-html:`<a href="http://astrodata.readthedocs.io/en/{v}">Astrodata Manual</a>`
 .. |ADCheat| replace:: :raw-html:`<a href="http://astrodata.readthedocs.io/en/{v}/cheatsheet.html">AstroData Cheat Sheet</a>`
 .. |ADUser| replace:: :raw-html:`<a href="http://astrodata.readthedocs.io/en/{v}/usermanual/index.html">Astrodata User Manual</a>`
 .. |ADProg| replace:: :raw-html:`<a href="http://astrodata.readthedocs.io/en/{v}/progmanual/index.html">Astrodata Programmer Manual</a>`

doc/DRAGONS/releasenotes.rst

@@ -6,6 +6,49 @@
 Release Notes
 *************
 
+V3.1.0
+======
+
+This new release includes many new features, new support, various improvements
+and new tutorials.  See the :ref:`changes` for all the details.
+
+This update of DRAGONS has four big changes over V3.0:
+
+* New science quality reduction for GMOS longslit data
+* The alignment and stacking of GSAOI data is now done within DRAGONS and the]
+  use of ``disco_stu`` is no longer required.
+* The calibration service has gone through a major refactoring.  Of direct
+  impact to the users, DRAGONS can now automatically store processed
+  calibrations and the configuration file is now ``~/.dragons/dragonsrc``
+* Static Bad pixel masks (BPMs) are now handled as calibrations and are
+  distributed via the archive rather than being packaged with the software
+  allowing for faster BPM-update response.
+
+With this release, DRAGONS offers support for:
+
+Science Quality reduction
+   * GMOS imager
+   * NIRI imager
+   * GSAOI imager
+   * F2 imager
+   * GMOS longslit spectrograph
+
+For imaging and GMOS longslit spectroscopy, this software should be used
+instead of the Gemini IRAF package.
+
+To install DRAGONS, please follow the installation guide provided in the
+Recipe System User Manual:
+
+  |RSUserInstall|.
+
+
+V3.0.4
+======
+This patch release includes several small fixes and improvements, many
+related to the Quality Assessment Pipeline run internally at Gemini.
+Provenance for flux calibration is now included.  The patch is recommended
+to all but not critical for most.
+
 V3.0.2 and V3.0.3
 =================
 Note that 3.0.2 was found to have one broken recipe, 3.0.3 fixes it.