Skip to content

Commit

Permalink
Add whatsnew
Browse files Browse the repository at this point in the history
  • Loading branch information
Cadair committed Feb 6, 2025
1 parent ebd5023 commit ce3a860
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 16 deletions.
24 changes: 15 additions & 9 deletions changelog/507.breaking.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
The minimum supported versions of dependencies and Python have been updated, this release requires:
This release of ``dkist`` includes both scheduled bumps to our dependencies as well as a special bump of gwcs to version 0.24, and associated dependencies.
The version upgrade to gwcs 0.24 fixes the inverse transform (world to pixel) for VISP WCSs.

* Python 3.11
* asdf 2.15 (and plugin version bumps)
* dask 2023.2
* matplotlib 3.7
* ndcube 2.1
* numpy 1.25
* parfive 2.1
* sunpy 5.0
* Python >= 3.11
* dask >= 2023.2
* gwcs >= 0.24
* matplotlib >= 3.7
* ndcube >= 2.1
* numpy >= 1.25
* parfive >= 2.1
* sunpy >= 5.0.7
* asdf >= 3.3
* asdf-astropy >= 0.5
* asdf-coordinate-schemas >= 0.3
* asdf-transform-schemas >= 0.5
* asdf-wcs-schemas >= 0.4
7 changes: 0 additions & 7 deletions changelog/519.breaking.rst

This file was deleted.

43 changes: 43 additions & 0 deletions docs/whatsnew/1.10.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
.. _dkist:whatsnew:1.10:

*****
v1.10
*****

ASDF File Updates
=================

This release of ``dkist`` includes compatibility with new metadata ASDF files generated after 2025/02/07.

.. warning::

You should re-download ASDF files when upgrading to this version of ``dkist``, particularly for VBI data.

These ASDF files change the ordering of the tiles inside a `.TiledDataset` object to correctly account for the differences between column-major (in FITS files) and row-major ordering (in numpy), this release of ``dkist`` updates the `.TiledDataset.plot` method to correctly plot these tiles in the expected order.
It should be noted that with new metadata ASDF files the indexing of specific tiles will have changed.


Dependency Updates
==================

This release of ``dkist`` includes both scheduled bumps to our dependencies as well as a special bump of gwcs to version 0.24, and associated dependencies.
The version upgrade to gwcs 0.24 fixes the inverse transform (world to pixel) for VISP WCSs.

* Python >= 3.11
* dask >= 2023.2
* gwcs >= 0.24
* matplotlib >= 3.7
* ndcube >= 2.1
* numpy >= 1.25
* parfive >= 2.1
* sunpy >= 5.0.7
* asdf >= 3.3
* asdf-astropy >= 0.5
* asdf-coordinate-schemas >= 0.3
* asdf-transform-schemas >= 0.5
* asdf-wcs-schemas >= 0.4

ASDF File History
=================

History data from the metadata ASDF files is now accessible via ``Dataset.meta["history"]`` and ``TiledDataset.meta["history"]``, this history dictionary includes both entries relating to versions of packages used when writing the file and explicitly added history entries.
1 change: 1 addition & 0 deletions docs/whatsnew/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Release History
.. toctree::
:maxdepth: 1

1.10
1.1
1.0
changelog

0 comments on commit ce3a860

Please sign in to comment.