Adding roll function for patches

Nik-P2 commented 3 months ago

Description

Adding in roll function for patches based on numpy roll function an example of this function

import dascore as dc
patch = dc.get_example_patch()
# roll time dimension 5 elements
rolled_patch = patch.roll(time=5, samples=True)

Checklist

I have (if applicable):

[x] referenced the GitHub issue this PR closes.
[x] documented the new feature with docstrings or appropriate doc page.
[x] included a test. See testing guidelines.
[x] your name has been added to the contributors page (docs/contributors.md).
[x] added the "ready_for_review" tag once the PR is ready to be reviewed.

codecov[bot] commented 3 months ago

Codecov Report

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

Project coverage is 99.54%. Comparing base (c2f6ca7) to head (82e143c).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #382 +/- ## ======================================= Coverage 99.54% 99.54% ======================================= Files 97 97 Lines 7633 7647 +14 ======================================= + Hits 7598 7612 +14 Misses 35 35 ``` | [Flag](https://app.codecov.io/gh/DASDAE/dascore/pull/382/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DASDAE) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/DASDAE/dascore/pull/382/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DASDAE) | `99.54% <100.00%> (+<0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DASDAE#carryforward-flags-in-the-pull-request-comment) to find out more.

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

d-chambers commented 3 months ago

Hey @Nik-P2, If you look at the CI that failed (by clicking on the details button above) I see this error message when running the docstests. I think I told you wrong above, the dimensional coordinates are always 1D, so you might try replacing this line:

np.roll(coord.values, value, axis=axis)

with this one:

np.roll(coord.values, value, axis=0)

and see if it works.

d-chambers commented 3 months ago

All green, feel free to press the squash and merge button.

DASDAE / dascore