Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom index tutorial #295

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

e-marshall
Copy link
Contributor

This PR would add a notebook demonstrating how to build a custom index to the tutorial. It is loosely based on the how to create a custom index page (which was very helpful in writing this) but is aimed to be a bit more explanatory.
it has the following structure:

  • a bit of background and introduce the motivation for using custom indexes
  • build a custom index for a simplified case of a 1d dataset where we'd like an index to handle a coordinate transform
    Steps to build index:
  • build skeleton index with just from_variables()
  • add create_variables(), sel() and transform
  • add equals(), join() and reindex_like() to support alignment

If folks think this would be a worthwhile addition to the tutorial, I'd love to keep working on this and to incorporate any feedback and suggestions

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@e-marshall e-marshall changed the title Custom index Custom index tutorial Aug 19, 2024
Copy link

github-actions bot commented Aug 19, 2024

🎊 PR Preview 131d715 has been successfully built and deployed to https://xarray-contrib-xarray-tutorial-preview-pr-295.surge.sh

🕐 Build time: 0.013s

🤖 By surge-preview

@scottyhq
Copy link
Contributor

If folks think this would be a worthwhile addition to the tutorial, I'd love to keep working on this and to incorporate any feedback and suggestions

Absolutely this would be a great addition @e-marshall!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants