Add tutorial API for example datasets#1502
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Now tutorial api checks both source tree relative paths and path.cwd which helps docs builds. This needs to support both cloned repo and root repo.
rajeeja
left a comment
There was a problem hiding this comment.
Thanks for this PR, @alioacar _meshfiles_path() resolves to test/meshfiles/ which is not included in the PyPI distribution, so ux.tutorial.open_dataset() will raise FileNotFoundError for any user who did pip install uxarray rather than cloning the repo, please revise uxarray/tutorial/init.py, in the _meshfiles_path() function.. Path.cwd() is not the rightway.
|
thanks for the feedback @rajeeja. I updated the tutorial data path resolution. |
rajeeja
left a comment
There was a problem hiding this comment.
Thanks for the contribution👍
Closes #1496
This is a draft PR for early feedback on the tutorial dataset API. I also went through the notebooks and updated them to use tutorial API.
Overview
ux.tutorialAPI for loading built-in sample datasets from the existingtest/meshfilesdirectory (following @erogluorhan's suggestion)uxarray/tutorial/data-structures.ipynb, show both the usual dataset(and grid) loading pattern and the tutorial API for comparisonExpected Usage
PR Checklist
General
Testing
Documentation
Examples