Skip to content

Commit

Permalink
update to docs in prep for 3.0.4 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
KathleenLabrie committed Nov 9, 2022
1 parent c2a46f7 commit d4c780b
Show file tree
Hide file tree
Showing 22 changed files with 165 additions and 100 deletions.
2 changes: 1 addition & 1 deletion astrodata/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# --- Setup Version Here ---
API = 3
FEATURE = 0
BUG = 3
BUG = 4
TAG = ''


Expand Down
10 changes: 5 additions & 5 deletions astrodata/doc/ad_CheatSheet/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand All @@ -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'

Expand Down Expand Up @@ -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),
Expand Down
4 changes: 2 additions & 2 deletions astrodata/doc/ad_ProgManual/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand All @@ -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.
#
Expand Down
8 changes: 4 additions & 4 deletions astrodata/doc/ad_UserManual/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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'

Expand Down Expand Up @@ -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),
}
Expand Down
60 changes: 59 additions & 1 deletion doc/DRAGONS/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
===============

Expand Down Expand Up @@ -62,7 +120,7 @@ Interface Modifications
* Internal Gemini catalog server URL updated.

Documentation
------------
-------------

* Various fixes to the documentation affecting formatting, not the content.

Expand Down
4 changes: 2 additions & 2 deletions doc/DRAGONS/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand All @@ -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'

Expand Down
7 changes: 7 additions & 0 deletions doc/DRAGONS/releasenotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
18 changes: 9 additions & 9 deletions geminidr/doc/tutorials/F2Img-DRTutorial/DRAGONSlinks.txt
Original file line number Diff line number Diff line change
@@ -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>
10 changes: 5 additions & 5 deletions geminidr/doc/tutorials/F2Img-DRTutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -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'

Expand Down Expand Up @@ -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),
Expand Down
18 changes: 9 additions & 9 deletions geminidr/doc/tutorials/GMOSImg-DRTutorial/DRAGONSlinks.txt
Original file line number Diff line number Diff line change
@@ -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>
10 changes: 5 additions & 5 deletions geminidr/doc/tutorials/GMOSImg-DRTutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -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'

Expand Down Expand Up @@ -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),
Expand Down
Loading

0 comments on commit d4c780b

Please sign in to comment.