Unstructured Scheme - Cube Creation 2D #39

stephenworsley · 2021-03-12T10:57:57Z

Fleshes out the creation of cubes. Now adds grid coordinates from the target cube and copies over metadata and scalar coords from the source cube. Code is mostly copied from a similar iris functionality here https://github.com/SciTools/iris/blob/master/lib/iris/analysis/_regrid.py#L360-L363.

codecov · 2021-03-12T10:59:24Z

Codecov Report

Merging #39 (300fde8) into unstructured_scheme (852ba0d) will increase coverage by 0.91%.
The diff coverage is 94.11%.

@@                   Coverage Diff                   @@
##           unstructured_scheme      #39      +/-   ##
=======================================================
+ Coverage                92.08%   93.00%   +0.91%     
=======================================================
  Files                       12       13       +1     
  Lines                      455      486      +31     
=======================================================
+ Hits                       419      452      +33     
+ Misses                      36       34       -2

Impacted Files	Coverage Δ
esmf_regrid/experimental/unstructured_scheme.py	`60.65% <77.77%> (+7.92%)`	⬆️
...erimental/unstructured_scheme/test__create_cube.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 852ba0d...300fde8. Read the comment docs.

stephenworsley · 2021-03-22T10:36:31Z

esmf_regrid/experimental/unstructured_scheme.py

+    new_cube.metadata = copy.deepcopy(src_cube.metadata)
+
+    for coord in src_cube.coords(dimensions=()):
+        new_cube.add_aux_coord(coord.copy())


Code is copied from https://github.com/SciTools/iris/blob/f76288cb82eefc5bc3c74461bfd8f397618eda14/lib/iris/analysis/_regrid.py#L360-L363 . This is from a regridder which is specifically for 2D cubes.

This code is likely to be replaced when we update to handle more dimensions.

stephenworsley · 2021-03-22T10:54:06Z

esmf_regrid/experimental/unstructured_scheme.py

@@ -70,7 +72,7 @@ def _cube_to_GridInfo(cube):
 #     return result


-def _create_cube(data, src_cube, mesh_dim, mesh, grid_x, grid_y):
+def _create_cube(data, src_cube, mesh_dim, grid_x, grid_y):


Originally this followed a pattern seen for example here. In this pattern, (x_dim, y_dim) is equivalent to mesh_dim and (src_x_coord, src_y_coord) is equivalent to mesh. If we followed the same pattern then the purpose of mesh would be to determine which coordinates to copy over from src_cube to the new cube, this would be done by performing a comparison which used mesh. We anticipate that this would be done in multidimensional regridding. However, since a cube can only have one mesh, all that will need to be checked is whether the coord is a MeshCoord (or has a mesh attribute). It is therefore unlikely we will need mesh during cube creation and so I am removing it from the arguments.

stephenworsley · 2021-03-22T14:22:44Z

esmf_regrid/experimental/unstructured_scheme.py

@@ -81,7 +83,13 @@ def _create_cube(data, src_cube, mesh_dim, mesh, grid_x, grid_y):

    new_cube = iris.cube.Cube(data)

-    # TODO: add coords and metadata.
+    new_cube.add_dim_coord(grid_x, mesh_dim + 1)
+    new_cube.add_dim_coord(grid_y, mesh_dim)


The dimension ordering is set so that grid_y is explicitly before grid_x. This will be the case even if the dimension ordering is the other way around in the target cube. The ability to be preserve the target cube dimension ordering may be added in future.

TODO: add a comment describing this design decision.

@stephenworsley thanks for making the changes we discussed. could you make this comment just a tad more descriptive of what would need to be done? i.e. this is the specific case that will work for 2D, but needs to be reworked for 3D. Thanks!

jamesp

Great work @stephenworsley , LGTM!

* Unstructured scheme skeleton (#31) * create skeleton of unstructured regridding code This code is primarily based on Iris's current Area weighted regridding scheme, with the required adaptions for accepting unstructred UGRID data. * Unstructured Scheme - Basic GridInfo Handling (#32) Add basic `GridInfo` function and associated tests. It returns an ESMF regridding object for gridded data. * Unstructured scheme iris source (#33) * refresh cirrus-ci and nox * add iris artifact support * deal with special-case cirrus-ci quoting * review actions * Unstructured Scheme - Basic MeshInfo Handling (#36) * provide iris Mesh to MeshInfo conversion * test against iris feature branch * lint fixes and documentation * fix typo * address review comments. * change tests to better reflect UGRID orientation * address review comments. * address review comments * ASCII art fix * Unstructured Scheme - Cube Creation 2D (#39) * support creation of 2D cubes * lint fixes * rewrite test * remove mesh from _create_cube arguments * add TODO * add TODO * Unstructured Scheme - Mesh Fetching (#46) * support mesh fetching * fix docstring * lint fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add docstrings * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add and restructure tests * fix test * fix test * address review comments * address review comments Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Bill Little <[email protected]> Co-authored-by: Anna Booton <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Unstructured scheme skeleton (SciTools#31) * create skeleton of unstructured regridding code This code is primarily based on Iris's current Area weighted regridding scheme, with the required adaptions for accepting unstructred UGRID data. * Unstructured Scheme - Basic GridInfo Handling (SciTools#32) Add basic `GridInfo` function and associated tests. It returns an ESMF regridding object for gridded data. * Unstructured scheme iris source (SciTools#33) * refresh cirrus-ci and nox * add iris artifact support * deal with special-case cirrus-ci quoting * review actions * Unstructured Scheme - Basic MeshInfo Handling (SciTools#36) * provide iris Mesh to MeshInfo conversion * test against iris feature branch * lint fixes and documentation * fix typo * address review comments. * change tests to better reflect UGRID orientation * address review comments. * address review comments * ASCII art fix * Unstructured Scheme - Cube Creation 2D (SciTools#39) * support creation of 2D cubes * lint fixes * rewrite test * remove mesh from _create_cube arguments * add TODO * add TODO * Unstructured Scheme - Mesh Fetching (SciTools#46) * support mesh fetching * fix docstring * lint fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add docstrings * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add and restructure tests * fix test * fix test * address review comments * address review comments Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Bill Little <[email protected]> Co-authored-by: Anna Booton <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

stephenworsley requested a review from abooton March 12, 2021 10:58

stephenworsley commented Mar 22, 2021

View reviewed changes

stephenworsley added 5 commits March 22, 2021 14:58

support creation of 2D cubes

713c8f5

lint fixes

ebc0a37

rewrite test

fa4c9a4

remove mesh from _create_cube arguments

a0c0e60

add TODO

3155be3

stephenworsley force-pushed the unstructured_scheme_create_cube branch from 4120efa to 3155be3 Compare March 22, 2021 15:03

add TODO

300fde8

jamesp approved these changes Mar 22, 2021

View reviewed changes

jamesp merged commit f75498a into SciTools:unstructured_scheme Mar 23, 2021

stephenworsley mentioned this pull request Mar 30, 2021

Unstructured Scheme - Cube Creation 3D #47

Merged

trexfeathers mentioned this pull request Feb 21, 2022

update changelog #151

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unstructured Scheme - Cube Creation 2D #39

Unstructured Scheme - Cube Creation 2D #39

stephenworsley commented Mar 12, 2021

codecov bot commented Mar 12, 2021 •

edited

Loading

stephenworsley Mar 22, 2021 •

edited

Loading

stephenworsley Mar 22, 2021

stephenworsley Mar 22, 2021 •

edited

Loading

jamesp Mar 22, 2021

jamesp left a comment

Unstructured Scheme - Cube Creation 2D #39

Unstructured Scheme - Cube Creation 2D #39

Conversation

stephenworsley commented Mar 12, 2021

codecov bot commented Mar 12, 2021 • edited Loading

Codecov Report

stephenworsley Mar 22, 2021 • edited Loading

Choose a reason for hiding this comment

stephenworsley Mar 22, 2021

Choose a reason for hiding this comment

stephenworsley Mar 22, 2021 • edited Loading

Choose a reason for hiding this comment

jamesp Mar 22, 2021

Choose a reason for hiding this comment

jamesp left a comment

Choose a reason for hiding this comment

codecov bot commented Mar 12, 2021 •

edited

Loading

stephenworsley Mar 22, 2021 •

edited

Loading

stephenworsley Mar 22, 2021 •

edited

Loading