Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 35 additions & 35 deletions docs/change_log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ A bugfix release, just to allow working with Python 3.10.
Bug Fixes
^^^^^^^^^

- Made indexing work with Python v3.10. (`ISSUE#183 <https://github.com/pp-mo/ncdata/pull/183>`_)
- Made indexing work with Python v3.10. (`ISSUE#183 <https://github.com/SciTools/ncdata/pull/183>`_)


Developer and Internal changes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- Support more Python versions: now allowing >=3.10 and no longer limiting <3.14.
CI testing now against 3.10 / 3.11 / 3.12 / 3.13.
(`ISSUE#186 <https://github.com/pp-mo/ncdata/pull/186>`_)
(`ISSUE#186 <https://github.com/SciTools/ncdata/pull/186>`_)



Expand All @@ -64,15 +64,15 @@ xarray (`2025.10.1 <https://github.com/pydata/xarray/releases/tag/v2025.10.1>`_)
Documentation changes
^^^^^^^^^^^^^^^^^^^^^

- Document how to create a developer installation. (`ISSUE#174 <https://github.com/pp-mo/ncdata/pull/174>`_)
- Document how to create a developer installation. (`ISSUE#174 <https://github.com/SciTools/ncdata/pull/174>`_)


Developer and Internal changes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- Fix xarray 2025.09.1 problem. (`ISSUE#173 <https://github.com/pp-mo/ncdata/pull/173>`_)
- Fix xarray 2025.09.1 problem. (`ISSUE#173 <https://github.com/SciTools/ncdata/pull/173>`_)
- Test against given Python versions : currently 3.12 and 3.13.
**Not** python 3.14, for now, due to emerging problems with dependencies (notably Iris). (`ISSUE#175 <https://github.com/pp-mo/ncdata/pull/175>`_)
**Not** python 3.14, for now, due to emerging problems with dependencies (notably Iris). (`ISSUE#175 <https://github.com/SciTools/ncdata/pull/175>`_)


v0.3.0
Expand All @@ -87,41 +87,41 @@ Features
specifed dimensions with the :meth:`~ncdata.NcData.slicer` method.
This is based on the new :meth:`~ncdata.utils.index_by_dimensions()` utility method
and :class:`~ncdata.utils.Slicer` class.
See: :ref:`utils_indexing` (`ISSUE#68 <https://github.com/pp-mo/ncdata/pull/68>`_)
See: :ref:`utils_indexing` (`ISSUE#68 <https://github.com/SciTools/ncdata/pull/68>`_)
- Added the :func:`~ncdata.utils.rename_dimension` utility.
This provides a "safe" dimension rename, which also replaces
the name in all variables which use it. (`ISSUE#87 <https://github.com/pp-mo/ncdata/pull/87>`_)
the name in all variables which use it. (`ISSUE#87 <https://github.com/SciTools/ncdata/pull/87>`_)
- Added the ".avals" property as an easier way of managing attributes:
This provides a simple "name: value" map, bypassing the NcAttribute objects and converting values to and from simple Python equivalents.
This effectively replaces the older 'set_attrval' and 'get_attrval', which will eventually be removed.
See: :ref:`attributes_and_avals` (`ISSUE#117 <https://github.com/pp-mo/ncdata/pull/117>`_)
See: :ref:`attributes_and_avals` (`ISSUE#117 <https://github.com/SciTools/ncdata/pull/117>`_)
- Make :meth:`~ncdata.iris.to_iris` use the full iris load processing,
instead of :meth:`iris.fileformats.netcdf.loader.load_cubes`.
This means you can use load controls such as callbacks and constraints. (`ISSUE#131 <https://github.com/pp-mo/ncdata/pull/131>`_)
This means you can use load controls such as callbacks and constraints. (`ISSUE#131 <https://github.com/SciTools/ncdata/pull/131>`_)
- Provide exact == and != for datasets and variables, by just calling the difference utilities.
This can be inefficient, but is simple to understand and generally useful.
See: :ref:`equality_testing` (`ISSUE#166 <https://github.com/pp-mo/ncdata/pull/166>`_)
See: :ref:`equality_testing` (`ISSUE#166 <https://github.com/SciTools/ncdata/pull/166>`_)


Documentation changes
^^^^^^^^^^^^^^^^^^^^^

- Added a `userguide page <userdocs/user_guide/utilities.html>`_ summarising all the utility features in :mod:`ncdata.utils`. (`ISSUE#161 <https://github.com/pp-mo/ncdata/pull/161>`_)
- Made all docs examples into doctests; add doctest CI action. (`ISSUE#136 <https://github.com/pp-mo/ncdata/pull/136>`_)
- Added a `userguide page <userdocs/user_guide/utilities.html>`_ summarising all the utility features in :mod:`ncdata.utils`. (`ISSUE#161 <https://github.com/SciTools/ncdata/pull/161>`_)
- Made all docs examples into doctests; add doctest CI action. (`ISSUE#136 <https://github.com/SciTools/ncdata/pull/136>`_)


Bug Fixes
^^^^^^^^^

- Fixed a bug in dataset comparison, where variables with missing or unbroadcastable data arrays could cause errors rather than generating difference messages. (`ISSUE#153 <https://github.com/pp-mo/ncdata/pull/153>`_)
- Fixed a bug in dataset comparison, where variables with missing or unbroadcastable data arrays could cause errors rather than generating difference messages. (`ISSUE#153 <https://github.com/SciTools/ncdata/pull/153>`_)


Developer and Internal changes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- Switch to towncrier for whats-new management. (`ISSUE#116 <https://github.com/pp-mo/ncdata/pull/116>`_)
- Added regular linkcheck gha. (`ISSUE#123 <https://github.com/pp-mo/ncdata/pull/123>`_)
- @valeriupredoi added test for Zarr conversion to Iris cubes. (`ISSUE#145 <https://github.com/pp-mo/ncdata/pull/145>`_)
- Switch to towncrier for whats-new management. (`ISSUE#116 <https://github.com/SciTools/ncdata/pull/116>`_)
- Added regular linkcheck gha. (`ISSUE#123 <https://github.com/SciTools/ncdata/pull/123>`_)
- @valeriupredoi added test for Zarr conversion to Iris cubes. (`ISSUE#145 <https://github.com/SciTools/ncdata/pull/145>`_)


v0.2.0
Expand All @@ -130,67 +130,67 @@ Overhauled data manipulation APIs. Expanded and improved documentation.

* `@pp-mo`_ Reviewed, corrected, reorganised and expanded all documentation.
Added description section on core classes and operations, and how-to snippets.
(`PR#109 <https://github.com/pp-mo/ncdata/pull/109>`_).
(`PR#109 <https://github.com/SciTools/ncdata/pull/109>`_).

* `@pp-mo`_ Unpin Numpy to support versions >= 2.0
(`PR#112 <https://github.com/pp-mo/ncdata/pull/112>`_).
(`PR#112 <https://github.com/SciTools/ncdata/pull/112>`_).

* `@pp-mo`_ Added crude dimension-based load chunking control.
(`PR#108 <https://github.com/pp-mo/ncdata/pull/108>`_).
(`PR#108 <https://github.com/SciTools/ncdata/pull/108>`_).

* `@pp-mo`_ Support equality testing (==) of dimensions and attributes.
(`PR#107 <https://github.com/pp-mo/ncdata/pull/107>`_).
(`PR#107 <https://github.com/SciTools/ncdata/pull/107>`_).

* `@pp-mo`_ Enforce that NcAttribute.value is always an 0- or 1-D array.
(`PR#106 <https://github.com/pp-mo/ncdata/pull/106>`_).
(`PR#106 <https://github.com/SciTools/ncdata/pull/106>`_).

* `@pp-mo`_ Support copy as utility, and as core classes copy() methods.
(`PR#98 <https://github.com/pp-mo/ncdata/pull/98>`_).
(`PR#98 <https://github.com/SciTools/ncdata/pull/98>`_).

* `@pp-mo`_ Support a simple {name: value} map for attributes in data constructors.
(`PR#71 <https://github.com/pp-mo/ncdata/pull/71>`_).
(`PR#71 <https://github.com/SciTools/ncdata/pull/71>`_).

* `@pp-mo`_ Make dataset comparison routines a public utility.
(`PR#70 <https://github.com/pp-mo/ncdata/pull/70>`_).
(`PR#70 <https://github.com/SciTools/ncdata/pull/70>`_).

* `@pp-mo`_ initial Sphinx documentation
(`PR#76 <https://github.com/pp-mo/ncdata/pull/76>`_).
(`PR#76 <https://github.com/SciTools/ncdata/pull/76>`_).

* `@trexfeathers`_ added a Logo
(`PR#75 <https://github.com/pp-mo/ncdata/pull/75>`_).
(`PR#75 <https://github.com/SciTools/ncdata/pull/75>`_).

* `@pp-mo`_ added Save errors util
(`PR#64 <https://github.com/pp-mo/ncdata/pull/64>`_).
(`PR#64 <https://github.com/SciTools/ncdata/pull/64>`_).


v0.1.1
~~~~~~
Small tweaks + bug fixes.
**Note:** `PR#62 <https://github.com/pp-mo/ncdata/pull/62>`_, and
`PR#59 <https://github.com/pp-mo/ncdata/pull/59>`_ are important fixes to
**Note:** `PR#62 <https://github.com/SciTools/ncdata/pull/62>`_, and
`PR#59 <https://github.com/SciTools/ncdata/pull/59>`_ are important fixes to
achieve intended performance goals,
i.e. moving arbitrarily large data via Dask without running out of memory.

`v0.1.1 on GitHub <https://github.com/pp-mo/ncdata/releases/tag/v0.1.1>`_
`v0.1.1 on GitHub <https://github.com/SciTools/ncdata/releases/tag/v0.1.1>`_

* Stop non-numpy attribute values from breaking attribute printout.
`PR#63 <https://github.com/pp-mo/ncdata/pull/63>`_
`PR#63 <https://github.com/SciTools/ncdata/pull/63>`_

* Stop ``ncdata.iris.from_iris()`` consuming full data memory for each variable.
`PR#62 <https://github.com/pp-mo/ncdata/pull/62>`_
`PR#62 <https://github.com/SciTools/ncdata/pull/62>`_

* Provide convenience APIs for ncdata component dictionaries and attribute values.
`PR#61 <https://github.com/pp-mo/ncdata/pull/61>`_
`PR#61 <https://github.com/SciTools/ncdata/pull/61>`_

* Use dask ``chunks="auto"`` in ``ncdata.netcdf4.from_nc4()``.
`PR#59 <https://github.com/pp-mo/ncdata/pull/59>`_
`PR#59 <https://github.com/SciTools/ncdata/pull/59>`_


v0.1.0
~~~~~~
First release

`v0.1.0 on GitHub <https://github.com/pp-mo/ncdata/releases/tag/v0.1.0>`_
`v0.1.0 on GitHub <https://github.com/SciTools/ncdata/releases/tag/v0.1.0>`_

.. _@trexfeathers: https://github.com/trexfeathers
.. _@pp-mo: https://github.com/trexfeathers
1 change: 1 addition & 0 deletions docs/changelog_fragments/198.dev.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix links broken by move to SciTools.
2 changes: 1 addition & 1 deletion docs/details/developer_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,4 +136,4 @@ Release actions
* check that the new version appears in the output of ``$ conda search ncdata``


.. _ReadTheDocs: https://readthedocs.org/projects/ncdata
.. _ReadTheDocs: https://app.readthedocs.org/projects/ncdata/
6 changes: 3 additions & 3 deletions docs/details/interface_support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ masked data to NaNs.
dataset encodings are not reproduced, most notably
**any "unlimited_dims" control is lost**. But, this is effectively a bug,
which may be fixed later.
See : `issue#66 <https://github.com/pp-mo/ncdata/issues/66>`_
See : `issue#66 <https://github.com/SciTools/ncdata/issues/66>`_


Iris Compatibility
Expand All @@ -110,8 +110,8 @@ see : `support added in v3.7.0 <https://scitools-iris.readthedocs.io/en/stable/w

In conversion from iris cubes with :func:`ncdata.iris.from_iris`
use of an `unlimited_dims` key currently causes an exception
See : `issue#43 <https://github.com/pp-mo/ncdata/issues/43>`_
See : `issue#43 <https://github.com/SciTools/ncdata/issues/43>`_


.. _Continuous Integration testing on GitHub: https://github.com/pp-mo/ncdata/blob/main/.github/workflows/ci-tests.yml
.. _Continuous Integration testing on GitHub: https://github.com/SciTools/ncdata/blob/main/.github/workflows/ci-tests.yml
.. _NetCDF Classic Data Model: https://docs.unidata.ucar.edu/netcdf-c/current/netcdf_data_model.html#classic_model
4 changes: 2 additions & 2 deletions docs/details/known_issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To be fixed

* use of an `unlimited_dims` key currently causes an exception

* `issue#43 <https://github.com/pp-mo/ncdata/issues/43>`_
* `issue#43 <https://github.com/SciTools/ncdata/issues/43>`_

* in conversion to xarray
with `to_xarray <https://ncdata.readthedocs.io/en/latest/details/api/ncdata.xarray.html#ncdata.xarray.to_xarray>`_
Expand All @@ -21,7 +21,7 @@ To be fixed

* most notably, **the "unlimited_dims" control is missing**

* `issue#66 <https://github.com/pp-mo/ncdata/issues/66>`_
* `issue#66 <https://github.com/SciTools/ncdata/issues/66>`_

* in conversion to/from netCDF4 files

Expand Down
Loading