v3.0.0

[tomvothecoder]

What's Changed

v3.0.0 marks a major milestone after nearly two years of work by the core development team. This release introduces a completely new back-end, replacing CDAT with Xarray and xCDAT. Due to the significant scale of code changes, this has been incremented as a major release. The user-facing API for running E3SM Diagnostics remains backward-compatible between v2 and v3.

The modernization improves performance, usability, and maintainability, paving the way for future enhancements to E3SM development. The refactored codebase is now more robust and extensively covered by unit tests, setting a solid foundation for ongoing testing and development.

This release also includes several new enhancements including support for more EAMxx variables, standardization of regridding with xESMF's conservative_normed method, and improving diagnostic run performance by skipping unnecessary regridding of datasets with the same lat-lon grid.

We are excited to share this release with the E3SM community and remain committed to continuously improving the software!

Enhancements

• Add support for more EAMxx variables by @chengzhuzhang, @tomvothecoder, and @czender in EAMxx variables #880
• Standardize regridding to conservative_normed by @tomvothecoder and @chengzhuzhang in Standardize regridding to conservative_normed #940
• Improve diagnostic run performance by skipping regridding for two datasets on same lat-lon grids by @chengzhuzhang in Skip regriding for two datasets on same lat-lon grids #959
• Revamp logging to improve readability and output E3SM diagnostic configuration, prevent duplicate log messages, and save complete console output to log file in prov directory by @tomvothecoder in Revamp logger module for additional features and bug fixes #924
• Make viewer accessible at the top-level of results directory by @tomvothecoder in Add viewer index.html to top level of results directory #927

Bug Fixes

• Fix prov files not printing with links in prov index.html by @tomvothecoder in Fix prov files not printing with links in prov index.html #937

Refactor and testing

• Merge v3.0.0 development branch (cdat-migration-fy24) into main with the new Xarray/xCDAT backend by @tomvothecoder, @chengzhuzhang, @forsyth2, and @xylar in Merge cdat-migration-fy24 branch into main #902

DevOps

• Replace deprecated SciPy cwt with PyWavelets cwt by @tomvothecoder, @chengzhuzhang, and @whannah1 in Replace deprecated SciPy cwt with PyWavelets cwt #913
• Make scipy a base dependency in ci.yml and dev.yml by @tomvothecoder in Make scipy a base dependency in ci.yml and dev.yml #905
• Constrain dask !=2024.12.0,!=2024.12.1 for performance by @tomvothecoder in Constrain dask !=2024.12.0,!=2024.12.1 for performance #926
• Replace data downloads from LCRC webserver to avoid throttling by using data containers by @mahf708 in avoid downloading data #901
• Adopt ruff as the central tool for linting and formatting by @tomvothecoder in Adopt ruff as the central tool for linting and formatting #920

Full Changelog: v2.12.1...v3.0.0

---

This discussion was created from the release v3.0.0.