AQUA-diagnostics
  • 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
  • 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
        • Example Plots
        • 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
    • 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 PDF or PNG 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
    • Boxplots
      • Boxplots.run()
    • ENSO
      • ENSO.compute_index()
      • ENSO.retrieve()
    • EnsembleLatLon
      • EnsembleLatLon.run()
    • EnsembleTimeseries
      • EnsembleTimeseries.run()
    • EnsembleZonal
      • EnsembleZonal.run()
    • GlobalBiases
      • GlobalBiases.compute_climatology()
      • GlobalBiases.retrieve()
      • GlobalBiases.savenetcdf()
    • GlobalMean
      • GlobalMean.exp
      • GlobalMean.year1
      • GlobalMean.year2
      • GlobalMean.config
      • GlobalMean.loglevel
      • GlobalMean.numproc
      • GlobalMean.interface
      • GlobalMean.model
      • GlobalMean.ensemble
      • GlobalMean.addnan
      • GlobalMean.silent
      • GlobalMean.trend
      • GlobalMean.line
      • GlobalMean.outputdir
      • GlobalMean.xdataset
      • GlobalMean.loggy
      • GlobalMean.diag
      • GlobalMean.face
      • GlobalMean.ref
      • GlobalMean.util_dictionary
      • GlobalMean.varmean
      • GlobalMean.vartrend
      • GlobalMean.funcname
      • GlobalMean.start_time
      • GlobalMean.title
      • GlobalMean.toc()
      • GlobalMean.prepare()
      • GlobalMean.run()
      • GlobalMean.store()
      • GlobalMean.plot()
      • GlobalMean.gm_worker()
      • GlobalMean.gm_worker()
      • GlobalMean.plot()
      • GlobalMean.prepare()
      • GlobalMean.run()
      • GlobalMean.store()
      • GlobalMean.toc()
    • Gregory
      • Gregory.compute_net_toa()
      • Gregory.compute_t2m()
      • Gregory.retrieve()
      • Gregory.run()
      • Gregory.save_netcdf()
    • Histogram
      • Histogram.compute_histogram()
      • Histogram.retrieve()
      • Histogram.run()
      • Histogram.save_netcdf()
    • Hovmoller
      • Hovmoller.logger
      • Hovmoller.outputdir
      • Hovmoller.region
      • Hovmoller.var
      • Hovmoller.stacked_data
      • Hovmoller.compute_hovmoller()
      • Hovmoller.run()
      • Hovmoller.save_netcdf()
      • Hovmoller.sort_key()
    • LatLonProfiles
      • LatLonProfiles.compute_dim_mean()
      • LatLonProfiles.compute_std()
      • LatLonProfiles.retrieve()
      • LatLonProfiles.run()
      • LatLonProfiles.save_netcdf()
    • MJO
      • MJO.compute_hovmoller()
      • MJO.retrieve()
    • NAO
      • NAO.compute_index()
      • NAO.retrieve()
    • PerformanceIndices
      • PerformanceIndices.exp
      • PerformanceIndices.year1
      • PerformanceIndices.year2
      • PerformanceIndices.config
      • PerformanceIndices.loglevel
      • PerformanceIndices.numproc
      • PerformanceIndices.climatology
      • PerformanceIndices.interface
      • PerformanceIndices.model
      • PerformanceIndices.ensemble
      • PerformanceIndices.silent
      • PerformanceIndices.xdataset
      • PerformanceIndices.outputdir
      • PerformanceIndices.loggy
      • PerformanceIndices.diag
      • PerformanceIndices.face
      • PerformanceIndices.piclim
      • PerformanceIndices.util_dictionary
      • PerformanceIndices.varstat
      • PerformanceIndices.funcname
      • PerformanceIndices.start_time
      • PerformanceIndices.title
      • PerformanceIndices.toc()
      • PerformanceIndices.prepare()
      • PerformanceIndices.run()
      • PerformanceIndices.store()
      • PerformanceIndices.plot()
      • PerformanceIndices.pi_worker()
      • PerformanceIndices.pi_worker()
      • PerformanceIndices.plot()
      • PerformanceIndices.prepare()
      • PerformanceIndices.run()
      • PerformanceIndices.store()
      • PerformanceIndices.toc()
    • Plot2DSeaIce
      • Plot2DSeaIce.plot_2d_seaice()
    • PlotBoxplots
      • PlotBoxplots.plot_boxplots()
    • PlotENSO
      • PlotENSO.plot_index()
      • PlotENSO.plot_maps()
      • PlotENSO.set_index_description()
      • PlotENSO.set_map_description()
    • 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()
    • PlotGlobalBiases
      • PlotGlobalBiases.plot_bias()
      • PlotGlobalBiases.plot_climatology()
      • PlotGlobalBiases.plot_seasonal_bias()
      • PlotGlobalBiases.plot_vertical_bias()
    • PlotGregory
      • PlotGregory.get_data_info()
      • PlotGregory.plot()
      • PlotGregory.plot_annual()
      • PlotGregory.plot_monthly()
      • PlotGregory.set_description()
      • PlotGregory.set_ref_label()
      • PlotGregory.set_title()
    • PlotHistogram
      • PlotHistogram.get_data_info()
      • PlotHistogram.plot()
      • PlotHistogram.run()
      • PlotHistogram.save_plot()
      • PlotHistogram.set_data_labels()
      • PlotHistogram.set_description()
      • PlotHistogram.set_ref_label()
      • PlotHistogram.set_title()
    • PlotHovmoller
      • PlotHovmoller.plot_hovmoller()
      • PlotHovmoller.plot_timeseries()
      • PlotHovmoller.save_plot()
      • PlotHovmoller.set_data_for_levels()
      • PlotHovmoller.set_data_type()
      • PlotHovmoller.set_description()
      • PlotHovmoller.set_levels()
      • PlotHovmoller.set_line_plot_colours()
      • PlotHovmoller.set_suptitle()
      • PlotHovmoller.set_texts()
      • PlotHovmoller.set_title()
      • PlotHovmoller.set_vmax_vmin()
    • PlotLatLonProfiles
      • PlotLatLonProfiles.get_data_info()
      • PlotLatLonProfiles.plot()
      • PlotLatLonProfiles.plot_seasonal_lines()
      • PlotLatLonProfiles.run()
      • PlotLatLonProfiles.save_plot()
      • PlotLatLonProfiles.set_data_labels()
      • PlotLatLonProfiles.set_description()
      • PlotLatLonProfiles.set_ref_label()
      • PlotLatLonProfiles.set_title()
    • PlotMJO
      • PlotMJO.plot_hovmoller()
      • PlotMJO.save_plot()
    • PlotMLD
      • PlotMLD.plot_mld()
      • PlotMLD.save_plot()
      • PlotMLD.set_cbar_labels()
      • PlotMLD.set_cbar_limits()
      • PlotMLD.set_central_longitude()
      • PlotMLD.set_convert_lon()
      • PlotMLD.set_data_map_list()
      • PlotMLD.set_description()
      • PlotMLD.set_figsize()
      • PlotMLD.set_nrowcol()
      • PlotMLD.set_suptitle()
      • PlotMLD.set_title()
      • PlotMLD.set_ytext()
    • PlotNAO
      • PlotNAO.plot_index()
      • PlotNAO.plot_maps()
      • PlotNAO.set_index_description()
      • PlotNAO.set_map_description()
    • PlotSeaIce
      • PlotSeaIce.plot_seaice()
      • PlotSeaIce.regions_type_plotter()
      • PlotSeaIce.repack_datasetlists()
      • PlotSeaIce.save_fig()
    • PlotSeasonalCycles
      • PlotSeasonalCycles.get_data_info()
      • PlotSeasonalCycles.plot_seasonalcycles()
      • PlotSeasonalCycles.run()
      • PlotSeasonalCycles.save_plot()
      • PlotSeasonalCycles.set_description()
      • PlotSeasonalCycles.set_title()
    • PlotStratification
      • PlotStratification.plot_stratification()
      • PlotStratification.save_plot()
      • PlotStratification.set_cbar_labels()
      • PlotStratification.set_cbar_limits()
      • PlotStratification.set_data_list()
      • PlotStratification.set_description()
      • PlotStratification.set_label_line_plot()
      • PlotStratification.set_nrowcol()
      • PlotStratification.set_suptitle()
      • PlotStratification.set_title()
      • PlotStratification.set_ytext()
    • PlotTimeseries
      • PlotTimeseries.get_data_info()
      • PlotTimeseries.plot_timeseries()
      • PlotTimeseries.run()
      • PlotTimeseries.save_plot()
      • PlotTimeseries.set_description()
      • PlotTimeseries.set_title()
    • PlotTrends
      • PlotTrends.plot_multilevel()
      • PlotTrends.plot_zonal()
      • PlotTrends.save_plot()
      • PlotTrends.set_cbar_labels()
      • PlotTrends.set_central_longitude()
      • PlotTrends.set_data_list()
      • PlotTrends.set_description()
      • PlotTrends.set_nrowcol()
      • PlotTrends.set_suptitle()
      • PlotTrends.set_title()
      • PlotTrends.set_ytext()
    • SeaIce
      • SeaIce.add_seaice_attrs()
      • SeaIce.compute_seaice()
      • SeaIce.get_area_cells_and_coords()
      • SeaIce.integrate_seaice()
      • SeaIce.load_regions()
      • SeaIce.save_netcdf()
      • SeaIce.select_region_area_cell()
    • SeasonalCycles
      • SeasonalCycles.compute()
      • SeasonalCycles.run()
    • StatGlobalBiases
      • StatGlobalBiases.compute_bias_statistics()
      • StatGlobalBiases.compute_significance_ttest()
      • StatGlobalBiases.compute_yearly_temporal_means()
      • StatGlobalBiases.ttest_at_grid_point()
    • Stratification
      • Stratification.calculate_rho()
      • Stratification.compute_climatology()
      • Stratification.compute_mld()
      • Stratification.compute_stratification()
      • Stratification.run()
      • Stratification.save_netcdf()
    • Timeseries
      • Timeseries.compute()
      • Timeseries.run()
    • Trends
      • Trends.adjust_trend_for_time_frequency()
      • Trends.compute_trend()
      • Trends.run()
      • Trends.save_netcdf()
      • Trends.select_region()
    • extract_realizations()
    • merge_from_data_files()
    • reader_retrieve_and_merge()
    • sshVariabilityCompute
      • sshVariabilityCompute.run()
    • sshVariabilityPlot
      • sshVariabilityPlot.plot()
      • sshVariabilityPlot.plot_diff()
      • sshVariabilityPlot.subregion_selection()
  • 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
AQUA-diagnostics
  • Troubleshooting and FAQ
  • View page source

Troubleshooting and FAQ

This section answers frequently asked questions and addresses common issues that users may encounter when working with AQUA.

  • 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?
Previous Next

© Copyright 2025, Climate DT Team.

Built with Sphinx using a theme provided by Read the Docs.