Release 2.12.1

[chengzhuzhang]

Description

Prepare for releasing 2.12.1 before migrating to the new code base using xarray/xcdat

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• My changes generate no new warnings
• Any dependent changes have been merged and published in downstream modules

If applicable:

• New and existing unit tests pass with my changes (locally and CI/CD build)
• I have added tests that prove my fix is effective or that my feature works
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have noted that this is a breaking change for a major release (fix or feature that would cause existing functionality to not work as expected)

[tomvothecoder]

My Initial code review

[tomvothecoder]

Use this notebook for regression testing and modify as needed (e.g., update paths, remove function that removes .nc files for comparison, etc.)

https://github.com/E3SM-Project/e3sm_diags/blob/cdat-migration-fy24/auxiliary_tools/cdat_regression_testing/843-migration-phase3/run-script-model-vs-obs/model_vs_obs_netcdf.ipynb

[chengzhuzhang]

@tomvothecoder thank you for sharing the regression notebook. Unfortunately, the save_netcdf flag didn't turn on for both the baseline and new run. So I'm not able to use the notebook. Instead I ran the metrics_checker.py and image_checker.py. Both runs are consistent, the diff is expected:

1. File missing in second directory: lat_lon/OMI-MLS/OMI-MLS-TCO-ANN-60S60N.png (#879)
2. Images do not match: qbo/QBO-ERA-Interim/qbo_diags.png (#836)

pressure-latitude(stratosphere) and tropical cyclone analysis are not included in the tests, they were tested individually before merging the PR.

[tomvothecoder]

LGTM! Thanks Jill!

[chengzhuzhang]

@tomvothecoder Thank you for the review!
As a reference, the complete run is available here:
https://portal.nersc.gov/cfs/e3sm/chengzhu/complete_run/v2.12.1/e3sm_diags_extended/viewer/

The annual cycle zonal mean set is not included, only ANN is included in the run script.

[tomvothecoder]

Nice, thanks for the release @chengzhuzhang. Looks like we can merge cdat-migration-fy24 to main soon 😀

[chengzhuzhang]

Nice, thanks for the release @chengzhuzhang. Looks like we can merge cdat-migration-fy24 to main soon 😀

YEAHHH!