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.11,<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).

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aqua_diagnostics-0.24.0.tar.gz (652.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aqua_diagnostics-0.24.0-py3-none-any.whl (756.0 kB view details)

Uploaded Python 3

File details

Details for the file aqua_diagnostics-0.24.0.tar.gz.

File metadata

  • Download URL: aqua_diagnostics-0.24.0.tar.gz
  • Upload date:
  • Size: 652.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for aqua_diagnostics-0.24.0.tar.gz
Algorithm Hash digest
SHA256 f16bda1458184bba9505e28ef9b207537da826ee58bcf63086e34b90cd4d55af
MD5 be468af0a57718ec3389c15979571dd6
BLAKE2b-256 a6c0ebd05c427a520faf56e7b7bcc384eff64c0b2fdd3071f8d8d65006d90a03

See more details on using hashes here.

Provenance

The following attestation bundles were made for aqua_diagnostics-0.24.0.tar.gz:

Publisher: pypi-publish.yml on DestinE-Climate-DT/AQUA-diagnostics

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aqua_diagnostics-0.24.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aqua_diagnostics-0.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e63a7574949645e82b0a543fea757a9a6b12c4f903dd00f98c9379ee5a4d031c
MD5 3fb8a6e1451db80e0312b71c76a2e31b
BLAKE2b-256 99960fb676bd8016b136d989166ed133f0e16ddc3241a5afd63f0c1cb9112eeb

See more details on using hashes here.

Provenance

The following attestation bundles were made for aqua_diagnostics-0.24.0-py3-none-any.whl:

Publisher: pypi-publish.yml on DestinE-Climate-DT/AQUA-diagnostics

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.25.1

2 files

0.25.0

2 files

This release

0.24.0 This release

2 files

0.23.0

2 files

0.22.0

2 files

0.21.0

2 files

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