Skip to main content

maintenance-status PyPI - Version AQUA-diagnostics tests Documentation Status codecov DOI

AQUA-diagnostics

AQUA-diagnostics contains the full set of diagnostic tools developed for the Destination Earth Adaptation Climate Digital Twin (ClimateDT). It is designed to be used together with the AQUA core framework, which provides data access and preprocessing functionalities.

This repository includes only the scientific tools configured as diagnostics to run for online monitoring of climate simulations. Diagnostics can be executed standalone via the Python API, or through the aqua analysis wrapper provided by AQUA-core.


Table of Contents


Requirements

  • Python >=3.12,<3.15
  • A working installation of AQUA-core
  • A conda/mamba environment using packages from conda-forge

Installation

1. Install AQUA-core

Follow the installation instructions in the AQUA-core repository:

📘 https://github.com/DestinE-Climate-DT/AQUA

2. Install AQUA-diagnostics

git clone git@github.com:DestinE-Climate-DT/AQUA-diagnostics.git
cd AQUA-diagnostics
mamba env create -f environment.yml
mamba activate aqua-diagnostics
pip install -e .

Next step is to install the AQUA auxiliary files as:

aqua install <machine>

Final step is to add AQUA catalogs

aqua add <catalog>

For example, to add the catalog for climatedt-phase1, run:

aqua add climatedt-phase1

Note: The AQUA-core is installed via pypi dependency. AQUA-core can also be installed in an editable mode.


Container Usage

Diagnostics can also be executed inside the AQUA container. Refer to the Container chapter in the AQUA documentation for details.


Documentation

Full documentation is available on ReadTheDocs: 📖 AQUA-diagnostics

Topics covered include:

  • Usage examples for each diagnostic
  • Configuration files (YAML)
  • How to run the analysis wrapper (aqua analysis)
  • Guidance for writing custom diagnostics

Examples

Notebooks and usage examples are available in the notebooks/ directory.


Contributing

Contributions are welcome! Please refer to the Contribution Guidelines in this repository.


License

AQUA-diagnostics is open-source software licensed under the Apache 2.0 License.

Copyright belongs to the European Union, represented by the European Commission. Funded by Contract DE_340_CSC — Destination Earth Programme Climate Adaptation Digital Twin (Climate DT).

Metadata

Release files for aqua-diagnostics 0.26.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aqua-diagnostics 0.26.0
File Size Uploaded Provenance Actions
aqua_diagnostics-0.26.0.tar.gz 694.4 kB With provenance Details for aqua_diagnostics-0.26.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aqua-diagnostics 0.26.0
File Interpreter ABI Platform Actions
aqua_diagnostics-0.26.0-py3-none-any.whl Python 3 none any Details for aqua_diagnostics-0.26.0-py3-none-any.whl

Total release size: 1.5 MB

Release files / aqua_diagnostics-0.26.0.tar.gz

Download URL aqua_diagnostics-0.26.0.tar.gz
Size 694.4 kB
Tags Source
SHA-256 checksum
How to use checksums
77bb1fd74522a58357011dd8f8fd6af4b82bec9b0f4dbdf67e9af5f5c9d768c6
BLAKE2b-256 checksum
How to use checksums
12fa35054d7b4d9f783f7858d19a5fbabf665c79d290eef1c32f5dd29dd90ea7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Release files / aqua_diagnostics-0.26.0-py3-none-any.whl

Download URL aqua_diagnostics-0.26.0-py3-none-any.whl
Size 800.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2d45bed6bd7409b7536c771526a33a2970129303ac9e273ab3e200e17cb74bac
BLAKE2b-256 checksum
How to use checksums
198d6cf86e2f286657ef4de0c6c35468b55b4625193ef8948edb0a4bef339e00
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Security for aqua-diagnostics 0.26.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for aqua_diagnostics-0.26.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page