earthkit-transforms

Quick Start • Installation • Documentation

[!IMPORTANT] This software is Incubating and subject to ECMWF's guidelines on Software Maturity.

earthkit-transforms is a library of software tools to support people working with climate and meteorology data.

earthkit-transforms is made up of a sub-package, aggregate, which contains methods for aggregating data in time and spaces and other abstract dimensions.

It has been designed following the philosphy of earthkit, hence the methods should be interoperable with any data object understood by earthkit-data.

Installation

pip install earthkit-transforms

Quick Start

from earthkit.transforms import aggregate

daily_mean = aggregate.temporal.daily_mean(MY_DATA)

Detailed documentation

Please refer the earthkit-transforms readthedocs page for more detailed documentation, example notebooks and the API reference guide.

Workflow for developers/contributors

For best experience create a new conda environment (e.g. DEVELOP) with latest stable version of Python (version 3.13 at time of writing):

conda create -n DEVELOP -c conda-forge python=3.13
conda activate DEVELOP

Before pushing to GitHub, run the following commands:

• Update conda environment: make conda-env-update
• Install this package: pip install -e .
• Run quality assurance checks: make default

Licence

Copyright 2022, European Centre for Medium Range Weather Forecasts.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

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.