update to docs in prep for 3.0.4 release.

GeminiDRSoftware · Nov 9, 2022 · d4c780b · d4c780b
1 parent c2a46f7
commit d4c780b
Show file tree

Hide file tree

Showing 22 changed files with 165 additions and 100 deletions.
diff --git a/astrodata/_version.py b/astrodata/_version.py
@@ -7,7 +7,7 @@
 # --- Setup Version Here ---
 API = 3
 FEATURE = 0
-BUG = 3
+BUG = 4
 TAG = ''
 
 

diff --git a/astrodata/doc/ad_CheatSheet/conf.py b/astrodata/doc/ad_CheatSheet/conf.py
@@ -63,7 +63,7 @@
 # The full version, including alpha/beta/rc tags.
 #release = '3.0.x'
 #rtdurl = 'release-'+release
-release = '3.0.3'
+release = '3.0.4'
 rtdurl = 'v'+release
 
 
@@ -73,7 +73,7 @@
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-today = 'July 2022'
+today = 'November 2022'
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
@@ -265,10 +265,10 @@
 # Example configuration for intersphinx: refer to the Python standard library.
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'astrodata': ('https://astrodata-user-manual.readthedocs.io/en/v3.0.3/', None),
+    'astrodata': ('https://astrodata-user-manual.readthedocs.io/en/v3.0.4/', None),
     'astropy': ('https://docs.astropy.org/en/stable/', None),
-    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.3/', None),
-    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.3/', None),
+    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.4/', None),
+    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.4/', None),
     'matplotlib': ('https://matplotlib.org/', None),
     'numpy': ('https://numpy.org/doc/stable/', None),
     'python': ('https://docs.python.org/3/', None),

diff --git a/astrodata/doc/ad_ProgManual/conf.py b/astrodata/doc/ad_ProgManual/conf.py
@@ -75,7 +75,7 @@
 # The ull version, including alpha/beta/rc tags.
 #release = '3.0.x'
 #rtdurl = 'release-'+release
-release = '3.0.3'
+release = '3.0.4'
 rtdurl = 'v'+release
 
 
@@ -89,7 +89,7 @@
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 #
-today = 'July 2022'
+today = 'November 2022'
 #
 # Else, today_fmt is used as the format for a strftime call.
 #

diff --git a/astrodata/doc/ad_UserManual/conf.py b/astrodata/doc/ad_UserManual/conf.py
@@ -74,7 +74,7 @@
 # The full version, including alpha/beta/rc tags.
 #release = '3.0.x'
 #rtdurl = 'release-'+release
-release = '3.0.3'
+release = '3.0.4'
 rtdurl = 'v'+release
 
 # The language for content autogenerated by Sphinx. Refer to documentation
@@ -83,7 +83,7 @@
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-today = 'July 2022'
+today = 'November 2022'
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
@@ -280,8 +280,8 @@
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
     'astropy': ('http://docs.astropy.org/en/stable/', None),
-    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.3/', None),
-    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.3/', None),
+    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.4/', None),
+    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.4/', None),
     'numpy': ('http://docs.scipy.org/doc/numpy/', None),
     'python': ('https://docs.python.org/3', None),
 }

diff --git a/doc/DRAGONS/changes.rst b/doc/DRAGONS/changes.rst
@@ -6,6 +6,64 @@
 Change Logs
 ***********
 
+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
 ===============
 
@@ -62,7 +120,7 @@ Interface Modifications
 * Internal Gemini catalog server URL updated.
 
 Documentation
-------------
+-------------
 
 * Various fixes to the documentation affecting formatting, not the content.
 

diff --git a/doc/DRAGONS/conf.py b/doc/DRAGONS/conf.py
@@ -63,7 +63,7 @@
 # The full version, including alpha/beta/rc tags.
 #release = '3.0.x'
 #rtdurl = 'release-'+release
-release = '3.0.3'
+release = '3.0.4'
 rtdurl = 'v'+release
 
 
@@ -73,7 +73,7 @@
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-today = 'July 2022'
+today = 'November 2022'
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 

diff --git a/doc/DRAGONS/releasenotes.rst b/doc/DRAGONS/releasenotes.rst
@@ -6,6 +6,13 @@
 Release Notes
 *************
 
+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.

diff --git a/geminidr/doc/tutorials/F2Img-DRTutorial/DRAGONSlinks.txt b/geminidr/doc/tutorials/F2Img-DRTutorial/DRAGONSlinks.txt
@@ -1,35 +1,35 @@
 .. |caldb| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/caldb.html" target="_blank">caldb</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/caldb.html" target="_blank">caldb</a>
 
 .. |dataselect| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#dataselect" target="_blank">dataselect</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/supptools.html#dataselect" target="_blank">dataselect</a>
 
 .. |descriptors| raw:: html
 
-    <a href="https://astrodata-user-manual.readthedocs.io/en/v3.0.2/appendices/appendix_descriptors.html" target="_blank">descriptors</a>
+    <a href="https://astrodata-user-manual.readthedocs.io/en/v3.0.4/appendices/appendix_descriptors.html" target="_blank">descriptors</a>
 
 .. |reduce| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/reduce.html" target="_blank">reduce</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/reduce.html" target="_blank">reduce</a>
 
 .. |showd| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#showd" target="_blank">showd</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/supptools.html#showd" target="_blank">showd</a>
 
 .. |showrecipes| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#showrecipes" target="_blank">showrecipes</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/supptools.html#showrecipes" target="_blank">showrecipes</a>
 
 .. |showpars| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#showpars" target="_blank">showpars</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/supptools.html#showpars" target="_blank">showpars</a>
 
 .. |typewalk| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#typewalk" target="_blank">typewalk</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/supptools.html#typewalk" target="_blank">typewalk</a>
 
 .. |atfile| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/reduce.html#the-file-facility" target="_blank">"at-file" Facility</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/reduce.html#the-file-facility" target="_blank">"at-file" Facility</a>
diff --git a/geminidr/doc/tutorials/F2Img-DRTutorial/conf.py b/geminidr/doc/tutorials/F2Img-DRTutorial/conf.py
@@ -41,7 +41,7 @@
 #release = astrodata.version()
 #release = '3.0.x'
 #rtdurl = 'release-'+release
-release = '3.0.3'
+release = '3.0.4'
 rtdurl = 'v'+release
 
 
@@ -86,7 +86,7 @@
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-today = 'July 2022'
+today = 'November 2022'
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
@@ -214,10 +214,10 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'astrodata': ('https://astrodata-user-manual.readthedocs.io/en/v3.0.3/', None),
+    'astrodata': ('https://astrodata-user-manual.readthedocs.io/en/v3.0.4/', None),
     'astropy': ('http://docs.astropy.org/en/stable/', None),
-    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.3/', None),
-    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.3/', None),
+    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.4/', None),
+    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.4/', None),
     'matplotlib': ('https://matplotlib.org/', None),
     'numpy': ('https://docs.scipy.org/doc/numpy/', None),
     'python': ('https://docs.python.org/3', None),

diff --git a/geminidr/doc/tutorials/GMOSImg-DRTutorial/DRAGONSlinks.txt b/geminidr/doc/tutorials/GMOSImg-DRTutorial/DRAGONSlinks.txt
@@ -1,35 +1,35 @@
 .. |caldb| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/caldb.html" target="_blank">caldb</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/caldb.html" target="_blank">caldb</a>
 
 .. |dataselect| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#dataselect" target="_blank">dataselect</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/supptools.html#dataselect" target="_blank">dataselect</a>
 
 .. |descriptors| raw:: html
 
-    <a href="https://astrodata-user-manual.readthedocs.io/en/v3.0.2/appendices/appendix_descriptors.html" target="_blank">descriptors</a>
+    <a href="https://astrodata-user-manual.readthedocs.io/en/v3.0.4/appendices/appendix_descriptors.html" target="_blank">descriptors</a>
 
 .. |reduce| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/reduce.html" target="_blank">reduce</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/reduce.html" target="_blank">reduce</a>
 
 .. |showd| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#showd" target="_blank">showd</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/supptools.html#showd" target="_blank">showd</a>
 
 .. |showrecipes| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#showrecipes" target="_blank">showrecipes</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/supptools.html#showrecipes" target="_blank">showrecipes</a>
 
 .. |showpars| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#showpars" target="_blank">showpars</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/supptools.html#showpars" target="_blank">showpars</a>
 
 .. |typewalk| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#typewalk" target="_blank">typewalk</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/supptools.html#typewalk" target="_blank">typewalk</a>
 
 .. |atfile| raw:: html
 
-    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/reduce.html#the-file-facility" target="_blank">"at-file" Facility</a>
+    <a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.4/reduce.html#the-file-facility" target="_blank">"at-file" Facility</a>
diff --git a/geminidr/doc/tutorials/GMOSImg-DRTutorial/conf.py b/geminidr/doc/tutorials/GMOSImg-DRTutorial/conf.py
@@ -42,7 +42,7 @@
 #release = astrodata.version()
 #release = '3.0.x'
 #rtdurl = 'release-'+release
-release = '3.0.3'
+release = '3.0.4'
 rtdurl = 'v'+release
 
 
@@ -86,7 +86,7 @@
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-today = 'July 2022'
+today = 'November 2022'
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
@@ -214,10 +214,10 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'astrodata': ('https://astrodata-user-manual.readthedocs.io/en/v3.0.3/', None),
+    'astrodata': ('https://astrodata-user-manual.readthedocs.io/en/v3.0.4/', None),
     'astropy': ('http://docs.astropy.org/en/stable/', None),
-    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.3/', None),
-    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.3/', None),
+    'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.4/', None),
+    'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.4/', None),
     'matplotlib': ('https://matplotlib.org/', None),
     'numpy': ('https://docs.scipy.org/doc/numpy/', None),
     'python': ('https://docs.python.org/3', None),