anemoi-utils 0.4.4__tar.gz → 0.4.6__tar.gz

anemoi_utils-0.4.6/.github/workflows/changelog-pr-update.yml

@@ -0,0 +1,18 @@
+# name: Check Changelog Update on PR
+# on:
+#   pull_request:
+#     types: [assigned, opened, synchronize, reopened, labeled, unlabeled]
+#     branches:
+#       - main
+#       - develop
+#     paths-ignore:
+#       - .pre-commit-config.yaml
+#       - .readthedocs.yaml
+# jobs:
+#   Check-Changelog:
+#     name: Check Changelog Action
+#     runs-on: ubuntu-20.04
+#     steps:
+#       - uses: tarides/changelog-check-action@v2
+#         with:
+#           changelog: CHANGELOG.md

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/.github/workflows/changelog-release-update.yml

@@ -2,9 +2,11 @@
 name: "Update Changelog"
 
 on:
-  release:
-    types: [released]
-  workflow_dispatch: ~
+  workflow_run:
+    workflows:
+      - Upload Python Package
+    types:
+      - completed
 
 permissions:
   pull-requests: write
@@ -13,6 +15,7 @@ permissions:
 jobs:
   update:
     runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
 
     steps:
     - name: Checkout code
@@ -25,11 +28,18 @@ jobs:
       with:
         latest-version: ${{ github.event.release.tag_name }}
         heading-text: ${{ github.event.release.name }}
+        release-notes: ${{ github.event.release.body }}
 
     - name: Create Pull Request
       uses: peter-evans/create-pull-request@v6
       with:
         branch: docs/changelog-update-${{ github.event.release.tag_name }}
+        base: develop
         title: '[Changelog] Update to ${{ github.event.release.tag_name }}'
+        body: |
+          This PR updates the changelog to include the changes in the latest release.
+
+          > [!CAUTION]
+          > Merge DO NOT squash to correctly update the tag version of `develop` branch.
         add-paths: |
           CHANGELOG.md

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/.github/workflows/ci.yml

@@ -31,13 +31,28 @@ jobs:
     with:
       anemoi-utils: ecmwf/anemoi-utils@${{ github.event.pull_request.head.sha || github.sha }}
       codecov_upload: true
+      skip_matrix_jobs: |
+        gnu@debian-11
+        clang@rocky-8.6
+        gnu@debian-11
+        gnu@rocky-8.6
+        clang@rocky-8.6
+        gnu@fedora-37
     secrets: inherit
 
-   # Build downstream packages on HPC
-  downstream-ci-hpc:
-    name: downstream-ci-hpc
-    if: ${{ !github.event.pull_request.head.repo.fork && github.event.action != 'labeled' || github.event.label.name == 'approved-for-ci' }}
-    uses: ecmwf-actions/downstream-ci/.github/workflows/downstream-ci-hpc.yml@main
-    with:
-      anemoi-utils: ecmwf/anemoi-utils@${{ github.event.pull_request.head.sha || github.sha }}
-    secrets: inherit
+#   # Build downstream packages on HPC
+#  downstream-ci-hpc:
+#    name: downstream-ci-hpc
+#    if: ${{ !github.event.pull_request.head.repo.fork && github.event.action != 'labeled' || github.event.label.name == 'approved-for-ci' }}
+#    uses: ecmwf-actions/downstream-ci/.github/workflows/downstream-ci.yml@main
+#    with:
+#      anemoi-utils: ecmwf/anemoi-utils@${{ github.event.pull_request.head.sha || github.sha }}
+#      codecov_upload: true
+#      skip_matrix_jobs: |
+#        gnu@debian-11
+#        clang@rocky-8.6
+#        gnu@debian-11
+#        gnu@rocky-8.6
+#        clang@rocky-8.6
+#        gnu@fedora-37
+#    secrets: inherit

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/.github/workflows/python-pull-request.yml

@@ -1,12 +1,17 @@
 # This workflow will upload a Python Package using Twine when a release is created
 # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
 
-name: Code Quality checks for PRs
+name: Test PR
 
 on:
-  push:
   pull_request:
     types: [opened, synchronize, reopened]
+  push:
+    branches:
+      - develop
+  schedule:
+    - cron: "9 2 * * 0" # at 9:02 on sunday
+
 
 jobs:
   quality:
@@ -17,7 +22,7 @@ jobs:
   checks:
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.11"]
     uses: ecmwf-actions/reusable-workflows/.github/workflows/qa-pytest-pyproject.yml@v2
     with:
       python-version: ${{ matrix.python-version }}

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/.pre-commit-config.yaml

@@ -27,7 +27,7 @@ repos:
     -   id: python-check-blanket-noqa # Check for # noqa: all
     -   id: python-no-log-warn # Check for log.warn
 - repo: https://github.com/psf/black-pre-commit-mirror
-  rev: 24.8.0
+  rev: 24.10.0
   hooks:
   - id: black
     args: [--line-length=120]
@@ -40,7 +40,7 @@ repos:
     - --force-single-line-imports
     - --profile black
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.6.9
+  rev: v0.7.2
   hooks:
   - id: ruff
     args:
@@ -59,13 +59,8 @@ repos:
   hooks:
   - id: rstfmt
     exclude: 'cli/.*' # Because we use argparse
-- repo: https://github.com/b8raoult/pre-commit-docconvert
-  rev: "0.1.5"
-  hooks:
-  - id: docconvert
-    args: ["numpy"]
 - repo: https://github.com/tox-dev/pyproject-fmt
-  rev: "2.2.4"
+  rev: "v2.5.0"
   hooks:
   - id: pyproject-fmt
 -   repo: https://github.com/jshwi/docsig # Check docstrings against function sig

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/CHANGELOG.md

@@ -8,19 +8,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 Please add your functional changes to the appropriate section in the PR.
 Keep it human-readable, your future self will thank you!
 
-## [Unreleased](https://github.com/ecmwf/anemoi-utils/compare/0.4.3...HEAD)
+## [0.4.5](https://github.com/ecmwf/anemoi-utils/compare/0.4.4...0.4.5) - 2024-11-06
+
+### What's Changed
+
+* upload with ssh by @floriankrb in https://github.com/ecmwf/anemoi-utils/pull/25
+* feat: Add aliases decorator by @HCookie in https://github.com/ecmwf/anemoi-utils/pull/40
+
+**Full Changelog**: https://github.com/ecmwf/anemoi-utils/compare/0.4.4...0.4.5
+
+## [0.4.4](https://github.com/ecmwf/anemoi-utils/compare/0.4.3...0.4.4) - 2024-11-01
 
 ## [0.4.3](https://github.com/ecmwf/anemoi-utils/compare/0.4.1...0.4.3) - 2024-10-26
 
 ## [0.4.2](https://github.com/ecmwf/anemoi-utils/compare/0.4.1...0.4.2) - 2024-10-25
 
 ### Added
+
 - Add supporting_arrays to checkpoints
 - Add factories registry
 - Optional renaming of subcommands via `command` attribute [#34](https://github.com/ecmwf/anemoi-utils/pull/34)
 - `skip_on_hpc` pytest marker for tests that should not be run on HPC [36](https://github.com/ecmwf/anemoi-utils/pull/36)
 
-
 ## [0.4.1](https://github.com/ecmwf/anemoi-utils/compare/0.4.0...0.4.1) - 2024-10-23
 
 ## Fixed
@@ -51,7 +60,9 @@ Keep it human-readable, your future self will thank you!
 - Changelog merge strategy- Codeowners file
 - Create dependency on wcwidth. MIT licence.
 - Add distribution name dictionary to provenance [#15](https://github.com/ecmwf/anemoi-utils/pull/15) & [#19](https://github.com/ecmwf/anemoi-utils/pull/19)
-- Add anonimize() function.
+- Add anonymize() function.
+- Add transfer to ssh:// target (experimental)
+- Deprecated 'anemoi.utils.s3'
 
 ### Changed
 

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: anemoi-utils
-Version: 0.4.4
+Version: 0.4.6
 Summary: A package to hold various functions to support training of ML models on ECMWF data.
 Author-email: "European Centre for Medium-Range Weather Forecasts (ECMWF)" <software.support@ecmwf.int>
 License:                                  Apache License
@@ -219,6 +219,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.9

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/pyproject.toml

@@ -1,14 +1,12 @@
-#!/usr/bin/env python
-# (C) Copyright 2024 ECMWF.
+# (C) Copyright 2024 Anemoi contributors.
 #
 # This software is licensed under the terms of the Apache Licence Version 2.0
 # which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
+#
 # In applying this licence, ECMWF does not waive the privileges and immunities
 # granted to it by virtue of its status as an intergovernmental organisation
 # nor does it submit to any jurisdiction.
 
-# https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
-
 [build-system]
 requires = [ "setuptools>=60", "setuptools-scm>=8" ]
 
@@ -35,6 +33,7 @@ classifiers = [
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/src/anemoi/utils/__main__.py

@@ -1,12 +1,11 @@
-#!/usr/bin/env python
-# (C) Copyright 2024 ECMWF.
+# (C) Copyright 2024 Anemoi contributors.
 #
 # This software is licensed under the terms of the Apache Licence Version 2.0
 # which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
+#
 # In applying this licence, ECMWF does not waive the privileges and immunities
 # granted to it by virtue of its status as an intergovernmental organisation
 # nor does it submit to any jurisdiction.
-#
 
 from anemoi.utils.cli import cli_main
 from anemoi.utils.cli import make_parser

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/src/anemoi/utils/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.4.4'
-__version_tuple__ = version_tuple = (0, 4, 4)
+__version__ = version = '0.4.6'
+__version_tuple__ = version_tuple = (0, 4, 6)

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/src/anemoi/utils/checkpoints.py

@@ -94,8 +94,8 @@ def load_metadata(path: str, *, supporting_arrays=False, name: str = DEFAULT_NAM
         with zipfile.ZipFile(path, "r") as f:
             metadata = json.load(f.open(metadata, "r"))
             if supporting_arrays:
-                metadata["supporting_arrays"] = load_supporting_arrays(f, metadata.get("supporting_arrays", {}))
-                return metadata, supporting_arrays
+                arrays = load_supporting_arrays(f, metadata.get("supporting_arrays_paths", {}))
+                return metadata, arrays
 
             return metadata
     else:

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/src/anemoi/utils/commands/__init__.py

@@ -1,12 +1,11 @@
-#!/usr/bin/env python
-# (C) Copyright 2024 ECMWF.
+# (C) Copyright 2024 Anemoi contributors.
 #
 # This software is licensed under the terms of the Apache Licence Version 2.0
 # which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
+#
 # In applying this licence, ECMWF does not waive the privileges and immunities
 # granted to it by virtue of its status as an intergovernmental organisation
 # nor does it submit to any jurisdiction.
-#
 
 import os
 

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/src/anemoi/utils/commands/config.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 # (C) Copyright 2024 Anemoi contributors.
 #
 # This software is licensed under the terms of the Apache Licence Version 2.0

anemoi_utils-0.4.6/src/anemoi/utils/compatibility.py

@@ -0,0 +1,76 @@
+# (C) Copyright 2024 Anemoi contributors.
+#
+# This software is licensed under the terms of the Apache Licence Version 2.0
+# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# In applying this licence, ECMWF does not waive the privileges and immunities
+# granted to it by virtue of its status as an intergovernmental organisation
+# nor does it submit to any jurisdiction.
+
+from __future__ import annotations
+
+import functools
+from typing import Any
+from typing import Callable
+
+
+def aliases(
+    aliases: dict[str, str | list[str]] | None = None, **kwargs: str | list[str]
+) -> Callable[[Callable], Callable]:
+    """Alias keyword arguments in a function call.
+
+    Allows for dynamically renaming keyword arguments in a function call.
+
+    Parameters
+    ----------
+    aliases : dict[str, str  |  list[str]] | None, optional
+        Key, value pair of aliases, with keys being the true name, and value being a str or list of aliases,
+        by default None
+    **kwargs : str | list[str]
+        Kwargs form of aliases
+
+    Returns
+    -------
+    Callable
+        Decorator function that renames keyword arguments in a function call.
+
+    Raises
+    ------
+    ValueError
+        If the aliasing would result in duplicate keys.
+
+    Examples
+    --------
+    ```python
+    @aliases(a="b", c=["d", "e"])
+    def func(a, c):
+        return a, c
+
+    func(a=1, c=2)  # (1, 2)
+    func(b=1, d=2)  # (1, 2)
+    ```
+
+    """
+
+    if aliases is None:
+        aliases = {}
+    aliases.update(kwargs)
+
+    aliases = {v: k for k, vs in aliases.items() for v in (vs if isinstance(vs, list) else [vs])}
+
+    def decorator(func: Callable) -> Callable:
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs) -> Any:
+            keys = kwargs.keys()
+            for k in set(keys).intersection(set(aliases.keys())):
+                if aliases[k] in keys:
+                    raise ValueError(
+                        f"When aliasing {k} with {aliases[k]} duplicate keys were present. Cannot include both."
+                    )
+                kwargs[aliases[k]] = kwargs.pop(k)
+
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/src/anemoi/utils/hindcasts.py

@@ -27,16 +27,16 @@ class HindcastDatesTimes:
 
         self.reference_dates = reference_dates
 
-        if isinstance(years, list):
-            self.years = years
-        else:
-            self.years = range(1, years + 1)
+        assert isinstance(years, int), f"years must be an integer, got {years}"
+        assert years > 0, f"years must be greater than 0, got {years}"
+        self.years = years
 
     def __iter__(self):
         for reference_date in self.reference_dates:
-            for year in self.years:
-                if reference_date.month == 2 and reference_date.day == 29:
-                    date = datetime.datetime(reference_date.year - year, 2, 28)
-                else:
-                    date = datetime.datetime(reference_date.year - year, reference_date.month, reference_date.day)
+            year, month, day = reference_date.year, reference_date.month, reference_date.day
+            if (month, day) == (2, 29):
+                day = 28
+
+            for i in range(1, self.years + 1):
+                date = datetime.datetime(year - i, month, day)
                 yield (date, reference_date)

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/src/anemoi/utils/mars/__init__.py

@@ -1,6 +1,8 @@
-# (C) Copyright 2024 European Centre for Medium-Range Weather Forecasts.
+# (C) Copyright 2024 Anemoi contributors.
+#
 # This software is licensed under the terms of the Apache Licence Version 2.0
 # which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
+#
 # In applying this licence, ECMWF does not waive the privileges and immunities
 # granted to it by virtue of its status as an intergovernmental organisation
 # nor does it submit to any jurisdiction.

{anemoi_utils-0.4.4 → anemoi_utils-0.4.6}/src/anemoi/utils/registry.py

@@ -30,14 +30,23 @@ class Wrapper:
         return factory
 
 
+_BY_KIND = {}
+
+
 class Registry:
     """A registry of factories"""
 
-    def __init__(self, package):
+    def __init__(self, package, key="_type"):
 
         self.package = package
         self.registered = {}
         self.kind = package.split(".")[-1]
+        self.key = key
+        _BY_KIND[self.kind] = self
+
+    @classmethod
+    def lookup_kind(cls, kind: str):
+        return _BY_KIND.get(kind)
 
     def register(self, name: str, factory: callable = None):
 
@@ -46,6 +55,9 @@ class Registry:
 
         self.registered[name] = factory
 
+    # def registered(self, name: str):
+    #     return name in self.registered
+
     def _load(self, file):
         name, _ = os.path.splitext(file)
         try:
@@ -53,7 +65,9 @@ class Registry:
         except Exception:
             LOG.warning(f"Error loading filter '{self.package}.{name}'", exc_info=True)
 
-    def lookup(self, name: str) -> callable:
+    def lookup(self, name: str, *, return_none=False) -> callable:
+
+        # print('✅✅✅✅✅✅✅✅✅✅✅✅✅', name, self.registered)
         if name in self.registered:
             return self.registered[name]
 
@@ -86,6 +100,12 @@ class Registry:
                 self.registered[name] = entry_point.load()
 
         if name not in self.registered:
+            if return_none:
+                return None
+
+            for e in self.registered:
+                LOG.info(f"Registered: {e}")
+
             raise ValueError(f"Cannot load '{name}' from {self.package}")
 
         return self.registered[name]
@@ -94,5 +114,33 @@ class Registry:
         factory = self.lookup(name)
         return factory(*args, **kwargs)
 
-    def __call__(self, name: str, *args, **kwargs):
-        return self.create(name, *args, **kwargs)
+    # def __call__(self, name: str, *args, **kwargs):
+    #     return self.create(name, *args, **kwargs)
+
+    def from_config(self, config, *args, **kwargs):
+        if isinstance(config, str):
+            config = {config: {}}
+
+        if not isinstance(config, dict):
+            raise ValueError(f"Invalid config: {config}")
+
+        if self.key in config:
+            config = config.copy()
+            key = config.pop(self.key)
+            return self.create(key, *args, **config, **kwargs)
+
+        if len(config) == 1:
+            key = list(config.keys())[0]
+            value = config[key]
+
+            if isinstance(value, dict):
+                return self.create(key, *args, **value, **kwargs)
+
+            if isinstance(value, list):
+                return self.create(key, *args, *value, **kwargs)
+
+            return self.create(key, *args, value, **kwargs)
+
+        raise ValueError(
+            f"Entry '{config}' must either be a string, a dictionary with a single entry, or a dictionary with a '{self.key}' key"
+        )