Unstructured scheme skeleton #31

stephenworsley · 2021-02-25T16:20:45Z

Introduces the structure of the unstructured regridding scheme with some minimal code. Further tasks are separable and are described by TODO comments.

abooton

Starter comments :)

Summary of out "comment styling":

Code that is future assumptions/ideas are commented out
Copied code could have references to Iris code, to remind us where we were looking at
Lines of code are the "simplest" functionality, that we are reviewing and concentrating on here

esmf_regrid/experimental/unstructured_scheme.py

abooton · 2021-02-25T17:31:49Z

esmf_regrid/experimental/unstructured_scheme.py

+    # Before regridding, data is transposed to a standard form.
+    # This will be done either with something like the following code
+    # or else done within the regridder by specifying args.
+    new_axes = list(range(len(data.shape)))


I think these are an assumption that this will be needed and what it will be like. Maybe we can comment it out for now, and then we know it isn't part of the "definite" review here, but a reminder as to our thoughts

esmf_regrid/experimental/unstructured_scheme.py

abooton · 2021-02-26T09:17:53Z

esmf_regrid/experimental/unstructured_scheme.py

+        )
+
+        # Store regrid info.
+        self.grid_x, self.grid_y, self.regridder = partial_regrid_info


From our helpful discussion I think we will return more variables (to avoid loading the cube twice in the function interface. So this will end up something like,
_, _, self.grid_x, self.grid_y, self.regridder = regrid_info

codecov · 2021-02-26T09:43:32Z

Codecov Report

Merging #31 (60578f2) into unstructured_scheme (142a8dd) will decrease coverage by 7.62%.
The diff coverage is 31.70%.

@@                   Coverage Diff                   @@
##           unstructured_scheme      #31      +/-   ##
=======================================================
- Coverage                96.06%   88.43%   -7.63%     
=======================================================
  Files                        9       10       +1     
  Lines                      305      346      +41     
=======================================================
+ Hits                       293      306      +13     
- Misses                      12       40      +28

Impacted Files	Coverage Δ
esmf_regrid/experimental/unstructured_scheme.py	`31.70% <31.70%> (ø)`

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 142a8dd...60578f2. Read the comment docs.

abooton · 2021-02-26T16:42:38Z

esmf_regrid/experimental/unstructured_scheme.py

+
+def _create_cube(data, src_cube, mesh_dim, mesh, grid_x, grid_y):
+    # Here we expect the args to be as follows:
+    # data: a masked array containing the redult of the regridding operation


redult should be result

abooton · 2021-02-26T16:43:26Z

esmf_regrid/experimental/unstructured_scheme.py

+    # src_cube: the source cube which data is regrid from
+    # mesh_dim: the dimension on src_cube which the mesh belongs to
+    # mesh: the Mesh (or MeshCoord) object belonging to src_cube
+    # grid_x: the coordinateon the target cube representing the x axis


coordinateon => coordinate on
also on line below

abooton · 2021-02-26T16:49:50Z

esmf_regrid/experimental/unstructured_scheme.py

+
+    mesh, mesh_dim = _get_mesh_and_dim(src_mesh_cube)
+
+    regrid_info = (mesh, mesh_dim, grid_x, grid_y, regridder)


For my own understanding, there is a possibility that the exact variables in this list are altered once we continue the implementation. However, they are good for now.

abooton · 2021-02-26T17:05:55Z

This looks good as a first "skeleton outline" for the scheme.
It is noted that the tests are failing because we haven't tested anything yet! This will come when each section is developed and does something!

* 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 <bill.little@metoffice.gov.uk> Co-authored-by: Anna Booton <anna.booton@metoffice.gov.uk> 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 <bill.little@metoffice.gov.uk> Co-authored-by: Anna Booton <anna.booton@metoffice.gov.uk> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

stephenworsley added 2 commits February 25, 2021 16:03

create skeleton of unstructured regridding code

944cb26

clarify names, add comments

8c33c1f

abooton reviewed Feb 25, 2021

View reviewed changes

abooton reviewed Feb 26, 2021

View reviewed changes

address review comments

0431066

stephenworsley added 3 commits February 26, 2021 09:56

lint changes and code tidying

93b1bc2

lint changes

0b4ac60

lint changes

8ffb039

stephenworsley requested a review from abooton February 26, 2021 10:36

abooton reviewed Feb 26, 2021

View reviewed changes

fix typos

60578f2

abooton reviewed Feb 26, 2021

View reviewed changes

abooton merged commit bddb48e into SciTools:unstructured_scheme Feb 26, 2021

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 skeleton #31

Unstructured scheme skeleton #31

stephenworsley commented Feb 25, 2021

abooton left a comment •

edited

Loading

abooton Feb 25, 2021

abooton Feb 26, 2021 •

edited

Loading

codecov bot commented Feb 26, 2021 •

edited

Loading

abooton Feb 26, 2021

abooton Feb 26, 2021 •

edited

Loading

abooton Feb 26, 2021

abooton commented Feb 26, 2021


		mesh, mesh_dim = _get_mesh_and_dim(src_mesh_cube)

		regrid_info = (mesh, mesh_dim, grid_x, grid_y, regridder)

Unstructured scheme skeleton #31

Unstructured scheme skeleton #31

Conversation

stephenworsley commented Feb 25, 2021

abooton left a comment • edited Loading

Choose a reason for hiding this comment

abooton Feb 25, 2021

Choose a reason for hiding this comment

abooton Feb 26, 2021 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Feb 26, 2021 • edited Loading

Codecov Report

abooton Feb 26, 2021

Choose a reason for hiding this comment

abooton Feb 26, 2021 • edited Loading

Choose a reason for hiding this comment

abooton Feb 26, 2021

Choose a reason for hiding this comment

abooton commented Feb 26, 2021

abooton left a comment •

edited

Loading

abooton Feb 26, 2021 •

edited

Loading

codecov bot commented Feb 26, 2021 •

edited

Loading

abooton Feb 26, 2021 •

edited

Loading