Add Var.integrate* functions #76

ph-kev · 2024-09-05T20:34:55Z

Closes #75 - This PR port the functionality of integrating OutputVar to ClimaAnalysis from ClimaCoupler. In particular, Var.integrate_lonlat, Var.integrate_lon, and Var.integrate_lat for integrating OutputVar with respect to longitude, latitude, or
both. Additionally, this commit adds a Numerics module to decouple the numerical implementation of integration and the construction of an OutputVar. The numerical implementation is rectangular integration using the midpoint rule when the points are equispaced which assume each point correspond to a midpoint of a cell and using the left endpoint rule when the points are not equispaced.

Lastly, update_long_name_average! is replaced by update_long_name_generic! so that the integrating functions can also use this function. Also, _reduce_over take in args and kwargs in squeeze.

src/Var.jl

NEWS.md

docs/src/howdoi.md

src/ClimaAnalysis.jl

src/Numerics.jl

Sbozzolo · 2024-09-05T20:46:00Z

src/Numerics.jl

+Return integration weights for rectangular integration using left endpoints for integrating
+along longitude.
+"""
+function _integration_weights_lon_left(lon::AbstractVector)


You probably don't need to specify the type in lon here

src/Numerics.jl

Sbozzolo · 2024-09-05T20:50:42Z

src/Var.jl

+    angle_dim_unit in deg_unit_names ||
+        lowercase(angle_dim_unit) |> (x -> occursin("deg", x)) ||
+        error("The unit for $angle_dim_name is missing or is not degree")


Can you just substitute this with

lowercase(angle_dim_unit) in deg_unit_names

?

test/runtests.jl

The function `_reduce_over` has `args` and `kwargs` as inputs, but never use them. This commit changes `_reduce_over` so that `args` and `kwargs` are passed to `squeeze` in `_reduce_over`.

The commit removes `update_long_name_average!` and replace it with `update_long_name_generic!` so that it can be used by any other functions that do some kind of reduction on data.

This commit adds Var.integrate_lonlat, Var.integrate_lon, and Var.integrate_lat for integrating `OutputVar` with respect to longitude, latitude, or both. Additionally, this commit adds a Numerics module to decouple the numerical implementation of integration and the construction of an OutputVar. The numerical implementation is rectangular integration using the midpoint rule when the points are equispaced which assume each point correspond to a midpoint of a cell and using the left endpoint rule when the points are not equispaced.

codecov · 2024-09-06T00:50:23Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.37%. Comparing base (f761cfd) to head (c125e84).
Report is 5 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main      #76       +/-   ##
===========================================
+ Coverage   16.84%   96.37%   +79.52%     
===========================================
  Files           9       10        +1     
  Lines         558      607       +49     
===========================================
+ Hits           94      585      +491     
+ Misses        464       22      -442

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sbozzolo

Awesome! Thank you!

Sbozzolo self-requested a review September 5, 2024 20:37