Release commit created with Cranko.

+++ cranko-release-info-v1 [[projects]] qnames = ["toasty", "pypa"] version = "0.7.0" age = 0 +++
WorldWideTelescope · Aug 6, 2021 · ef52ccb · ef52ccb
2 parents 79ba646 + de47bc1
commit ef52ccb
Show file tree

Hide file tree

Showing 34 changed files with 1,310 additions and 617 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,24 @@
+# toasty 0.7.0 (2021-08-06)
+
+- Add the `toasty pipeline ignore-rejects` command to allow you to tell the
+ Toasty pipeline system to ignore certain images going forward. This will be
+ helpful if your pipeline provides some images that, say, aren't actually
+ images of the sky (#51, @pkgw).
+- Start requiring and using version 0.10 of the [wwt_data_formats] support
+ library. This version includes important improvements to how image coordinates
+ (WCS) are handled. Previously, some kinds of coordinates weren't handled
+ completely correctly. While it's better to do this correctly, the new code may
+ break some existing workflows if they accidentally relied on the broken
+ behavior.
+- Implement end-to-end support for tiling FITS data in the backend (#52, @pkgw)!
+ These datasets can be displayed using the very latest version of the WWT
+ rendering engine. Toasty's support for creating these datasets needs to be
+ exposed in a more user-friendly way, including documentation and examples,
+ but the core algorithms should generate working datasets.
+
+[wwt_data_formats]: https://wwt-data-formats.readthedocs.io/
+
+
 # toasty 0.6.4 (2021-02-09)
 
 - Properly handle CLI glob arguments on Windows. It turns out that we need to

diff --git a/README.md b/README.md
@@ -105,13 +105,14 @@ Telescope Team. It is licensed under the [MIT License](./LICENSE).
 [toasty] is part of the AAS WorldWide Telescope system, a [.NET Foundation]
 project managed by the non-profit [American Astronomical Society] (AAS). Work
 on WWT has been supported by the AAS, the US [National Science Foundation]
-(grants [1550701] and [1642446]), the [Gordon and Betty Moore Foundation], and
+(grants [1550701], [1642446], and [2004840]), the [Gordon and Betty Moore Foundation], and
 [Microsoft].
 
 [.NET Foundation]: https://dotnetfoundation.org/
 [American Astronomical Society]: https://aas.org/
 [National Science Foundation]: https://www.nsf.gov/
 [1550701]: https://www.nsf.gov/awardsearch/showAward?AWD_ID=1550701
 [1642446]: https://www.nsf.gov/awardsearch/showAward?AWD_ID=1642446
+[2004840]: https://www.nsf.gov/awardsearch/showAward?AWD_ID=2004840
 [Gordon and Betty Moore Foundation]: https://www.moore.org/
 [Microsoft]: https://www.microsoft.com/
diff --git a/ci/azure-build-and-test.yml b/ci/azure-build-and-test.yml
@@ -134,7 +134,7 @@ jobs:
  source activate-conda.sh
  conda activate build
  set -x
- \conda install -y numpydoc sphinx sphinx-automodapi
+ \conda install -y astropy numpydoc sphinx sphinx-automodapi
  pip install astropy-sphinx-theme
  cd docs
  make html

diff --git a/docs/api.rst b/docs/api.rst
@@ -14,6 +14,10 @@ Python API Reference
  :no-inheritance-diagram:
  :no-inherited-members:
 
+.. automodapi:: toasty.collection
+ :no-inheritance-diagram:
+ :no-inherited-members:
+
 .. automodapi:: toasty.image
  :no-inheritance-diagram:
  :no-inherited-members:

diff --git a/docs/api/toasty.builder.Builder.rst b/docs/api/toasty.builder.Builder.rst
@@ -21,6 +21,7 @@ Builder
  ~Builder.apply_avm_info
  ~Builder.apply_wcs_info
  ~Builder.cascade
+ ~Builder.create_wtml_folder
  ~Builder.default_tiled_study_astrometry
  ~Builder.load_from_wwtl
  ~Builder.make_placeholder_thumbnail
@@ -41,6 +42,7 @@ Builder
  .. automethod:: apply_avm_info
  .. automethod:: apply_wcs_info
  .. automethod:: cascade
+ .. automethod:: create_wtml_folder
  .. automethod:: default_tiled_study_astrometry
  .. automethod:: load_from_wwtl
  .. automethod:: make_placeholder_thumbnail

diff --git a/docs/api/toasty.collection.ImageCollection.rst b/docs/api/toasty.collection.ImageCollection.rst
@@ -0,0 +1,19 @@
+ImageCollection
+===============
+
+.. currentmodule:: toasty.collection
+
+.. autoclass:: ImageCollection
+ :show-inheritance:
+
+ .. rubric:: Methods Summary
+
+ .. autosummary::
+
+ ~ImageCollection.descriptions
+ ~ImageCollection.images
+
+ .. rubric:: Methods Documentation
+
+ .. automethod:: descriptions
+ .. automethod:: images
diff --git a/docs/api/toasty.collection.RubinDirectoryCollection.rst b/docs/api/toasty.collection.RubinDirectoryCollection.rst
@@ -0,0 +1,19 @@
+RubinDirectoryCollection
+========================
+
+.. currentmodule:: toasty.collection
+
+.. autoclass:: RubinDirectoryCollection
+ :show-inheritance:
+
+ .. rubric:: Methods Summary
+
+ .. autosummary::
+
+ ~RubinDirectoryCollection.descriptions
+ ~RubinDirectoryCollection.images
+
+ .. rubric:: Methods Documentation
+
+ .. automethod:: descriptions
+ .. automethod:: images
diff --git a/docs/api/toasty.collection.SimpleFitsCollection.rst b/docs/api/toasty.collection.SimpleFitsCollection.rst
@@ -0,0 +1,19 @@
+SimpleFitsCollection
+====================
+
+.. currentmodule:: toasty.collection
+
+.. autoclass:: SimpleFitsCollection
+ :show-inheritance:
+
+ .. rubric:: Methods Summary
+
+ .. autosummary::
+
+ ~SimpleFitsCollection.descriptions
+ ~SimpleFitsCollection.images
+
+ .. rubric:: Methods Documentation
+
+ .. automethod:: descriptions
+ .. automethod:: images
diff --git a/docs/api/toasty.image.Image.rst b/docs/api/toasty.image.Image.rst
@@ -25,9 +25,13 @@ Image
  ~Image.asarray
  ~Image.aspil
  ~Image.clear
+ ~Image.ensure_negative_parity
  ~Image.fill_into_maskable_buffer
+ ~Image.flip_parity
  ~Image.from_array
  ~Image.from_pil
+ ~Image.get_parity_sign
+ ~Image.has_wcs
  ~Image.make_thumbnail_bitmap
  ~Image.save
  ~Image.update_into_maskable_buffer
@@ -47,9 +51,13 @@ Image
  .. automethod:: asarray
  .. automethod:: aspil
  .. automethod:: clear
+ .. automethod:: ensure_negative_parity
  .. automethod:: fill_into_maskable_buffer
+ .. automethod:: flip_parity
  .. automethod:: from_array
  .. automethod:: from_pil
+ .. automethod:: get_parity_sign
+ .. automethod:: has_wcs
  .. automethod:: make_thumbnail_bitmap
  .. automethod:: save
  .. automethod:: update_into_maskable_buffer
diff --git a/docs/api/toasty.image.ImageDescription.rst b/docs/api/toasty.image.ImageDescription.rst
@@ -0,0 +1,41 @@
+ImageDescription
+================
+
+.. currentmodule:: toasty.image
+
+.. autoclass:: ImageDescription
+ :show-inheritance:
+
+ .. rubric:: Attributes Summary
+
+ .. autosummary::
+
+ ~ImageDescription.dtype
+ ~ImageDescription.height
+ ~ImageDescription.mode
+ ~ImageDescription.shape
+ ~ImageDescription.wcs
+ ~ImageDescription.width
+
+ .. rubric:: Methods Summary
+
+ .. autosummary::
+
+ ~ImageDescription.ensure_negative_parity
+ ~ImageDescription.flip_parity
+ ~ImageDescription.get_parity_sign
+
+ .. rubric:: Attributes Documentation
+
+ .. autoattribute:: dtype
+ .. autoattribute:: height
+ .. autoattribute:: mode
+ .. autoattribute:: shape
+ .. autoattribute:: wcs
+ .. autoattribute:: width
+
+ .. rubric:: Methods Documentation
+
+ .. automethod:: ensure_negative_parity
+ .. automethod:: flip_parity
+ .. automethod:: get_parity_sign
diff --git a/docs/api/toasty.image.ImageMode.rst b/docs/api/toasty.image.ImageMode.rst
@@ -20,6 +20,7 @@ ImageMode
 
  .. autosummary::
 
+ ~ImageMode.from_array_info
  ~ImageMode.make_maskable_buffer
  ~ImageMode.try_as_pil
 
@@ -33,5 +34,6 @@ ImageMode
 
  .. rubric:: Methods Documentation
 
+ .. automethod:: from_array_info
  .. automethod:: make_maskable_buffer
  .. automethod:: try_as_pil
diff --git a/docs/api/toasty.image.get_format_vertical_parity_sign.rst b/docs/api/toasty.image.get_format_vertical_parity_sign.rst
@@ -0,0 +1,6 @@
+get_format_vertical_parity_sign
+===============================
+
+.. currentmodule:: toasty.image
+
+.. autofunction:: get_format_vertical_parity_sign
diff --git a/docs/api/toasty.multi_tan.MultiTanDataSource.rst b/docs/api/toasty.multi_tan.MultiTanDataSource.rst
diff --git a/docs/api/toasty.multi_tan.MultiTanProcessor.rst b/docs/api/toasty.multi_tan.MultiTanProcessor.rst
@@ -0,0 +1,19 @@
+MultiTanProcessor
+=================
+
+.. currentmodule:: toasty.multi_tan
+
+.. autoclass:: MultiTanProcessor
+ :show-inheritance:
+
+ .. rubric:: Methods Summary
+
+ .. autosummary::
+
+ ~MultiTanProcessor.compute_global_pixelization
+ ~MultiTanProcessor.tile
+
+ .. rubric:: Methods Documentation
+
+ .. automethod:: compute_global_pixelization
+ .. automethod:: tile
diff --git a/docs/api/toasty.pyramid.PyramidIO.rst b/docs/api/toasty.pyramid.PyramidIO.rst
@@ -10,6 +10,9 @@ PyramidIO
 
  .. autosummary::
 
+ ~PyramidIO.clean_lockfiles
+ ~PyramidIO.get_default_format
+ ~PyramidIO.get_default_vertical_parity_sign
  ~PyramidIO.get_path_scheme
  ~PyramidIO.open_metadata_for_read
  ~PyramidIO.open_metadata_for_write
@@ -20,6 +23,9 @@ PyramidIO
 
  .. rubric:: Methods Documentation
 
+ .. automethod:: clean_lockfiles
+ .. automethod:: get_default_format
+ .. automethod:: get_default_vertical_parity_sign
  .. automethod:: get_path_scheme
  .. automethod:: open_metadata_for_read
  .. automethod:: open_metadata_for_write

diff --git a/docs/cli.rst b/docs/cli.rst
@@ -9,6 +9,7 @@ CLI Reference
  cli/make-thumbnail
  cli/pipeline-approve
  cli/pipeline-fetch
+ cli/pipeline-ignore-rejects
  cli/pipeline-init
  cli/pipeline-process-todos
  cli/pipeline-publish

diff --git a/docs/cli/pipeline-ignore-rejects.rst b/docs/cli/pipeline-ignore-rejects.rst
@@ -0,0 +1,50 @@
+.. _cli-pipeline-ignore-rejects:
+
+==================================
+``toasty pipeline ignore-rejects``
+==================================
+
+The ``ignore-rejects`` :ref:`pipeline command <pipeline>` marks all of the
+rejected images in a workspace to be ignored by future processing runs.
+
+
+Usage
+=====
+
+.. code-block:: shell
+
+ toasty pipeline ignore-rejects [--workdir=WORKDIR]
+
+The ``WORKDIR`` argument optionally specifies the location of the pipeline
+workspace directory. The default is the current directory.
+
+
+Example
+=======
+
+Ignore every image in the ``rejects`` directory:
+
+.. code-block:: shell
+
+ toasty pipeline ignore-rejects
+
+Subsequent invocations of :ref:`cli-pipeline-refresh` will ignore these images
+when searching for new processing candidates.
+
+
+Notes
+=====
+
+This command will ignore every image in the “reject” state. That is, each file
+inside the ``rejects`` subfolder of the pipeline workspace will be taken to be
+an image ID that should be ignored. If you have rejects that should *not* be
+permanently ignored (maybe you can't solve their coordinates right now, but will
+be able to later), delete their files from the ``rejects`` subfolder before
+running this command.
+
+
+See Also
+========
+
+- :ref:`The toasty pipeline processing overview <pipeline>`
+- :ref:`cli-pipeline-refresh`
diff --git a/docs/cli/pipeline-refresh.rst b/docs/cli/pipeline-refresh.rst
@@ -31,9 +31,14 @@ image, a file will be created in the ``candidates`` subdirectory. The next step
 is to select candidates for processing and download them using
 :ref:`cli-pipeline-fetch`.
 
+If there are candidates that should *never* be processed, they can be marked to
+be ignored by subsequent refreshes. Currently you can only do this with images
+that are rejected during processing, using :ref:`cli-pipeline-ignore-rejects`.
+
 
 See Also
 ========
 
 - :ref:`The toasty pipeline processing overview <pipeline>`
 - :ref:`cli-pipeline-fetch`
+- :ref:`cli-pipeline-ignore-rejects`
diff --git a/docs/conf.py b/docs/conf.py
@@ -43,12 +43,12 @@
  ),
 
  'astropy': (
- 'http://docs.astropy.org/en/stable/',
+ 'https://docs.astropy.org/en/stable/',
  None
  ),
 
  'numpy': (
- 'https://docs.scipy.org/doc/numpy/',
+ 'https://numpy.org/doc/stable/',
  (None, 'http://data.astropy.org/intersphinx/numpy.inv')
  ),
 

diff --git a/setup.py b/setup.py
@@ -36,7 +36,7 @@ def get_long_desc():
 
 setup_args = dict(
  name = 'toasty', # cranko project-name
- version = '0.6.4', # cranko project-version
+ version = '0.7.0', # cranko project-version
  description = 'Generate TOAST image tile pyramids from existing image data',
  long_description = get_long_desc(),
  long_description_content_type = 'text/markdown',
@@ -78,7 +78,7 @@ def get_long_desc():
  'pillow>=7.0',
  'PyYAML>=5.0',
  'tqdm>=4.0',
- 'wwt_data_formats>=0.9.1',
+ 'wwt_data_formats>=0.10.0',
  ],
 
  extras_require = {