[PR]: Add Z axis support for spatial averaging

xCDAT / xcdat

An extension of xarray for climate data analysis on structured grids.

https://xcdat.readthedocs.io/en/latest/

Apache License 2.0

101 stars 11 forks source link

[PR]: Add Z axis support for spatial averaging #606

Open pochedls opened 4 months ago

pochedls commented 4 months ago

Description

This PR adds functionality to compute vertical averages.

Closes #596

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] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass with my changes (locally and CI/CD build)
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] 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)

pochedls commented 4 months ago

I'd appreciate testing with real-world data (and comparisons with CDAT).

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (5de4d7f) to head (98ea3d7).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #606 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 15 15 Lines 1588 1595 +7 ========================================= + Hits 1588 1595 +7 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

tomvothecoder commented 4 months ago

Tom:

[ ] Compare with cdms2 average with Z axis and get floating point diffs
[ ] Try out in e3sm_diags

tomvothecoder commented 3 months ago

I'm going to pick this back up for review. We might be able to get this in for v0.7.0.

tomvothecoder commented 3 months ago

I'd appreciate testing with real-world data (and comparisons with CDAT).

Can you provide me some datasets to test with? I wrote a script and tested a single E3SM dataset, which produced nearly identical results (1e-16 max rel diff).

pochedls commented 3 months ago

I'd appreciate testing with real-world data (and comparisons with CDAT).

Can you provide me some datasets to test with? I wrote a script and tested a single E3SM dataset, which produced nearly identical results (1e-16 max rel diff).

Do you have xsearch running? I think you could look for monthly, historical data, for the thetao or ta (Amon table) variables.

tomvothecoder commented 3 months ago

I'd appreciate testing with real-world data (and comparisons with CDAT).

Can you provide me some datasets to test with? I wrote a script and tested a single E3SM dataset, which produced nearly identical results (1e-16 max rel diff).

Do you have xsearch running? I think you could look for monthly, historical data, for the thetao or ta (Amon table) variables.

I'll check on xsearch. Thanks for the pointers.