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:
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).
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aqua_diagnostics-0.25.0.tar.gz.
File metadata
- Download URL: aqua_diagnostics-0.25.0.tar.gz
- Upload date:
- Size: 654.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
45344efec97c6f76f15a33257a92da9b6b7be853206c835b0ec1d65a9ba6d7e4
|
|
| MD5 |
7c8c6ec0a7f274f30633dd2f13988c79
|
|
| BLAKE2b-256 |
47f10a3bbcfe23e5880f11e9a6bb9ad528f4edeb95b997910b3e92eb10181e84
|
Provenance
The following attestation bundles were made for aqua_diagnostics-0.25.0.tar.gz:
Publisher:
pypi-publish.yml on DestinE-Climate-DT/AQUA-diagnostics
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aqua_diagnostics-0.25.0.tar.gz -
Subject digest:
45344efec97c6f76f15a33257a92da9b6b7be853206c835b0ec1d65a9ba6d7e4 - Sigstore transparency entry: 2617616811
- Sigstore integration time:
-
Permalink:
DestinE-Climate-DT/AQUA-diagnostics@04afe36798918881c501f8bd9539abfa39b6772e -
Branch / Tag:
refs/heads/main - Owner: https://github.com/DestinE-Climate-DT
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi-publish.yml@04afe36798918881c501f8bd9539abfa39b6772e -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file aqua_diagnostics-0.25.0-py3-none-any.whl.
File metadata
- Download URL: aqua_diagnostics-0.25.0-py3-none-any.whl
- Upload date:
- Size: 758.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bab2b76959fbf810129efda420a504c48ef82368c30a1e9cce3f905e9b458000
|
|
| MD5 |
0339f5af187b5b9c3392df03db19e9be
|
|
| BLAKE2b-256 |
b9efe24868878f8d6accb59c902abe77ded847831296d411c315fd812ae34e4a
|
Provenance
The following attestation bundles were made for aqua_diagnostics-0.25.0-py3-none-any.whl:
Publisher:
pypi-publish.yml on DestinE-Climate-DT/AQUA-diagnostics
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aqua_diagnostics-0.25.0-py3-none-any.whl -
Subject digest:
bab2b76959fbf810129efda420a504c48ef82368c30a1e9cce3f905e9b458000 - Sigstore transparency entry: 2617616819
- Sigstore integration time:
-
Permalink:
DestinE-Climate-DT/AQUA-diagnostics@04afe36798918881c501f8bd9539abfa39b6772e -
Branch / Tag:
refs/heads/main - Owner: https://github.com/DestinE-Climate-DT
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi-publish.yml@04afe36798918881c501f8bd9539abfa39b6772e -
Trigger Event:
workflow_dispatch
-
Statement type:
