CDAT Migration Phase 2: Refactor utilities and CoreParameter methods for reusability across diagnostic sets - Githubissues

E3SM-Project / e3sm_diags

E3SM Diagnostics package

https://e3sm-project.github.io/e3sm_diags

BSD 3-Clause "New" or "Revised" License

39 stars 32 forks source link

CDAT Migration Phase 2: Refactor utilities and CoreParameter methods for reusability across diagnostic sets #746

Closed tomvothecoder closed 10 months ago

tomvothecoder commented 10 months ago

Description

This PR refactors code that was originally implemented in PR #658 to be reusable across other diagnostic sets.

Additional Changes:

Move driver type annotations to type_annotations.py
Move lat_lon_driver._save_data_metrics_and_plots() to io.py
Update _save_data_metrics_and_plots args to accept plot_func callable
Update metrics.spatial_avg to return an optionally xr.DataArray with as_list=False
Move parameter arg to the top in lat_lon_plot.plot
Move _set_param_output_attrs and _set_name_yr_attrs from lat_lon_driver to CoreParameter class

Checklist

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

If applicable:

[x] New and existing unit tests pass with my changes (locally and CI/CD build)
[x] I have added tests that prove my fix is effective or that my feature works
[x] 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)