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

Add Docs Based on ESDS Blog Posts #409

Merged
merged 14 commits into from
Dec 6, 2021

Conversation

mgrover1
Copy link
Collaborator

@mgrover1 mgrover1 commented Nov 24, 2021

Toward #407

Include notebooks related to ESDS blog posts for documentation, including

  • Derived Variable Functionality
  • Building an Intake-ESM catalog from history files
  • Creating visualizations of Intake-ESM catalogs
  • Debugging the Intake-ESM process for reading in CMIP6 data

Copy link
Member

@andersy005 andersy005 left a 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 presume ds 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:
      def test_registry_load():

@mgrover1
Copy link
Collaborator Author

mgrover1 commented Dec 6, 2021

@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?

@andersy005
Copy link
Member

andersy005 commented Dec 6, 2021

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 my_registry points to a Python module (my_registry.py) file which has to be on Python's sys.path

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`

Screen Shot 2021-12-06 at 12 18 13 PM

Copy link
Member

@andersy005 andersy005 left a 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

@andersy005 andersy005 added the documentation Documentation related label Dec 6, 2021
@andersy005 andersy005 merged commit c6841ef into intake:main Dec 6, 2021
@mgrover1 mgrover1 deleted the update_docs_with_esds_posts branch December 6, 2021 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants