ESMValTool ozone diagnostics

[axel-lauer]

Description

ESMValTool ozone diagnostics. This includes the following five subdiagnostics:

• ozone-lat-time: zonal mean total column ozone (time vs. latitude)
• ozone-sh-oct: time series of total column ozone in October averaged over SH polar latitudes (60S-85S)
• ozone-nh-mar: time series of total column ozone in March averaged over NH polar latitudes (60N-80N)
• ozone-zonal: zonal mean profiles of stratospheric ozone (latitude vs. air pressure)
• ozone-annual-cycle: annual cycle of zonal mean total column ozone (month vs. latitude)

As reference data, obs4MIPs C3S-GTO-ECV-9-0 total column ozone and ESACCI-OZONE (SAGE-OMPS) ozone are used. ESACCI-OZONE data are not part of obs4MIPs or obs4REF yet.

This is as far as I can get. I am not able to add tests, etc. For this I need assistance from more experienced REF contributors.

Checklist

Please confirm that this pull request has done the following:

• Tests added
• Documentation added (where applicable)
• Changelog item added to changelog/

[bouweandela]

• Once we have the sample data in place, regression test output can be generated with a command like pytest --slow --force-regen -k ozone-lat-time as described here: https://climate-ref.readthedocs.io/en/latest/development/#tests-and-code-quality. Regression tests themselves can then be run by leaving out the --force-regen parameter. No additional code for testing is needed. If you already have the sample data generated locally from Add cmip6 and obs4mips data for ESMValTool ozone diagnostic  ref-sample-data#58, you could already run the tests locally to make sure things work. I usually replace this line

  climate-ref/conftest.py

  Line 103 in 01eabb5

  return test_data_dir / "sample-data"

  so it returns the path to my local copy of the sample data when I want to do this. I also discussed making this easier in the future with @lewisjared, resulting in Reworking sample data #472, but I'm not sure when that will be implemented.
• Could you please run pre-commit install and pre-commit run -a to fix the formatting issue?
• Could you please add a changelog? Similar to 2dd39d8 but replace the number in the filename by the number of this pull request.

[lewisjared]

@axel-lauer After quite some delay and rework, I've come back to the ozone diagnostic. We've reworked how we defined the test data requirements so as a diagnostic developer you no-longer need deal with the sample data repo.

Can you please review the attached output to see if the output is as you expect.

You should be able to run this via:

uv run ref test-cases run --fetch --force-regen --clean --provider esmvaltool --diagnostic ozone-annual-cycle

You may need to set the following in your ~/.config/intake-esgf/conf.yaml. I have no idea why obs4MIPs datasets are so poorly indexed...

solr_indices:
  esgf.ceda.ac.uk: true

ozone-test-data-cmip6.tar.gz

[lewisjared]

@bouweandela The parquet catalog for obs4mips doesn't have the obs dataset hence all of the empty regression outputs...

[codecov]

Codecov Report

❌ Patch coverage is 91.75258% with 8 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
...ol/src/climate_ref_esmvaltool/diagnostics/ozone.py	91.57%	8 Missing ⚠️

Flag	Coverage Δ
core	93.11% <100.00%> (ø)
providers	91.79% <91.66%> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...ate-ref-core/src/climate_ref_core/esgf/obs4mips.py	88.46% <100.00%> (ø)
...src/climate_ref_esmvaltool/diagnostics/__init__.py	100.00% <100.00%> (ø)
...ol/src/climate_ref_esmvaltool/diagnostics/ozone.py	91.57% <91.57%> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[lewisjared]

Merging this as I'd like to get this into a release. Thanks for the recipe!