lochhh commented 3 months ago

Description

What is this PR

[ ] Bug fix
[ ] Addition of a new feature
[x] Other

Why is this PR needed? Closes #268

What does this PR do? This PR incorporates suggestions from #265

renames _compute_approximate_derivative → _compute_approximate_time_derivative for added clarity (commit from #265)
uses the more efficient xr.DataArray.differentiate instead of the combination of np.gradient with xr.apply_ufunc and xr.DataArray.reindex.
removes the equidistant time-spacing assumption
updates the kinematics docstrings (e.g. to point to xr.DataArray.differentiate doc in public functions)

References

268 #265

How has this PR been tested?

Tests run locally and in CI

Does this PR require an update to the documentation?

Docstrings are updated accordingly

Checklist:

[x] The code has been tested locally
[ ] Tests have been added to cover all new functionality
[x] The documentation has been updated to reflect any changes
[x] The code has been formatted with pre-commit

codecov[bot] commented 3 months ago

Codecov Report

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

Project coverage is 99.76%. Comparing base (e7ccfe5) to head (8c19a78).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #270 +/- ## ========================================== - Coverage 99.76% 99.76% -0.01% ========================================== Files 14 14 Lines 866 863 -3 ========================================== - Hits 864 861 -3 Misses 2 2 ```

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

lochhh commented 3 months ago

@sfmig I'm requesting your review because changes here are/stem from #265