Releases: DKISTDC/dkist
Releases · DKISTDC/dkist
v1.12.0
1.12.0 (2025-04-24)
Deprecations and Removals
- The varying celestial transform models (derived from
BaseVaryingCelestialTransform) now support lookup tables of CRPIX. This means that thecrpix=kwarg is deprecated and replaced withcrpix_tableand thecrpixparameter is now acrpix_tableattribute. (#501)
Features
- Add support for Product ID DKIST inventory keyword, which uniquely identifies a dataset's science frames. (#549)
v1.11.0
1.11.0 (2025-03-20)
Backwards Incompatible Changes
- A major refactor of the
FileManagercode has taken place, the following subpackages have been renamed:dkist.io.loadersis nowdkist.io.dask.loaders.dkist.io.dask_utilsis nowdkist.io.dask.utils.dkist.io.file_manageris nowdkist.io.striped_array(apart from DKIST specific functionality, which is still indkist.io.file_manager). (#487)
dkist.io.file_manager.BaseFileManagerhas been renameddkist.io.dask.striped_array.FileManager. In addition the DKIST specific functionality that was implemented indkist.io.file_manager.FileManageris now in thedkist.io.file_manager.DKISTFileManager, which now instead of being a subclass ofBaseFileManagernow encapsulates adkist.io.dask.striped_array.FileManagerobject (or similar object). (#487)
Features
- Add support to dkist.TiledDataset for mosaic datasets with missing tiles or where tiles are irregularly arranged. This includes adding a new dkist.TiledDataset.mask which is a numpy array, where True values are masked. (#487)
Bug Fixes
- Fix issue issue causing Globus to intermittently fail after auth. (#533)
- Dataset inventory is now refreshed before downloading FITS files with globus to ensure that any data which has been moved at the data center is still downloaded correctly. (#539)
Improved Documentation
- Added an example of plotting the bounding boxes of VBI datasets on AIA data. (#492)
Trivial/Internal Changes
- A new version of the ASDF schema and tag for dkist.TiledDataset, v1.2.0 is added, along with a new dkist manifest v1.4.0. (#487)
v1.10.1
1.10.1 (2025-02-18)
Features
- Adds an overwrite keyword to download_all_sample_data() to force downloading new data. (#523)
Improved Documentation
- Add a how-to guide explaining how to replace outdated dataset metadata files. (#531)
Trivial/Internal Changes
- Update hashes for TiledDataset.plot() figure tests. (#523)
v1.10.0
1.10.0 (2025-02-07)
Backwards Incompatible Changes
- This release of
dkistincludes 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 (#507)
Features
- Add a
figure=keyword argument to TiledDataset.plot and make it default to the current figure. (#491) - Add swap_tile_limits kwarg to TiledDataset.plot. This option allows the user to invert plot limits on either axes to account for WCS values that decrease compared to the pixel axes. (#504)
- Update grid orientation of TiledDataset.plot. The grid now has MAXIS1 columns and MAXIS2 rows where MINDEX1 corresponds to column and MINDEX2 corresponds to row. Additionally, the origin for the grid is now in the lower-left as opposed to the upper-left. (#504)
TiledDatasetnow has a.metadictionary like that ofDataset. (#513)- History of the ADSF file, such as versions of packages and extensions used when writing it are now exposed
TiledDataset.meta["history"]andDataset.meta["history"]. (#513)
Bug Fixes
- Improve the ASDF detection code so out of date ASDF filenames generated by the DKIST data center are skipped if a newer filename is present. (#503)
Improved Documentation
v1.9.2
v1.9.1
1.9.1 (2025-01-15)
Bug Fixes
- Fix some small issues with Dataset.__repr__. (#479)
- Fix path errors with Globus transfers on windows. (#489)
Trivial/Internal Changes
- Add tests for cropping datasets by world coords (#310)
- Fix small bug which caused ds.flat to break if not indexed. (#475)
Performance Improvements
- Improve the performance of the
TiledDatasetreprandstr. (#467)
v1.9.0
1.9.0 (2024-11-04)
Features
- dkist.net.transfer_complete_datasets will now only create one Globus task for all datasets it downloads. (#340)
- Add a FileManager property to TiledDataset for tracking files more easily. (#437)
- Improve performance of computing arrays when using non-thread or sync dask schedulers, by reducing the amount of data needed to be sent to each worker. (#455)
Bug Fixes
- Fix a bug with dkist.net.transfer_complete_datasets where a length one
UnifiedResponsewould cause an error. (#340) - Fix mark argument parsing in the new pytest hook. (#440)
- Minor tweak to correct indexing of >4D datasets. (#453)
Trivial/Internal Changes
- Add --ds and --tiled-ds CLI options to allow passing in datasets for use with the test suite. The dataset given with --ds is passed to tests marked with accept_cli_dataset and those given with --tiled-ds are passed to tests marked with accept_cli_tiled_dataset. (#439)
- Minor updates to TiledDataset.plot() for working with more complex arrangements of tiles. (#441)
- Fix failure to fetch CLI options in publish build. (#447)
v1.8.0
1.8.0 (2024-09-04)
Features
- Add various features for easier inspection of `TiledDataset`:
- __repr__ method to output basic dataset info;
- tiles_shape property to access data array shape for each individual tile;
- slice_tiles() method to apply the same slice to all datasets. (#402)
- Add TiledDataset.plot() quicklook method. (#408)
- Add CircleCI config to enable figure comparison testing with pytest_mpl. (#415)
Trivial/Internal Changes
- Add some more benchmarks to track performance of more parts of the user tools. (#387)
- Add benchmarks for slicing and computing datasets. (#394)
- Added two partial datasets to dkist.data.sample for documentation and testing. (#421)
- replace usages of
copy_arrayswithmemmapforasdf>=3.1.0(#422) - Update Dataset representation for better readability. (#431)
- SKip a failing test in the release publish build. (#434)
v1.7.0
v1.6.0
1.6.0 (2024-05-20)
Features
- Update ASDF schemas for upcoming ASDF standard 1.6.0. (#324)
- Improve performance of classes by not creating a new transform for every set of parameters but instead update the parameters on a single model. (#370)
- Add GitHub workflow and dependencies for Codspeed, to benchmark PRs against main. (#382)
Trivial/Internal Changes
- Run plotting benchmarks fewer times for more manageable CI, and add a benchmark for generate_celestial_transform. (#383)