Skip to content

Commit

Permalink
Main into develop (#441)
Browse files Browse the repository at this point in the history
* Update cdsapi minimum version to 0.7.1 (#434)

* Add ni nj to grib1 geography summary tests (#435)

* Add release notes for 0.10.0 (#440)

* Add release notes for 0.10.0
  • Loading branch information
sandorkertesz authored Sep 3, 2024
1 parent 973c436 commit 77b2dbc
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 4 deletions.
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"autoapi.extension",
"sphinx_issues",
"earthkit.data.sphinxext.xref",
"earthkit.data.sphinxext.module_output",
]
Expand All @@ -63,6 +64,10 @@
napoleon_numpy_docstring = True
napoleon_preprocess_types = True

# Path to GitHub repo {group}/{project} (note that `group` is the GitHub user or organization)
issues_github_path = "ecmwf/earthkit-data"


# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/caching.rst
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ The following code shows how to change the ``user-cache-directory`` settings:
>>> settings.get("user-cache-directory") # Find the current cache directory
/tmp/earthkit-data-myusername
>>> # Change the value of the setting
>>> settings.set("cache-user-directory", "/big-disk/earthkit-data-cache")
>>> settings.set("user-cache-directory", "/big-disk/earthkit-data-cache")
# Python kernel restarted
Expand Down
1 change: 1 addition & 0 deletions docs/release_notes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Release notes
.. toctree::
:maxdepth: 1

version_0.10_updates
version_0.9_updates
version_0.8_updates
version_0.7_updates
Expand Down
26 changes: 26 additions & 0 deletions docs/release_notes/version_0.10_updates.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Version 0.10 Updates
/////////////////////////


Version 0.10.0
===============

New features
++++++++++++++++

- Refined :ref:`GRIB` data memory management when reading from a file (:pr:`428`). See :ref:`grib-memory` for an overview.
- Refined how GRIB the metadata object manages the GRIB handle (:pr:`430`). See the :ref:`/examples/grib_metadata_object.ipynb` notebook example for details.
- Added the ``index`` keyword argument for data subsetting to the following methods (:pr:`407`):

- field: :meth:`~data.core.fieldlist.Field.to_numpy`, :meth:`~data.core.fieldlist.Field.to_array`, :meth:`~data.core.fieldlist.Field.data`, :meth:`~data.core.fieldlist.Field.to_latlon`, :meth:`~data.core.fieldlist.Field.to_points`
- fieldlist: :meth:`~data.core.fieldlist.FieldList.to_numpy`, :meth:`~data.core.fieldlist.FieldList.to_array`, :meth:`~data.core.fieldlist.FieldList.data`, :meth:`~data.core.fieldlist.FieldList.to_latlon`, :meth:`~data.core.fieldlist.FieldList.to_points`

- Removed normalisation of GRIB metadata keys when passed to methods like :meth:`~data.core.fieldlist.FieldList.sel`, :meth:`~data.core.fieldlist.FieldList.isel`, :meth:`~data.core.fieldlist.FieldList.order_by` and :func:`unique_values` (:pr:`429`).

- Improved the implementation of :meth:`~data.core.fieldlist.FieldList.indices` and :meth:`~data.core.fieldlist.FieldList.index` (:pr:`436`)
- Changed the default to False for the ``progress_bar`` keyword argument in :func:`unique_values`

Installation
++++++++++++

Increased minimum version of `cdsapi` to be compatible with the new CDS beta services (:pr:`433`).
7 changes: 7 additions & 0 deletions docs/release_notes/version_0.9_updates.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Version 0.9 Updates
/////////////////////////

Version 0.9.4
===============

Changes
+++++++

- Increased the minimum version of the `cdsapi` package to 0.7.1.

Version 0.9.3
===============
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ sphinx-rtd-theme
nbsphinx
setuptools
sphinx-autoapi
sphinx-issues
entrypoints
pandas
tqdm
Expand Down
1 change: 1 addition & 0 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ dependencies:
- sphinx-autoapi>=3.0.0
- sphinx_rtd_theme
- sphinxcontrib-apidoc
- sphinx-issues
- nbformat
- nbconvert
- nbsphinx
Expand Down
6 changes: 3 additions & 3 deletions src/earthkit/data/core/index.py
Original file line number Diff line number Diff line change
Expand Up @@ -475,10 +475,10 @@ def order_by(self, *args, remapping=None, patches=None, **kwargs):
(we created key "param_level" from "param" and "levelist"):
>>> ordering = ["t850", "t1000", "u1000", "v850", "v1000", "u850"]
>>> for f in ds.order_by(
... param_level=ordering, remapping={"param_level": "{param}{levelist}"}
... ):
>>> remapping = {"param_level": "{param}{levelist}"}
>>> for f in ds.order_by(param_level=ordering, remapping=remapping):
... print(f)
...
GribField(t,850,20180801,1200,0,0)
GribField(t,1000,20180801,1200,0,0)
GribField(u,1000,20180801,1200,0,0)
Expand Down
1 change: 1 addition & 0 deletions tests/environment-unit-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ dependencies:
- sphinx-autoapi
- sphinx_rtd_theme
- sphinxcontrib-apidoc
- sphinx-issues
- nbformat
- nbconvert
- nbsphinx
Expand Down

0 comments on commit 77b2dbc

Please sign in to comment.