Skip to content

Commit

Permalink
pre-release updated to version number, sphinx paths, copyright dates
Browse files Browse the repository at this point in the history
  • Loading branch information
KathleenLabrie committed Jun 28, 2022
1 parent 6fd01a1 commit 316c2ba
Show file tree
Hide file tree
Showing 27 changed files with 185 additions and 157 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 = 1
BUG = 2
TAG = ''


Expand Down
18 changes: 9 additions & 9 deletions astrodata/doc/ad_CheatSheet/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

# General information about the project.
project = 'Astrodata Cheat Sheet'
copyright = '2021, Association of Universities for Research in Astronomy'
copyright = '2022, Association of Universities for Research in Astronomy'

# Note that AURA owns the Copyright, not you.

Expand All @@ -61,10 +61,10 @@
# The short X.Y version.
version = '3.0'
# The full version, including alpha/beta/rc tags.
release = '3.0.x'
rtdurl = 'release-'+release
#release = '3.0.1'
#rtdurl = 'v'+release
#release = '3.0.x'
#rtdurl = 'release-'+release
release = '3.0.2'
rtdurl = 'v'+release


# The language for content autogenerated by Sphinx. Refer to documentation
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 = 'December 2021'
today = 'July 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/release-3.0.x/', None),
'astrodata': ('https://astrodata-user-manual.readthedocs.io/en/v3.0.2/', None),
'astropy': ('https://docs.astropy.org/en/stable/', None),
'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-3.0.x/', None),
'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-3.0.x/', None),
'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.2/', None),
'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.2/', None),
'matplotlib': ('https://matplotlib.org/', None),
'numpy': ('https://numpy.org/doc/stable/', None),
'python': ('https://docs.python.org/3/', None),
Expand Down
12 changes: 6 additions & 6 deletions astrodata/doc/ad_ProgManual/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@

# General information about the project.
project = 'Astrodata Programmer Manual'
copyright = '2021, Association of Universities for Research in Astronomy'
copyright = '2022, Association of Universities for Research in Astronomy'
author = 'Ricardo Cardenes'

# The version info for the project you're documenting, acts as replacement for
Expand All @@ -73,10 +73,10 @@
# The short X.Y version.
version = '3.0'
# The ull version, including alpha/beta/rc tags.
release = '3.0.x'
rtdurl = 'release-'+release
#release = '3.0.1'
#rtdurl = 'v'+release
#release = '3.0.x'
#rtdurl = 'release-'+release
release = '3.0.2'
rtdurl = 'v'+release


# The language for content autogenerated by Sphinx. Refer to documentation
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 = 'December 2021'
today = 'July 2022'
#
# Else, today_fmt is used as the format for a strftime call.
#
Expand Down
16 changes: 8 additions & 8 deletions astrodata/doc/ad_UserManual/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@

# General information about the project.
project = 'Astrodata User Manual'
copyright = '2021, Association of Universities for Research in Astronomy'
copyright = '2022, Association of Universities for Research in Astronomy'
# Note that AURA owns the Copyright, not you.

# The version info for the project you're documenting, acts as replacement for
Expand All @@ -72,18 +72,18 @@
# The short X.Y version.
version = '3.0'
# The full version, including alpha/beta/rc tags.
release = '3.0.x'
rtdurl = 'release-'+release
#release = '3.0.1'
#rtdurl = 'v'+release
#release = '3.0.x'
#rtdurl = 'release-'+release
release = '3.0.2'
rtdurl = 'v'+release

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
today = 'December 2021'
today = 'July 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/release-3.0.x/', None),
'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-3.0.x/', None),
'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.2/', None),
'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.2/', None),
'numpy': ('http://docs.scipy.org/doc/numpy/', None),
'python': ('https://docs.python.org/3', None),
}
Expand Down
22 changes: 20 additions & 2 deletions doc/DRAGONS/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,33 @@ Bug Fixes
* Continue without crashing when ``traceApertures`` cannot identify a
starting location for a trace.

* Fix bug where manually-assigned sky frames in ``separateSky`` were added
to the list of science frames by mistake.
* Fix issues with assignment of on-source/sky frames when the user specifies
specific frames.

* Fix bug where ``stackFrames`` crashed if using the ``statsec`` parameter
when scaling or zero-offsetting.

* In fringeCorrect, ``do_cal=force`` has been reactivated.

* Better handling of infinites and NaN in the flat normalization.

**geminidr.gmos**

* Added new primitive to the recipes to mask amplifier 5 in GMOS-S data
obtained since January 28, 2022. GMOS-S amplifier 5 suffered a major
failure and it is not usable.

* Ensure that the masks are used when calculating the statistics in
scaleByIntensity.

**geminidr.gnirs**

* Added missing support for YPHOT filter.

**geminidr.f2***

* Support of the Flamingos 2 filters.

New Features
------------

Expand All @@ -37,6 +52,9 @@ New Features
* Add ``wave_units`` and ``data_units`` parameters to ``write1DSpectra`` to
configure the output

* Under-the-hood modification to distinguish data reduced in quicklook mode
versus science mode.

Interface Modifications
-----------------------
* Internal Gemini catalog server URL updated.
Expand Down
12 changes: 6 additions & 6 deletions doc/DRAGONS/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@

# General information about the project.
project = 'DRAGONS'
copyright = '2021, Association of Universities for Research in Astronomy'
copyright = '2022, Association of Universities for Research in Astronomy'

# Note that AURA owns the Copyright, not you.

Expand All @@ -61,10 +61,10 @@
# The short X.Y version.
version = '3.0'
# The full version, including alpha/beta/rc tags.
release = '3.0.x'
rtdurl = 'release-'+release
#release = '3.0.1'
#rtdurl = 'v'+release
#release = '3.0.x'
#rtdurl = 'release-'+release
release = '3.0.2'
rtdurl = 'v'+release


# The language for content autogenerated by Sphinx. Refer to documentation
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 = 'December 2021'
today = 'July 2022'
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

Expand Down
10 changes: 10 additions & 0 deletions doc/DRAGONS/releasenotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@
Release Notes
*************

V3.0.2
======

This patch release improves the reduction of GMOS-S data obtained since the
event on January 28, 2022 that led to the failure of amplifier 5. This patch
also adds support of the new Flamingos 2 filters and the filter wheel
reshuffling that occurred earlier this year. Various other fixes and features
are also contained in this patch. See the :ref:`change logs <changes>` for
details.

V3.0.1
======

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/release-3.0.x/caldb.html" target="_blank">caldb</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/caldb.html" target="_blank">caldb</a>

.. |dataselect| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/supptools.html#dataselect" target="_blank">dataselect</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#dataselect" target="_blank">dataselect</a>

.. |descriptors| raw:: html

<a href="https://astrodata-user-manual.readthedocs.io/en/release-3.0.x/appendices/appendix_descriptors.html" target="_blank">descriptors</a>
<a href="https://astrodata-user-manual.readthedocs.io/en/v3.0.2/appendices/appendix_descriptors.html" target="_blank">descriptors</a>

.. |reduce| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/reduce.html" target="_blank">reduce</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/reduce.html" target="_blank">reduce</a>

.. |showd| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/supptools.html#showd" target="_blank">showd</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#showd" target="_blank">showd</a>

.. |showrecipes| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/supptools.html#showrecipes" target="_blank">showrecipes</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#showrecipes" target="_blank">showrecipes</a>

.. |showpars| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/supptools.html#showpars" target="_blank">showpars</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#showpars" target="_blank">showpars</a>

.. |typewalk| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/supptools.html#typewalk" target="_blank">typewalk</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#typewalk" target="_blank">typewalk</a>

.. |atfile| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/reduce.html#the-file-facility" target="_blank">"at-file" Facility</a>
<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>
18 changes: 9 additions & 9 deletions geminidr/doc/tutorials/F2Img-DRTutorial/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,18 @@
# -- Project information -----------------------------------------------------

project = 'DRAGONS Tutorial - Flamingos-2 Data Reduction'
copyright = '2021, Association of Universities for Research in Astronomy'
copyright = '2022, Association of Universities for Research in Astronomy'
author = 'Bruno C. Quint'

# The short X.Y version
#version = astrodata.version(short=True)
version = '3.0'
# The full version, including alpha/beta/rc tags
#release = astrodata.version()
release = '3.0.x'
rtdurl = 'release-'+release
#release = '3.0.1'
#rtdurl = 'v'+release
#release = '3.0.x'
#rtdurl = 'release-'+release
release = '3.0.2'
rtdurl = 'v'+release


# -- General configuration ---------------------------------------------------
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 = 'December 2021'
today = 'July 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/release-3.0.x/', None),
'astrodata': ('https://astrodata-user-manual.readthedocs.io/en/v3.0.2/', None),
'astropy': ('http://docs.astropy.org/en/stable/', None),
'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-3.0.x/', None),
'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/release-3.0.x/', None),
'gemini_instruments': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.2/', None),
'geminidr': ('https://dragons-recipe-system-programmers-manual.readthedocs.io/en/v3.0.2/', None),
'matplotlib': ('https://matplotlib.org/', None),
'numpy': ('https://docs.scipy.org/doc/numpy/', None),
'python': ('https://docs.python.org/3', None),
Expand Down
2 changes: 1 addition & 1 deletion geminidr/doc/tutorials/F2Img-DRTutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This is a brief tutorial on how to reduce Flamingos-2 images using DRAGONS (Data
Reduction for Astronomy from Gemini Observatory North and South). It is based on
information found in the `GEMINI Flamingos-2
WebPage <https://www.gemini.edu/sciops/instruments/flamingos2/>`_ and in the
`DRAGONS Documentation on Read The Docs <https://dragons.readthedocs.io/en/latest/>`_.
`DRAGONS Documentation on Read The Docs <https://dragons.readthedocs.io/en/v3.0.2/>`_.


.. toctree::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ configured as follow:
The calibration service is now ready to use. If you need more details,
check the
`Using the caldb API in the Recipe System User's Manual <https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/caldb.html#using-the-caldb-api>`_ .
`Using the caldb API in the Recipe System User's Manual <https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/caldb.html#using-the-caldb-api>`_ .

.. _api_create_file_lists:

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/release-3.0.x/caldb.html" target="_blank">caldb</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/caldb.html" target="_blank">caldb</a>

.. |dataselect| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/supptools.html#dataselect" target="_blank">dataselect</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#dataselect" target="_blank">dataselect</a>

.. |descriptors| raw:: html

<a href="https://astrodata-user-manual.readthedocs.io/en/release-3.0.x/appendices/appendix_descriptors.html" target="_blank">descriptors</a>
<a href="https://astrodata-user-manual.readthedocs.io/en/v3.0.2/appendices/appendix_descriptors.html" target="_blank">descriptors</a>

.. |reduce| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/reduce.html" target="_blank">reduce</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/reduce.html" target="_blank">reduce</a>

.. |showd| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/supptools.html#showd" target="_blank">showd</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#showd" target="_blank">showd</a>

.. |showrecipes| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/supptools.html#showrecipes" target="_blank">showrecipes</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#showrecipes" target="_blank">showrecipes</a>

.. |showpars| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/supptools.html#showpars" target="_blank">showpars</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#showpars" target="_blank">showpars</a>

.. |typewalk| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/supptools.html#typewalk" target="_blank">typewalk</a>
<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/v3.0.2/supptools.html#typewalk" target="_blank">typewalk</a>

.. |atfile| raw:: html

<a href="https://dragons-recipe-system-users-manual.readthedocs.io/en/release-3.0.x/reduce.html#the-file-facility" target="_blank">"at-file" Facility</a>
<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>

0 comments on commit 316c2ba

Please sign in to comment.