v3.0.0rc1

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.

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

Refactor and testing

• Merge cdat-migration-fy24 branch into main with the new Xarray/xCDAT backend by @tomvothecoder and @chengzhuzhang in #902
• Address diffs v2.12.1 to v3 by @tomvothecoder and @chengzhuzhang in #907

DevOps

• Make scipy a base dependency in ci.yml and dev.yml by @tomvothecoder in #905
• Replace data downloads from LCRC webserver to avoid throttling by using data containers by @mahf708 in #901

New Features

• Add support for more EAMxx variables by @chengzhuzhang and @tomvothecoder in #880

Bug Fixes

• Fix convert_units() not keeping attrs by @tomvothecoder and @chengzhuzhang in #916

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

v2.12.1 A Fond Farewell to CDAT

As we release version v2.12.1 of E3SM Diags, we would like to take a moment to acknowledge and express our gratitude to the developers and contributors from the CDAT (Climate Data Analysis Tools) community. Over the years, CDAT has been an invaluable tool for our development and analysis processes. This release marks a milestone, as it will be the final version of E3SM Diags that includes a dependency on CDAT.

Looking ahead, E3SM Diags will transition to utilizing xarray/xCDAT tools, which align with our future goals and enhances the performance and usability of our software. We are committed to ensuring a smooth transition for our users and will provide backward compatibility in upcoming releases.

User-facing changes

• add Qbo wavelet analysis by @justin-richling @whannah1 in #836
• add H2OLNZ in zonal mean 2d stratosphere by @chengzhuzhang in #868
• make --closedcontourcmd in TC detection resolution-specific by @chengzhuzhang in #824
• Fixing African easterly wave density plots in TC analysis by @chengzhuzhang in #851
• Convert H2OLNZ units to ppm by volume by @chengzhuzhang in #874
• add_TCO_60S60N to default lat-lon variables by @chengzhuzhang in #879

Other Update

• Updates for tutorial2024 by @chengzhuzhang in #811
• Update tutorial by @forsyth2 in #812
• Fix a variable name displayed in viewer by @chengzhuzhang in #820
• fix save_ncfiles for annual_cycle_zonal_mean by @chengzhuzhang in #822
• Update cfg files by @chengzhuzhang in #830
• Fix integration test download script by @tomvothecoder in #835
• Drop support for python 3.8 by @altheaden in #844
• Tweak behaviors of build and release CI workflows by @altheaden in #847
• Release 2.12.1 by @chengzhuzhang in #893

New Contributors

• @altheaden made their first contribution in #844
• @justin-richling made their first contribution in #836

Full Changelog: v2.12.0...v2.12.1

v2.12.0

New Feature

• Add Wheeler and Kiladis diagram for tropical subseasonal diags - Wheeler and Kiladis by @jjbenedict @brianpm @chengzhuzhang @tomvothecoder in #732

Updates and bug fixes

• Add intermediate output in json for ARM Diags by @yunpengshan2014 in #806
• Edit in-place modified derived variables for fixing aerosol budget table by @mahf708 in #805

Full Changelog: v2.11.0...v2.12.0

v2.12.0rc1

New Feature

• Add Wheeler and Kiladis diagram for tropical subseasonal diags - Wheeler and Kiladis by @jjbenedict @brianpm @chengzhuzhang @tomvothecoder in #732

Updates and bug fixes

• Add intermediate output in json for ARM Diags by @yunpengshan2014 in #806
• Edit in-place modified derived variables for fixing aerosol budget table by @mahf708 in #805

Full Changelog: v2.11.0...v2.12.0rc1

v2.11.0

What's Changed

New Features

• Initial support variable naming convention for EAMxx by @golaz in #712
• Support comparing monthly mean climatology (in addition to seasonal and annual mean) @chengzhuzhang in #712

Documentation Updates

• Update zppy cfg for perlmutter by @chengzhuzhang in #783
• Update inter-comparison of CMIP models workflow by @chengzhuzhang in #786

Bug fixes

• Fix cosp_histogram_driver.py not writing mean variables to netCDF by @tomvothecoder in #782

Others

• Bump/v2.11.0rc1 by @chengzhuzhang in #789

Full Changelog: v2.10.1...v2.11.0

v2.11.0rc1

What's Changed

New Features

• Initial support variable naming convention for EAMxx by @golaz in #712
• Support comparing monthly mean climatology (in addition to seasonal and annual mean) @chengzhuzhang in #712

Documentation Updates

• Update zppy cfg for perlmutter by @chengzhuzhang in #783
• Update inter-comparison of CMIP models workflow by @chengzhuzhang in #786

Bug fixes

• Fix cosp_histogram_driver.py not writing mean variables to netCDF by @tomvothecoder in #782

Others

• Bump/v2.11.0rc1 by @chengzhuzhang in #789

Full Changelog: v2.10.1...v2.11.0rc1

v2.10.1

What's Changed

Bug Fixes

• Fix type conditional check and UnboundLocalError for params_results by @tomvothecoder in #770
• Fix default diagnostics attrs not being copied to parent CoreParameter by @tomvothecoder in #778

Refactor

• [Refactor]: Refactor integration tests and add use_cfg flag to run_diags() by @tomvothecoder in #747
• Port over cdp_viewer.OutputViewer and remove cdp dependency by @tomvothecoder in #773

Full Changelog: v2.10.0...v2.10.1

v2.10.1rc1

What's Changed

• [Refactor]: Refactor integration tests and add use_cfg flag to run_diags() by @tomvothecoder in #747
• Fix type conditional check and UnboundLocalError for params_results by @tomvothecoder in #770

Full Changelog: v2.10.0...v2.10.1rc1

v2.10.0

What's Changed

Features

• Add more aerosol metrics by @mahf708 in #763

Bug Fixes

• Fix typo in zonal mean figure titles by @chengzhuzhang in #753

Refactor

• [Refactor]: Update e3sm_diags_driver.run_diags as CoreParameter method by @tomvothecoder in #742
• Replace parser.readfp() with parser.read_file() for Python 3.12 support by @tomvothecoder in #765

Documentation

• [Doc]: Add GitHub issues and pull request templates by @tomvothecoder in #741

DevOps

• Update DevOps configs by @tomvothecoder in #755

Full Changelog: v2.9.0...v2.10.0

v2.9.0

New Features

• Add new aci and aerosol activation metrics from ARM Diags v3 by @chengzhuzhang (collaborating with ARM infrastructure group with contribution from Xiaojian Zheng @lannyzxj, @EmmyChengTao and Shaocheng Xie. )in #679
• Mixed phase partition LCF diagram by @chengzhuzhang with @zyuying, @yunpengshan2014 and @Jiwengithub in #675
• Add aerosol global metrics benchmarks file developed by E3SM Aerosol Working Group @susburrows and @kaizhangpnl , and implemented by @chengzhuzhang and @mahf708 in #683
• Use total (interstitial and cloud-borne) aerosols directly from 2D burdens by @mahf708 in #682
• Add GPCP3.2 precipiation data and replace v2.2 by @chengzhuzhang in #690
• Add QREFHT and U10 comparison with ERA5 variables by @chengzhuzhang in #688
• Support relative difference plot in zonal mean 2d set by @chengzhuzhang in #651
• Additional variables to QBO json output files by @golaz in #646

CDAT Migration:

• CDAT Migration Phase 1: Replace cdp.cdp_run by @tomvothecoder in #641
• CDAT Migration Phase 1 - ReplaceCDPParameter by @tomvothecoder in #638
• CDAT Migration Phase 1 - Replace cdp_parser.CDPParser by @tomvothecoder in #650

Other Changes:

• Update Acknowledgement and Features Contribution in README by @chengzhuzhang in #692
• Bump dependencies in conda env yml files by @tomvothecoder in #644
• Increment CACHE_NUMBER to fix conda envs by @tomvothecoder in #645
• fix typo in aerosol budget printout by @mahf708 in #676
• Update quick guide for perlmutter; update diagnostics paths from mache by @chengzhuzhang in #691
• Fix numpy.int --> int by @xylar in #694
• Change workflow to mamba by @forsyth2 in #693
• Simplify the conda env yml files by @tomvothecoder in #696
• Fix release workflow not copying docs for latest tags by @tomvothecoder in #698
• Fix dir ref in release workflow by @tomvothecoder in #699
• Fix segfault issue with newest shapely and esmpy by @xylar in #715
• Import shapely but not esmpy in main package by @xylar in #722
• update enviroment variable by @chengzhuzhang in #725
• Add e3sm_diags import by @chengzhuzhang in #727

New Contributors

• @mahf708 made their first contribution in #676

Full Changelog: v2.8.0...v2.9.0