-
Notifications
You must be signed in to change notification settings - Fork 316
Mesh Documentation #4504
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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Mesh Documentation #4504
Changes from 5 commits
Commits
Show all changes
45 commits
Select commit
Hold shift + click to select a range
4fda40c
UGRID docs stub pages.
trexfeathers 1901782
UGRID docs index page.
trexfeathers a6e92ae
Fleshed out UGRID docs stubs.
trexfeathers 83f350c
Correct UGRID docs linkage.
trexfeathers 8cea7f1
Minor adjustments to ugrid/index.rst.
trexfeathers f46ce45
UGRID data model explanation.
trexfeathers f36e9ae
UGRID partner packages docs page.
trexfeathers 9e74b93
Detail on Iris UGRID data model.
trexfeathers 19894ca
UGRID data model docs tweaks.
trexfeathers 77e3f95
Reduced emphasis on UGRID in docs.
trexfeathers c670b92
UGRID partner packages rephrasing.
trexfeathers 4a7f6e2
Remove UGRID partner package comment.
trexfeathers 2b4cce8
Reduced emphasis on UGRID in docs.
trexfeathers eb31ae6
Comment about UGRID data model diagrams.
trexfeathers 226812d
Start documenting UGRID operations examples.
trexfeathers 49f1dc4
Improved linking between UGRID doc pages.
trexfeathers 1d94cc8
UGRID docs review actions.
trexfeathers 9f05718
Example UGRID operations.
trexfeathers 73f3f1b
More UGRID operations documenting.
trexfeathers a0b405c
UGRID docs review actions from @pp-mo.
trexfeathers 3c0e5f8
UGRID docs review actions from @wjbenfold.
trexfeathers ea895e2
Minor UGRID docs corrections.
trexfeathers d8dde31
Merge remote-tracking branch 'upstream/main' into ugrid_docs
trexfeathers 0e96826
UGRID docs updates for new Connectivity names.
trexfeathers 7a27b3f
More example UGRID operations.
trexfeathers aee2be5
UGRID region extraction example tweaks.
trexfeathers 3692c1c
UGRID docs review actions from @lbdreyer.
trexfeathers a315462
Second round UGRID docs review actions from @wjbenfold.
trexfeathers 20113ca
UGRID docs review action from @stephenworsley.
trexfeathers ef47b6b
Add UGRID Operations Summary subheading.
trexfeathers 4a996af
Mention the unstructured dimension more in UGRID docs.
trexfeathers 30c9c69
UGRID docs plotting example.
trexfeathers 954770a
UGRID docs tidy-up.
trexfeathers b8b23e7
UGRID docs plotting example.
trexfeathers d8de567
UGRID docs lat-lon switcheroo.
trexfeathers 4c2b19a
UGRID docs image fix.
trexfeathers 8bc8c84
UGRID data model MeshCoord clarification.
trexfeathers 67b1eb3
Corrected UGRID docs example coords.
trexfeathers d2e504f
UGRID docs more Mesh and Cube printouts.
trexfeathers 970db3c
UGRID docs be more explicit about region extraction.
trexfeathers be5f51b
UGRID docs be more generic about low level languages.
trexfeathers 3d18be7
UGRID docs cubed-sphere example explicitly 2-dimensional.
trexfeathers 5f31e05
Make code-examples copybutton respect line continuations.
pp-mo 2acd327
Merge pull request #8 from pp-mo/ugrid_docs_copybutton
trexfeathers 0761b58
Sphinx copybutton fix.
trexfeathers File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| .. _ugrid model: | ||
|
|
||
| .. | ||
| The conventions page is [necessarily] not for a layperson. This is an | ||
| opportunity to explain UGRID at an Iris user's level - doesn't need to be | ||
| exhaustive, just get across what is needed for the user to understand why | ||
| their experience will be different to 'normal'. | ||
|
|
||
|
|
||
| The UGRID Data Model | ||
| ******************** | ||
|
|
||
| What's Different? | ||
| ================= | ||
|
|
||
| .. | ||
| IDEA: The unstructured mesh format maximises flexibility, but means that no | ||
| spatial information can be inferred from a structured data array. Much | ||
| less is implicit, much more information has to be stored explicitly. | ||
|
|
||
| Diagram(s) - SVG so editable later. | ||
|
|
||
| How Iris Represents This | ||
| ======================== | ||
|
|
||
| .. | ||
| Include API links to the various classes | ||
|
|
||
| Include Cube/Mesh printout(s) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| .. include:: ../../common_links.inc | ||
|
|
||
| .. _ugrid: | ||
|
|
||
| UGRID Support | ||
| ************* | ||
|
|
||
| Iris includes specialised handling of data that follows the | ||
| `CF-UGRID Conventions`__. UGRID-conformant data can be loaded from a file, | ||
| represented in Iris' data model, worked with, and saved as a UGRID-conformant | ||
| file. More detail is in this section and in the :mod:`iris.experimental.ugrid` | ||
| API documentation. | ||
|
|
||
| ---- | ||
|
|
||
| UGRID is different | ||
| UGRID's mesh-located data is fundamentally different to grid-located data. | ||
| Many of Iris' existing operations need adapting before they can work with | ||
| mesh-located data, and in some cases entirely new concepts are needed. | ||
| **Read the detail here before jumping into your own code.** | ||
| Iris' UGRID support is experimental | ||
| This is a rapidly evolving part of the codebase at time of writing | ||
| (``Jan 2021``), as we continually expand the operations that work with mesh | ||
|
stephenworsley marked this conversation as resolved.
Outdated
|
||
| data. **Be prepared for breaking changes even in minor releases.** | ||
| :ref:`Get involved! <development_where_to_start>` | ||
| We know meshes are an exciting new area for much of Earth science, so we hope | ||
| there are a lot of you with new files/ideas/wishlists, and we'd love to hear | ||
| more 馃檪. | ||
|
|
||
| ---- | ||
|
|
||
| Read on to find out more... | ||
|
|
||
| * :doc:`data_model` - learn why the mesh experience is so different. | ||
| * :doc:`partner_packages` - meet some optional dependencies that provide powerful mesh operations. | ||
| * :doc:`operations` - experience how your workflows will look when written for UGRID data. | ||
|
|
||
| .. | ||
| Need an actual TOC to get Sphinx working properly, but have hidden it in | ||
| favour of the custom bullets above. | ||
|
|
||
| .. toctree:: | ||
| :hidden: | ||
| :maxdepth: 1 | ||
|
|
||
| data_model | ||
| partner_packages | ||
| operations | ||
|
|
||
| __ CF-UGRID_ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| .. _ugrid operations: | ||
|
|
||
| Working with UGRID Data | ||
| *********************** | ||
|
|
||
| .. note:: Several of the operations below rely on the optional dependencies | ||
| mentioned in :doc:`partner_packages`. | ||
|
|
||
|
wjbenfold marked this conversation as resolved.
|
||
| .. | ||
| Have a table here that lists the headings below, including a small note | ||
| about whether it's unchanged (e.g. Saving), has to be done differently | ||
| (e.g. Extraction), or isn't yet possible (e.g. Arithmetic). Each row | ||
| should link to the section below. Basically an enhanced TOC. | ||
|
|
||
| .. | ||
| Below: use demo code over prose wherever workable. Headings aren't an | ||
| exhaustive list (can you think of any other popular operations?). | ||
|
|
||
|
wjbenfold marked this conversation as resolved.
|
||
| Load | ||
| ---- | ||
|
|
||
| Summary | ||
| ------- | ||
| .. | ||
| Possibly covered by the data_model page? | ||
|
|
||
| Save | ||
| ---- | ||
|
|
||
| Plotting | ||
| -------- | ||
|
|
||
| Regional Extraction | ||
| ------------------- | ||
| .. | ||
| Highlight the uselessness of indexing. | ||
|
|
||
| Regridding | ||
| ---------- | ||
|
|
||
| Equality | ||
| -------- | ||
| .. | ||
| Is this worth mentioning, given it just works the way it always has? | ||
|
trexfeathers marked this conversation as resolved.
Outdated
|
||
|
|
||
| Recombination | ||
| ------------- | ||
|
|
||
| Arithmetic | ||
| ---------- | ||
| .. | ||
| Not possible yet - mention this. | ||
|
|
||
| .. | ||
| Headings for other popular operations that aren't yet possible, including | ||
| if they're planned soon. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| .. _ugrid partners: | ||
|
|
||
| .. | ||
| * Explain the optional GeoVista and iris-esmf-regrid dependencies, which | ||
| are powerful but big and should only be installed if the user needs | ||
| them. | ||
| * Brief description of each, and when you might use it. | ||
| * Link to docs if applicable (intersphinx?). | ||
|
|
||
| Iris' UGRID Partner Packages | ||
| **************************** | ||
|
|
||
| GeoVista | ||
| ======== | ||
|
|
||
| iris-esmf-regrid | ||
| ================ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.