diff --git a/docs/change_log.rst b/docs/change_log.rst index 3236be32..68465e52 100644 --- a/docs/change_log.rst +++ b/docs/change_log.rst @@ -32,7 +32,7 @@ A bugfix release, just to allow working with Python 3.10. Bug Fixes ^^^^^^^^^ -- Made indexing work with Python v3.10. (`ISSUE#183 `_) +- Made indexing work with Python v3.10. (`ISSUE#183 `_) Developer and Internal changes @@ -40,7 +40,7 @@ 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 `_) + (`ISSUE#186 `_) @@ -64,15 +64,15 @@ xarray (`2025.10.1 `_) Documentation changes ^^^^^^^^^^^^^^^^^^^^^ -- Document how to create a developer installation. (`ISSUE#174 `_) +- Document how to create a developer installation. (`ISSUE#174 `_) Developer and Internal changes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- Fix xarray 2025.09.1 problem. (`ISSUE#173 `_) +- Fix xarray 2025.09.1 problem. (`ISSUE#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 `_) + **Not** python 3.14, for now, due to emerging problems with dependencies (notably Iris). (`ISSUE#175 `_) v0.3.0 @@ -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 `_) + See: :ref:`utils_indexing` (`ISSUE#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 `_) + the name in all variables which use it. (`ISSUE#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 `_) + See: :ref:`attributes_and_avals` (`ISSUE#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 `_) + This means you can use load controls such as callbacks and constraints. (`ISSUE#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 `_) + See: :ref:`equality_testing` (`ISSUE#166 `_) Documentation changes ^^^^^^^^^^^^^^^^^^^^^ -- Added a `userguide page `_ summarising all the utility features in :mod:`ncdata.utils`. (`ISSUE#161 `_) -- Made all docs examples into doctests; add doctest CI action. (`ISSUE#136 `_) +- Added a `userguide page `_ summarising all the utility features in :mod:`ncdata.utils`. (`ISSUE#161 `_) +- Made all docs examples into doctests; add doctest CI action. (`ISSUE#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 `_) +- Fixed a bug in dataset comparison, where variables with missing or unbroadcastable data arrays could cause errors rather than generating difference messages. (`ISSUE#153 `_) Developer and Internal changes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- Switch to towncrier for whats-new management. (`ISSUE#116 `_) -- Added regular linkcheck gha. (`ISSUE#123 `_) -- @valeriupredoi added test for Zarr conversion to Iris cubes. (`ISSUE#145 `_) +- Switch to towncrier for whats-new management. (`ISSUE#116 `_) +- Added regular linkcheck gha. (`ISSUE#123 `_) +- @valeriupredoi added test for Zarr conversion to Iris cubes. (`ISSUE#145 `_) v0.2.0 @@ -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 `_). + (`PR#109 `_). * `@pp-mo`_ Unpin Numpy to support versions >= 2.0 - (`PR#112 `_). + (`PR#112 `_). * `@pp-mo`_ Added crude dimension-based load chunking control. - (`PR#108 `_). + (`PR#108 `_). * `@pp-mo`_ Support equality testing (==) of dimensions and attributes. - (`PR#107 `_). + (`PR#107 `_). * `@pp-mo`_ Enforce that NcAttribute.value is always an 0- or 1-D array. - (`PR#106 `_). + (`PR#106 `_). * `@pp-mo`_ Support copy as utility, and as core classes copy() methods. - (`PR#98 `_). + (`PR#98 `_). * `@pp-mo`_ Support a simple {name: value} map for attributes in data constructors. - (`PR#71 `_). + (`PR#71 `_). * `@pp-mo`_ Make dataset comparison routines a public utility. - (`PR#70 `_). + (`PR#70 `_). * `@pp-mo`_ initial Sphinx documentation - (`PR#76 `_). + (`PR#76 `_). * `@trexfeathers`_ added a Logo - (`PR#75 `_). + (`PR#75 `_). * `@pp-mo`_ added Save errors util - (`PR#64 `_). + (`PR#64 `_). v0.1.1 ~~~~~~ Small tweaks + bug fixes. -**Note:** `PR#62 `_, and -`PR#59 `_ are important fixes to +**Note:** `PR#62 `_, and +`PR#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 `_ +`v0.1.1 on GitHub `_ * Stop non-numpy attribute values from breaking attribute printout. - `PR#63 `_ + `PR#63 `_ * Stop ``ncdata.iris.from_iris()`` consuming full data memory for each variable. - `PR#62 `_ + `PR#62 `_ * Provide convenience APIs for ncdata component dictionaries and attribute values. - `PR#61 `_ + `PR#61 `_ * Use dask ``chunks="auto"`` in ``ncdata.netcdf4.from_nc4()``. - `PR#59 `_ + `PR#59 `_ v0.1.0 ~~~~~~ First release -`v0.1.0 on GitHub `_ +`v0.1.0 on GitHub `_ .. _@trexfeathers: https://github.com/trexfeathers .. _@pp-mo: https://github.com/trexfeathers \ No newline at end of file diff --git a/docs/changelog_fragments/198.dev.rst b/docs/changelog_fragments/198.dev.rst new file mode 100644 index 00000000..5a11a9ad --- /dev/null +++ b/docs/changelog_fragments/198.dev.rst @@ -0,0 +1 @@ +Fix links broken by move to SciTools. diff --git a/docs/details/developer_notes.rst b/docs/details/developer_notes.rst index 965adf14..68f13469 100644 --- a/docs/details/developer_notes.rst +++ b/docs/details/developer_notes.rst @@ -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/ diff --git a/docs/details/interface_support.rst b/docs/details/interface_support.rst index 5df6899d..08c95e1a 100644 --- a/docs/details/interface_support.rst +++ b/docs/details/interface_support.rst @@ -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 `_ + See : `issue#66 `_ Iris Compatibility @@ -110,8 +110,8 @@ see : `support added in v3.7.0 `_ + See : `issue#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 diff --git a/docs/details/known_issues.rst b/docs/details/known_issues.rst index 4f93eb7d..7d337cc0 100644 --- a/docs/details/known_issues.rst +++ b/docs/details/known_issues.rst @@ -12,7 +12,7 @@ To be fixed * use of an `unlimited_dims` key currently causes an exception - * `issue#43 `_ + * `issue#43 `_ * in conversion to xarray with `to_xarray `_ @@ -21,7 +21,7 @@ To be fixed * most notably, **the "unlimited_dims" control is missing** - * `issue#66 `_ + * `issue#66 `_ * in conversion to/from netCDF4 files