FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Custom index tutorial by e-marshall · Pull Request #295 · xarray-contrib/xarray-tutorial · GitHub

/ xarray-tutorial Public

Custom index tutorial - #295

Draft
e-marshall wants to merge 3 commits into
xarray-contrib:mainfrom
e-marshall:custom_index
ConversationCommits (3)ChecksFiles changed
Draft

Custom index tutorial#295
e-marshall wants to merge 3 commits into
xarray-contrib:mainfrom
e-marshall:custom_index

Conversation

e-marshall commented Aug 19, 2024

Copy link
Copy Markdown
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

review-notebook-app Bot commented Aug 19, 2024

Copy link
Copy Markdown

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

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

github-actions Bot commented Aug 19, 2024 •
edited
Loading

Copy link
Copy Markdown

🎊 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 commented Sep 10, 2024

Copy link
Copy Markdown
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!

scottyhq commented Jul 7, 2025

Copy link
Copy Markdown
Contributor

Just noting that a lot of development on Xarray indexing has happened over the last year in particular this new webpage of examples is coming together https://github.com/xarray-contrib/xarray-indexes !

Eventually we should review content to make sure not too much is duplicated across Xarray docs, Xarray tutorial, and external resources like the one above, but that they also link to eachother.

dcherian commented Jul 7, 2025

Copy link
Copy Markdown
Contributor

I think that one should be merged in with some kind of gallery that should also include the ecosystem book in this repo. I created a new one so we could iterate quickly

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL