Coordinate documentation

d-chambers commented 8 months ago

Description

This PR implements some improvements to the coordinate and coordinate manager interface and documentation. Specifically it:

Adds a new page to the tutorial on working with coordinates.
minor backwards compatible changes to the coordinate API to be more consistent with the Patch and Spool APIs.
Improves recipe organization.
Added several tests and fix some small bugs related to coordinate methods.

Checklist

I have (if applicable):

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

codecov[bot] commented 8 months ago

Codecov Report

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

Comparison is base (bde3da3) 99.50% compared to head (8b7dd0d) 99.51%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #327 +/- ## ======================================= Coverage 99.50% 99.51% ======================================= Files 92 92 Lines 7134 7149 +15 ======================================= + Hits 7099 7114 +15 Misses 35 35 ``` | [Flag](https://app.codecov.io/gh/DASDAE/dascore/pull/327/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/327/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=DASDAE) | `99.51% <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 8 months ago

Merging for now so docs build, we can refine when we do our final read-through of the docs before submitting the DASCore paper.

DASDAE / dascore