v2.3.0

Breaking Changes

• "dimensions" property on ndcube.NDCube and ndcube.NDCubeSequence have been deprecated and replaced by "shape" (#684)

Removals

• The ability to create an .NDCollection object with numerical keys is deprecated as it leads to ambiguous behavior when slicing the collection. (#778)

New Features

• Add Sliceable ndcube.meta.NDMeta class for axis-associated metadata. (#455)
• Added a new ndcube.NDCube.squeeze method to ndcube.NDCube. It will remove all axes of length 1. (#669)
• Added ndcube.NDCube.quantity attribute to ndcube.NDCube to return the data array with in the cube with the physical units stored in the ndcube.NDCube.unit attribute. (#677)
• Enable ndcube.NDCube to be raised to a power. (#678)
• Added ndcube.NDCube.shape as a replacement for "dimensions". (#684)
• Enable rtruediv on ~ndcube.NDCube such that a user can now do 1/ndcube.NDCube. (#685)
• Add a keepdims=False kwarg to ndcube.NDCube.crop and ndcube.NDCube.crop_by_values setting to true keeps length-1 dimensions default behavior drops these dimensions. (#732)
• When calling ndcube.NDCubeBase.axis_world_coords or ndcube.NDCubeBase.axis_world_coords_values with a specific axis or axes specified, the methods now avoid doing calculations for any other uncorrelated axes, offering significant speedups when those other axes are large. (#767)
• Add support for passing -1 as an element of the bin_shape argument to .NDCube.rebin which will not rebin along that dimension (sets the bin shape to equal the data shape). (#777)
• It is now possible to set the NDCube.data property of a cube with an array of the same shape and unit as the current cube. (#795)

Bug Fixes

• ndcube.NDCube.rebin bin_shape argument now accepts a astropy.units.Quantity as input if the units are convertible to pixels. (#744)
• Fix support for astropy 7.0, this involved a change to CompoundLowLevelWCS so that in handles pixel_bounds if only one component WCS sets a pixel bound. (#772)
• Fixed a bug which caused NDCubeSequence.cube_like_dimensions to break. (#788)
• Added an internal code to shortcut non-correlated axes avoiding the creation of a full coordinate grid, reducing memory use in specific circumstances. (#798)

Documentation

• Added a gallery example (sphx_glr_generated_gallery_creating_even_spaced_wavelength_visualisation.py) showcasing how to create a visualisation of unevenly spaced wavelength data cube using AIA data. (#691)
• Added a gallery example (sphx_glr_generated_gallery_creating_a_gwcs_from_quantities.py) showcasing how to create a GWCS from quantities. (#695)

Internal Changes

• Move code creating a masked array for ndcube.NDCube.rebin to a private function which is then called by ndcube.NDCube.rebin. (#705)
• Added explicit support for numpy 2.0. (#729)

v2.2.4

Full Changelog: v2.2.3...v2.2.4

v2.2.3

What's Changed

• Backports for 2.2 by @nabobalis in #768

Full Changelog: v2.2.2...v2.2.3

v2.2.2

Added support for numpy 2.0

v2.2.1post

Fix version in the documentation sidebar.

v2.2.1

What's Changed

• Backport PR #654 on branch 2.2 (Fix devdeps figure tests and getting the wrong filename) by @meeseeksmachine in #656
• Backport PR #660 on branch 2.2 (Remove old circleci webhook config) by @meeseeksmachine in #662
• Backport PR #670 on branch 2.2 ([pre-commit.ci] pre-commit autoupdate) by @meeseeksmachine in #671
• Backport PR #668 on branch 2.2 (Fix the unrendered code snippets in the docstrings) by @meeseeksmachine in #674
• Backport PR #675 on branch 2.2 (update dev figure hashes) by @meeseeksmachine in #676
• Fix for init of for specutils by @nabobalis in #719

Full Changelog: v2.2.0...v2.2.1

v2.2.0

What's Changed

• Delete test file + fix CI by @nabobalis in #626
• Edits to manuscript for JOSS review by @dfm in #628
• DOC: Remove broken link from old mailing list by @pllim in #632
• Add a zenodo metadata record by @Cadair in #630
• [main] Drop Python 3.8, Increase min deps versions, update tox config on CI, update circleci by @nabobalis in #636
• Add links to ndcube publications to README and docs. by @DanRyanIrish in #642
• Update NDCollection copy() & pop() to Support None aligned_axes by @Alrobbertz in #646
• Convert WCS wrappers to FITS WCS. by @DanRyanIrish in #649
• Update error messages for mpl and mpl_animators by @nabobalis in #651

New Contributors

• @dfm made their first contribution in #628
• @Alrobbertz made their first contribution in #646

Full Changelog: v2.1.4...v2.2.0

v2.1.4

What's Changed

• Backport PR #626 on branch 2.1 (Delete test file + fix CI ) by @meeseeksmachine in #629
• Backport PR #632 on branch 2.1 (DOC: Remove broken link from old mailing list) by @meeseeksmachine in #633
• [2.1] Update CI by @nabobalis in #638
• Backport PR #643 on branch 2.1 ([pre-commit.ci] pre-commit autoupdate) by @meeseeksmachine in #644
• Backport PR #651 on branch 2.1 (Update error messages for mpl and mpl_animators) by @meeseeksmachine in #652

Full Changelog: v2.1.3...v2.1.4

v2.1.3

v2.1.3 (2023-07-08)

Trivial/Internal Changes

• Remove internal use of numpy.product as its now deprecated and replace with numpy.prod as recommended. (#625)
• Write paper to Journal of Open Source Software describing ndcube package (#599, #609, #611, #621, #622, #623)

v2.1.2

2.1.2 (2023-05-31)

Backwards Incompatible Changes

• ndcube.NDCollection.aligned_axes attribute is now property. (#607 <https://github.com/sunpy/ndcube/pull/607>__)

Bug Fixes

• Keywords for sequence_axis_coords and sequence_axis_unit were not passed to the SequenceAnimator constructor.
  This is now fixed. (#607 <https://github.com/sunpy/ndcube/pull/607>__)

Improved Documentation

• Sphinx nitpicky was enabled and lots of references were updated.
• Overall documentation layout was adjusted to shrink the sidebar.