Predictia · AntonioCC808 · Nov 21, 2025 · Nov 21, 2025 · Dec 1, 2025 · Dec 1, 2025
diff --git a/.github/workflows/check-wrappers.yml b/.github/workflows/check-wrappers.yml
@@ -0,0 +1,32 @@
+name: Check Wrappers
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  check-wrappers:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
+
+      - name: Generate wrappers
+        run: |
+          export PYTHONPATH=$PYTHONPATH:$(pwd)/src
+          python src/earthkit/climate/generate_wrappers.py
+
+      - name: Check for changes
+        run: |
+          git diff --exit-code
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -1,19 +1,53 @@
+<p align="center">
+  <picture>
+    <source srcset="https://github.com/ecmwf/logos/raw/refs/heads/main/logos/earthkit/earthkit-climate-dark.svg" media="(prefers-color-scheme: dark)">
+    <img src="https://github.com/ecmwf/logos/raw/refs/heads/main/logos/earthkit/earthkit-climate-light.svg" height="120">
+  </picture>
+</p>
+
+<p align="center">
+  <a href="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE">
+    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE/foundation_badge.svg" alt="ECMWF Software EnginE">
+  </a>
+  <a href="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity">
+    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity/emerging_badge.svg" alt="Maturity Level">
+  </a>
+  <a href="https://opensource.org/licenses/apache-2-0">
+    <img src="https://img.shields.io/badge/Licence-Apache 2.0-blue.svg" alt="Licence">
+  </a>
+  <a href="https://github.com/ecmwf/earthkit-climate/releases">
+    <img src="https://img.shields.io/github/v/release/ecmwf/earthkit-climate?color=purple&label=Release" alt="Latest Release">
+  </a>
+</p>
+
+<p align="center">
+  <a href="#quick-start">Quick Start</a>
+  •
+  <a href="https://earthkit-climate.readthedocs.io/en/latest/">Documentation</a>
+</p>
+
+> [!IMPORTANT]
+> This software is **Emerging** and subject to ECMWF's guidelines on [Software Maturity](https://github.com/ecmwf/codex/raw/refs/heads/main/Project%20Maturity).
+
 # earthkit-climate
 
-**A toolkit for statistical analysis and processing of climate and geospatial data.**
+**earthkit-climate** is the package responsible for the climate index calculation within the earthkit ecosystem. It includes a wrapper prototype that allows the use of the `xclim` python package to compute a large amount of pre-defined climate indices used by the climate science community, and to define new ones.
+
+`xclim` relies heavily on the `xarray` python library and the `numpy` & `scipy` ecosystem. Its main elements are:
 
-`earthkit-climate` provides tools to compute and analyze **climate indicators** (e.g., precipitation, temperature) and perform **unit conversions, percentiles, and provenance tracking**.
-It is part of the **Earthkit ecosystem** and designed for reproducible, modular workflows.
+- **Climate indices**: available to be directly computed with python functions. The input and output units are defined in these functions by using a decorator and are validated during runtime.
+- **Climate indicators**: climate indices wrapped in an object that provides more metadata and validation facilities (health checks) of the input. it includes attributes for CF metadata (cell methods), references, keywords, and more.
+- **Lower level process functions**: these include aggregation, computation spell length and counting, optimized computation of reference percentiles, bias correction methods and ensemble statistics. These functions are used by the implemented indices and can also be used to build new indices not included in the library.
 
-______________________________________________________________________
+---
 
 ## Disclaimer
 
 This project is currently in **BETA** and **experimental**.
 Interfaces, structure, and functionality are subject to change without notice.
 Do **not** use this software in any operational or production system.
 
-______________________________________________________________________
+---
 
 ## Quick Start
 
@@ -33,14 +67,14 @@ from earthkit.climate.utils import conversions
 pr = precipitation.simple_daily_intensity(precip_data, freq="monthly")
 ```
 
-______________________________________________________________________
+---
 
 ## Documentation
 
 For full documentation, including API reference and example notebooks, visit the
 [earthkit-climate ReadTheDocs page](https://earthkit-climate.readthedocs.io)
 
-______________________________________________________________________
+---
 
 ## Development & Contribution Workflow
 
@@ -52,76 +86,77 @@ It provides fast, reproducible environments and replaces Conda-based workflows.
 Install Pixi following the [official instructions](https://pixi.sh/latest/#installation), then run:
 
 ```bash
-pixi install --locked
-pixi shell
+pixi install
 ```
 
 This command installs all dependencies as defined in `pyproject.toml` and `pixi.lock`.
 
-### 2. Install the package
+### 2. Common Tasks
 
-Inside the Pixi environment:
+This project uses `pixi` tasks to manage development workflows, replacing the legacy `Makefile`.
 
-```bash
-pip install -e .
-```
+- **Quality Assurance**: Run pre-commit hooks to ensure code quality.
 
-### 3. Quality checks and tests
+  ```bash
+  pixi run qa
+  ```
 
-Before pushing to GitHub, run:
+- **Unit Tests**: Run the test suite using pytest.
 
-```bash
-make qa
-make unit-tests
-```
+  ```bash
+  pixi run unit-tests
+  ```
 
-You can also perform type checking and integration tests:
+- **Type Checking**: Run static type analysis with mypy.
 
-```bash
-make type-check
-make integration-tests
-```
+  ```bash
+  pixi run type-check
+  ```
 
-### 4. Documentation
+- **Build Documentation**: Build the Sphinx documentation. Note that this task runs in the `docs` environment.
 
-To build the documentation locally (using Sphinx):
+  ```bash
+  pixi run -e docs docs-build
+  ```
 
-```bash
-make docs-build
-```
+- **Docker**: Build and run the docker container.
 
-### 5. Optional: Sync with ECMWF template
+  ```bash
+  pixi run docker-build
+  pixi run docker-run
+  ```
 
-```bash
-make template-update
-```
+- **Sync with ECMWF template**:
+  ```bash
+  pixi run template-update
+  ```
 
-______________________________________________________________________
+---
 
 ## Project Structure
 
 ```
 earthkit-climate/
 ├── src/earthkit/
 │   ├── climate/
+│   │   ├── api/               # API wrapper logic
 │   │   ├── indicators/        # Climate indices (precipitation, temperature, etc.)
 │   │   └── utils/             # Type conversions, percentiles, provenance
 │   └── __init__.py
 ├── tests/
-│   ├── integration/           # Integration tests
-│   └── unit/                  # Unit tests for indicators and utils
+│   ├── unit/                  # Unit tests for indicators and utils
+│   └── test_00_version.py     # Version check
 ├── docs/                      # Sphinx documentation
 ├── ci/                        # Continuous integration configs
 ├── .github/workflows/         # GitHub Actions (push/release)
 ├── .pixi/                     # Pixi configuration
 ├── pixi.lock                  # Locked dependency versions
 ├── Dockerfile                 # Pixi-based container
 ├── pyproject.toml             # Project configuration
-├── Makefile                   # Developer utilities (Pixi integrated)
 └── README.md
 ```
 
-______________________________________________________________________
+---
 
 ## License
 

diff --git a/docs/_static/earthkit-climate-light.svg b/docs/_static/earthkit-climate-light.svg
diff --git a/docs/conf.py b/docs/conf.py
@@ -35,7 +35,6 @@
 # ones.
 extensions = [
     "autoapi.extension",
-    "myst_parser",
     "nbsphinx",
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
@@ -77,6 +76,7 @@
 # a list of builtin themes.
 #
 html_theme = "sphinx_rtd_theme"
+html_logo = "_static/earthkit-climate-light.svg"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/development.rst b/docs/development.rst
@@ -0,0 +1,61 @@
+Development
+===========
+
+Development & Contribution Workflow
+-----------------------------------
+
+1. Setup environment (with Pixi)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This project uses `Pixi <https://pixi.sh>`_ for dependency and environment management.
+It provides fast, reproducible environments and replaces Conda-based workflows.
+
+Install Pixi following the `official instructions <https://pixi.sh/latest/#installation>`_, then run:
+
+.. code-block:: bash
+
+   pixi install
+
+This command installs all dependencies as defined in ``pyproject.toml`` and ``pixi.lock``.
+
+2. Common Tasks
+~~~~~~~~~~~~~~~
+
+This project uses ``pixi`` tasks to manage development workflows, replacing the legacy ``Makefile``.
+
+- **Quality Assurance**: Run pre-commit hooks to ensure code quality.
+
+  .. code-block:: bash
+
+     pixi run qa
+
+- **Unit Tests**: Run the test suite using pytest.
+
+  .. code-block:: bash
+
+     pixi run unit-tests
+
+- **Type Checking**: Run static type analysis with mypy.
+
+  .. code-block:: bash
+
+     pixi run type-check
+
+- **Build Documentation**: Build the Sphinx documentation. Note that this task runs in the ``docs`` environment.
+
+  .. code-block:: bash
+
+     pixi run -e docs docs-build
+
+- **Docker**: Build and run the docker container.
+
+  .. code-block:: bash
+
+     pixi run docker-build
+     pixi run docker-run
+
+- **Sync with ECMWF template**:
+
+  .. code-block:: bash
+
+     pixi run template-update
diff --git a/docs/examples.md b/docs/examples.md
diff --git a/docs/gallery.rst b/docs/gallery.rst
@@ -0,0 +1,4 @@
+Gallery
+=======
+
+(Coming soon)
diff --git a/docs/index.md b/docs/index.md