Add Inverse Face Indices to Subsetted Grids

[aaronzedwick]

Closes #1114

Overview

Expected Usage

import uxarray as ux

grid_path = "/path/to/grid.nc"

grid = ux.open_grid(grid_path)

coord = [0, 0]
subset = grid.subset.nearest_neighbor(coord, k=1, element="face centers", inverse_indices=True)

inverse_face_indices = subset.inverse_face_indices.values

PR Checklist

General

• An issue is linked created and linked
• Add appropriate labels
• Filled out Overview and Expected Usage (if applicable) sections

Testing

• Adequate tests are created if there is new functionality
• Tests cover all possible logical paths in your function
• Tests are not too basic (such as simply calling a function and nothing else)

Documentation

• Docstrings have been added to all new functions
• Docstrings have updated with any function changes
• Internal functions have a preceding underscore (_) and have been added to docs/internal_api/index.rst
• User functions have been added to docs/user_api/index.rst

[philipc2]

Initial implementation looks good; a few design considerations.

[philipc2]

May you include this in the cross_section implementations also?

[aaronzedwick]

May you include this in the cross_section implementations also?

Sure. Would that be a different attribute or stored in the same inverse indices?

[philipc2]

May you include this in the cross_section implementations also?

Sure. Would that be a different attribute or stored in the same inverse indices?

Should be the same parameter for consistency, stored within the inverse_indices

[philipc2]

Accidently approved in the previous review, please disregard.

[philipc2]

Please include a test that directly uses Grid.isel(). Docstrings need to be updated to describe the inverse_indicesparameter.

[philipc2]

Nice work.

There are a few instances where you refer to "face indices" as "face centers".

Can you make sure that we refer to the indices as "node", "edge" and "face" instead of reffering to them as "node center", "edge center", or "face center"

[rajeeja]

Seems to work, still parsing the code, in the meantime - it'd be good to add or extend one of the examples in subset.ipynb

[aaronzedwick]

Seems to work, still parsing the code, in the meantime - it'd be good to add or extend one of the examples in subset.ipynb

Yeah, this had crossed my mind as well.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[philipc2]

Great work @aaronzedwick !

Three small comments, otherwise all looks fantastic.

[philipc2]

Nice work!