Welcome to AQUA-diagnostics’ documentation!

• Introduction
  • Overview
  • Purpose
  • The Diagnostics:
  • Design Principles:
  • Running Diagnostics
  • Contributing
• Installation
  • Conda/Mamba installation with pip
    • Prerequisites
    • Installation with Miniforge
    • Extra dependencies
  • Conda/Mamba installation with environment file
    • Installation with Miniforge
  • HPC Installation
    • Installation on LUMI HPC
      • What load_aqua_diagnostics.sh does
      • Why sourcing is required
      • Switching between AQUA environments
    • Installation on Levante HPC at DKRZ
    • Installation on MareNostrum 5 (MN5) HPC at BSC
    • Installation on ECMWF HPC2020
  • Installation and use of the AQUA container
• Getting Started
• Container
• AQUA analysis wrapper
  • Basic usage
  • Additional options
  • Configuration file
    • Job
    • Cluster
    • Diagnostics
• State of the art diagnostics
  • List of diagnostics
    • Boxplots Diagnostic
      • Description
      • Classes
      • File structure
      • Input variables and datasets
      • Basic usage
      • CLI usage
      • Configuration file structure
      • Output
      • Observations
      • Example plots
      • Available demo notebooks
      • Authors and contributors
      • Detailed API
    • Global Biases Diagnostic
      • Description
      • Classes
      • File structure
      • Input variables and datasets
      • Basic usage
      • CLI usage
      • Configuration file structure
      • Output
      • Observations
      • Example Plots
      • Available demo notebooks
      • Authors and contributors
      • Detailed API
    • ECmean4 Performance Metrics
      • Description
      • Classes
      • File structure
      • Input variables and datasets
      • Basic usage
      • CLI usage
      • Configuration file structure
      • Output
      • Reference datasets
      • Example Plot(s)
      • Available demo notebooks
      • Authors and contributors
      • Detailed API
    • Timeseries Diagnostic
      • Description
      • Classes
      • File structure
      • Input variables and datasets
      • Basic usage
      • CLI usage
      • Configuration file structure
      • Output
      • Observations
      • Example Plots
      • Available demo notebooks
      • Authors and contributors
      • Detailed API
    • Ocean Stratification Diagnostic
      • Description
      • Classes
      • File structure
      • Input variables and datasets
      • Basic usage
      • CLI usage
      • Configuration file structure
      • Output
      • Observations
      • References
      • Example Plots
      • Available demo notebooks
      • Authors and contributors
      • Detailed API
    • Ocean Trends Diagnostic
      • Description
      • Classes
      • File structure
      • Input variables and datasets
      • Basic usage
      • CLI usage
      • Configuration file structure
      • Output
      • Example Plots
      • Available demo notebooks
      • Authors and contributors
      • Detailed API
    • Ocean Drift Diagnostic
      • Description
      • Classes
      • File structure
      • Input variables and datasets
      • Basic usage
      • CLI usage
      • Configuration file structure
      • Output
      • Example Plots
      • Available demo notebooks
      • Authors and contributors
      • Detailed API
    • Sea Ice Diagnostic
      • Description
      • Classes
      • File structure
      • Input variables and datasets
      • Basic usage
      • CLI usage
      • Configuration file structure
      • Output
      • Observations
      • Example Plots
      • Available demo notebooks
      • References
      • Authors and contributors
      • Detailed API
    • Teleconnections Diagnostic
      • Description
      • Classes
      • File structure
      • Input variables and datasets
      • Basic usage
      • CLI usage
      • Configuration file structure
      • Output
      • Observations
      • Example Plots
      • Available demo notebooks
      • Authors and contributors
      • Detailed API
    • LatLonProfiles Diagnostic
      • Description
      • Classes
      • File structure
      • Input variables and datasets
      • Basic usage
      • CLI usage
      • Configuration file structure
      • Output
      • Observations
      • Example plots
      • Available demo notebooks
      • Authors and contributors
      • Detailed API
    • Histogram Diagnostic
      • Description
      • Classes
      • File structure
      • Input variables and datasets
      • Basic usage
      • CLI usage
      • Configuration file structure
      • Output
      • Observations
      • Available demo notebooks
      • Authors and contributors
      • Detailed API
  • Diagnostics configuration files
  • Diagnostics CLI arguments
  • Running the monitoring diagnostics
    • Minimum Data Requirements
• Frontier diagnostics
  • SSH variability
    • Description
    • Classes
    • File Structure
    • Input variables and datasets
    • Basic Usage
    • Example usage
    • CLI usage
    • Config file structure
    • Output
    • Observations
    • References
    • Example Plot(s)
    • Available demo notebooks
    • Authors and contributors
    • Detailed API
      • SshVariabilityCompute
      • SshVariabilityPlot
  • Tropical Cyclones detection, tracking and zoom in diagnostic
    • Description
    • Structure
    • Input variables
    • Output
    • Methods used
    • Functions used
    • Observations
    • References
    • Example Plot(s)
    • Available demo notebooks
    • Detailed API
  • Tropical rainfall diagnostic
    • Description
    • Structure
    • Input variables
    • Output
    • Examples
      • The histogram calculation
      • List of histograms
      • The histogram plots
      • Seasonal Mean Values
      • Bias between model and observations
    • Available demo notebooks
    • Detailed API
• Ensemble diagnostics
  • Ensemble Time series diagnostic
    • Description
    • Classes
    • File structure
    • Input variables and datasets
    • Basic usage
    • CLI usage
    • Configuration file structure
    • Output
    • Observations
    • Example Plots
    • Available demo notebooks
    • Authors and contributors
    • Detailed API
  • Ensemble LatLon diagnostic
    • Description
    • Classes
    • File structure
    • Input variables and datasets
    • Basic usage
    • CLI usage
    • Configuration file structure
    • Output
    • Example Plots
    • Available demo notebooks
    • Authors and contributors
    • Detailed API
  • Ensemble Zonal diagnostic
    • Description
    • Classes
    • File structure
    • Input variables and datasets
    • Basic usage
    • CLI usage
    • Output
    • Configuration file structure
    • Output
    • Example Plots
    • Available demo notebooks
    • Authors and contributors
    • Detailed API
• Detailed API
  • EnsembleLatLon
    • EnsembleLatLon.run()
  • EnsembleTimeseries
    • EnsembleTimeseries.run()
  • EnsembleZonal
    • EnsembleZonal.run()
  • PlotEnsembleLatLon
    • PlotEnsembleLatLon.figure
    • PlotEnsembleLatLon.diagnostic_product
    • PlotEnsembleLatLon.catalog_list
    • PlotEnsembleLatLon.model_list
    • PlotEnsembleLatLon.exp_list
    • PlotEnsembleLatLon.source_list
    • PlotEnsembleLatLon.region
    • PlotEnsembleLatLon.outputdir
    • PlotEnsembleLatLon.loglevel
    • PlotEnsembleLatLon.plot()
  • PlotEnsembleTimeseries
    • PlotEnsembleTimeseries.plot()
  • PlotEnsembleZonal
    • PlotEnsembleZonal.diagnostic_product
    • PlotEnsembleZonal.catalog_list
    • PlotEnsembleZonal.model_list
    • PlotEnsembleZonal.exp_list
    • PlotEnsembleZonal.source_list
    • PlotEnsembleZonal.region
    • PlotEnsembleZonal.outputdir
    • PlotEnsembleZonal.loglevel
    • PlotEnsembleZonal.plot()
  • extract_realizations()
  • merge_from_data_files()
  • reader_retrieve_and_merge()
• Creating Custom Diagnostics
  • Core Diagnostic: Diagnostic
  • Diagnostic Classes
  • Comparison and Plot Classes
  • Command-Line Interface (CLI)
  • Configuration file
  • Configuration Files and AQUA console
  • Automatic Standardized File Naming
    • Class Overview
    • Attributes
    • Example Usage
      • Initializing the OutputSaver Class
      • Generating a Filename
      • Generating a Filename with Extra Keys
      • Saving a NetCDF File with Metadata
      • Saving a Plot with Metadata
      • Opening a PDF File and Displaying Metadata
      • Generating a Filename for Multimodel or Multireference Comparisons
      • Creating a catalog entry
  • Core Functions
• Command Line Interface tools
• API Reference
• Troubleshooting and FAQ
  • I am getting an error when trying to install AQUA on LUMI
    • Resource is busy
    • Pip dependency resolution
    • Permission denied
    • Intel compatibility build error
  • I am getting an error MissingGridDefinitionPathError
  • I am getting TypeError: ‘GeometryCollection’ object is not subscriptable when using plot_single_map function
  • How do I cite AQUA in my research or publications?
• Contributing to AQUA-diagnostics
  • Reporting Bugs
  • Suggesting Features
  • Contributing Code
  • Documentation and Tutorials
  • Testing
    • Running Tests Locally
    • Running Tests in Parallel
    • Writing Tests
• References and Acknowledgments
  • Citing AQUA-diagnostics
  • Acknowledgments