move custom accessors to advanced and add a more complex example #168
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
|
@lsetiawan @dcherian I think this is ready to go (thanks for the first round of edits, Don!) - the QC failure is because I added a link in another tutorial to the one I've added in this PR, so the link doesn't exist yet (and thus fails the link checker). Happy to fix this if there's a better/more preferred way to include internal links. |
intermediate/xarray_ecosystem.ipynb
Outdated
There was a problem hiding this comment.
Using this syntax might just work:
[ADVANCED](accessors)
There was a problem hiding this comment.
Adding "Customizing Xarray" makes the title quite long for the left sidebar. Seems better to shorten somehow
There was a problem hiding this comment.
Good point - how about "A Tour of Xarray Customizations"? Happy to iterate on this.
There was a problem hiding this comment.
"Extending Xarray: A Tour"?
* upstream/main: move custom accessors to advanced and add more complex, runnable examples (xarray-contrib#168) Update and reorganize apply_ufunc material (xarray-contrib#180) Add jupyterlab-myst 2.0 and sphinx-exercise (xarray-contrib#187) Add jupyterlab-myst (xarray-contrib#182) Add codespace config for scipy 2023 (xarray-contrib#184) Add SciPy Instructions (xarray-contrib#183) Edits to "Xarray and Dask" (xarray-contrib#177) Setup PR Preview workflow (xarray-contrib#175) contents write permissions for github token (xarray-contrib#178)
This PR removes the "Accessors part 2" from the
Intermediate/Tour of the Xarray Ecosystemand puts it in it's ownAdvanced/Accessorssection of the book. This move keeps the coverage of the topics in the "ecosystem" tutorial more balanced and enables the addition of a more complex, detailed example custom accessor that encourages users to add more checks/docs to their code (because they only have to write them once). The example added was reduced from a larger custom extension (which badly needs updating!)UPDATE: @scottyhq and @dcherian suggested making the accessor examples executable as part of this PR. Given the added example used custom local files that could not be easily pulled from existing example datasets, a third (now example 2) example - that is executable - was added. This custom accessor actually replicates the steps in this tutorial.