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 taylordiagram example #186

Merged
merged 5 commits into from Jan 23, 2024
Merged

add taylordiagram example #186

merged 5 commits into from Jan 23, 2024

Conversation

jukent
Copy link
Collaborator

@jukent jukent commented Jan 22, 2024

PR Summary

Adds Taylor Diagram example script
Related to #126

PR Checklist

General

  • Make an issue if one doesn't already exist
  • Link the issue this PR resolves by adding closes #XXX to the PR description where XXX is the number of the issue.
  • Add a brief summary of changes to docs/release-notes.rst in a relevant section for the next unreleased release. Possible sections include: Documentation, New Features, Bug Fixes, Internal Changes, Breaking Changes/Deprecated
  • Add appropriate labels to this PR
  • Make your changes in a forked repository rather than directly in this repo
  • Open this PR as a draft if it is not ready for review
  • Convert this PR from a draft to a full PR before requesting reviewers
  • Passes precommit. To set up on your local, run pre-commit install from the top level of the repository. To manually run pre-commits, use pre-commit run --all-files and re-add any changed files before committing again and pushing.

Examples

  • Any new notebook examples added to docs/examples/ folder
  • Clear all notebook cells
  • New notebook files added to docs/examples.rst toctree
  • New notebook files added to new entry in docs/gallery.yml with appropriate thumbnail photo in docs/_static/thumbnails/

@jukent jukent added the documentation Improvements or additions to documentation label Jan 22, 2024
@jukent jukent marked this pull request as ready for review January 22, 2024 16:29
Copy link
Contributor

@kafitzgerald kafitzgerald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example looks great!

Caught a couple of things to sort out though (see the comments).

Comment on lines 7 to 9
"# `set_titles_and_labels`\n",
"\n",
"This notebook is a simple example of the GeoCAT-viz function <a href=\"../user_api/generated/geocat.viz.util.set_titles_and_labels.html#geocat-viz.util.set_titles_and_labels\">set_titles_and_labels</a>."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this got missed.

It looks like it's causing the index on the left to be incorrect as well. I couldn't find the example at first.
https://geocat-viz--186.org.readthedocs.build/en/186/examples/taylor.html

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm it seems like a commit didn't publish? Because I definitely changed this locally. The link seems off too

"import numpy as np\n",
"import xarray as xr\n",
"\n",
"import cftime\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example seems to be failing on the cftime import (though not loudly - which is concerning).
https://geocat-viz--186.org.readthedocs.build/en/186/examples/taylor.html

Do we need this or is it something we could strip out?

@jukent jukent merged commit f23bb91 into NCAR:main Jan 23, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants