-
Notifications
You must be signed in to change notification settings - Fork 46
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
Add Docs Based on ESDS Blog Posts #409
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for putting together, @mgrover1! I left a few comments... Once these are addressed, let's merge this!
- graphviz visualizaton notebook is broken
- Add python-graphviz to the doc requirements
- derived variable notebook
- Fix the missing data loading part.
ds
is used/mentioned without being defined. I presumeds
is meant to the result of.to_dataset_dict()
. - Do you mind adding a section with a simple example that shows how to use
DerivedVariableRegistry.load(....)
to load a registry from a Python module? Here's an example from the unit tests:intake-esm/tests/test_derived.py
Line 21 in e367251
def test_registry_load():
- Fix the missing data loading part.
…ver1/intake-esm into update_docs_with_esds_posts
@andersy005 - I added those missing/new sections you mentioned! When you get a chance, can you take a look and see if we can this merged soon? |
Thank you, Max! The code for loading a registry from a Python module won't work unless you point it to a "valid" path. I don't think this has to be executable for demo purposes. How about making this code block non-executable by wrapping it in a markdown code block instead and mentioning that dvr = DerivedVariableRegistry.load('my_registry') # my_registry points to a Python module (`my_registry.py`) file which has to be on Python's `sys.path` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, @mgrover1! I will ping you for reviews when the docs rearrangement is ready
Toward #407
Include notebooks related to ESDS blog posts for documentation, including