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

@trexfeathers contributions to SciTools/iris#5740. #1

Merged
merged 11 commits into from
Mar 27, 2024

Conversation

trexfeathers
Copy link

@trexfeathers trexfeathers commented Feb 16, 2024

  • Include GeoVista as optional Iris dependency
  • Docstrings for iris.experimental.geovista
  • Updates to the Working with Mesh Data documentation

Click here for the rendered documentation

@trexfeathers trexfeathers marked this pull request as draft February 19, 2024 09:03
Comment on lines +480 to +483
Below is an example of using GeoVista to plot a low-res
sample :attr:`~iris.cube.Cube.mesh` based :class:`~iris.cube.Cube`. For
some truly spectacular visualisations of high-res data please see the
GeoVista :external+geovista:doc:`generated/gallery/index`.
Copy link
Author

Choose a reason for hiding this comment

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

Rendered changes

I have:

  • Removed the example of plotting a very simple mesh
  • Changed the global example to use a mesh that is more readily available to the docs builder and to users.

I originally hoped to make this a running example, rather than a static one, which necessitated the big changes. However @bjlittle tells me that is non-trivial where PyVista is concerned. I have still kept most of those changes since it is now easier for a user to replicate, and will be easier for us to iterate in future.

Comment on lines 585 to 587
An Iris convenience for regional extraction is also provided:
:func:`iris.experimental.geovista.region_extraction`; demonstrated
below:
Copy link
Author

Choose a reason for hiding this comment

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

Rendered changes

The functions we have written in #SciTools#5740 have made this example much simpler.

Copy link
Author

Choose a reason for hiding this comment

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

@trexfeathers trexfeathers marked this pull request as ready for review February 19, 2024 10:33
@HGWright
Copy link
Owner

Thanks @trexfeathers for this. Great work especially on the docstrings!

@HGWright HGWright merged commit 16ef521 into HGWright:geo-bridge Mar 27, 2024
14 checks passed
@trexfeathers trexfeathers deleted the additions_5740 branch May 3, 2024 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants