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.
- Python
>=3.10,<3.13 - A working installation of AQUA-core
- A conda/mamba environment using packages from
conda-forge
Follow the installation instructions in the AQUA-core repository:
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-phase1Note: The AQUA-core is installed via pypi dependency. AQUA-core can also be installed in an editable mode.
Diagnostics can also be executed inside the AQUA container. Refer to the Container chapter in the AQUA documentation for details.
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
Notebooks and usage examples are available in the notebooks/ directory.
Contributions are welcome! Please refer to the Contribution Guidelines in this repository.
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).