PMP double ITCZ metric

[lee1043]

Description

Checklist

Please confirm that this pull request has done the following:

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

[lee1043]

Hi @minxu74, would you be able to help running the workflow for this PR? I am adding some more metrics but struggling to set up REF workflow on my end with the latest version of the source code -- I might have missed something. While I work on it, if you could help confirming this change produces output that is expected, that would be a huge help!

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag	Coverage Δ
core	93.15% <ø> (ø)
providers	89.93% <100.00%> (+<0.01%)	⬆️

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

Files with missing lines	Coverage Δ
...mp/src/climate_ref_pmp/diagnostics/annual_cycle.py	63.90% <ø> (ø)
..._ref_pmp/params/pmp_param_annualcycle_2-metrics.py	100.00% <100.00%> (ø)

🚀 New features to boost your workflow:

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

[lewisjared]

Add an entry in AnnualCycle.test_data_spec with data you need to test and then run:

uv run ref test-cases run --provider pmp --fetch --diagnostic annual-cycle --test-case {{name_of_test_case}}

That will also fetch the data required for the test case.

Output will go to packages/climate-ref-pmp/tests/test-data/annual-cycle/{{name_of_test_case}}

It would be super useful if you were able to run the test cases because they should be able to run everywhere

https://climate-ref.readthedocs.io/en/latest/how-to-guides/testing-diagnostics/

[minxu74]

@lee1043 can you run the test now? I could try it on NERSC today. Thanks.

[minxu74]

@lee1043 I ran the two tests of the annual cycle and both them passed and generated results.

[lewisjared]

I've also added a new test-case which for precip data.

This can be run via:

uv run ref test-cases run --fetch --force-regen --clean --provider pmp --diagnostic annual-cycle --test-case cmip6-pr

I see some images like this. Did you expect any other outputs?

Full regression output:
pmp_annual-cycle_cmip6-pr.zip

[lewisjared]

Just needs a changelog and approval of the results

[lee1043]

Hi @lewisjared thanks for sharing the image file which looks consistent to my expectation. Do you happen to have DJF image as well just for checking? The suggested Double ITCZ metrics is DJF pr pattern correlation over the box area.

[lewisjared]

Its in the zip above

[lee1043]

A minor fix (rename "Double_ITCZ" to "doubleITCZ" for consistent naming template for output files) and the change log added. Thank you @minxu74 for running the code and thank you @lewisjared for adding the test!

[lewisjared]

Can you run make virtual-environment locally to install pre-commit. That way your commits will always pass the pre-commit checks as it fixes any formatting during the commit