Remapping Notebook

[aaronzedwick]

Closes #805

Overview

Adds a user guide section for remapping. This also updates the remapping functions to use face centers as default instead of nodes and from using kd_tree for cartesian to using ball_tree.

PR Checklist

General

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

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[philipc2]

I have submitted a few comments under ReviewNB. Let me know if you can see them.

I also in Boulder this week, so I apologize if I'm a little slow on these reviews.

[aaronzedwick]

I have submitted a few comments under ReviewNB. Let me know if you can see them.

I also in Boulder this week, so I apologize if I'm a little slow on these reviews.

That's understandable! Thanks for taking the time to review, I can't see any comments on ReviewNB though.

[philipc2]

Can you view them here?

https://app.reviewnb.com/UXARRAY/uxarray/blob/zedwick/remapping_notebook/docs/user-guide/remapping.ipynb/

[aaronzedwick]

Yes, thank you!

[philipc2]

Link to the user guide section

[philipc2]

I'd suggest cutting down the content a bit here and simplifying it to the following:

Remapping, or commonly referred to as Regridding, is the process of taking data that resides on one grid and mapping it to another. Details on various remapping methods can be found here. This user guide section will cover the two native remapping methods that are supported by UXarray:

• Nearest Neighbor
• Inverse Distance Weighted

Reply via ReviewNB

[philipc2]

Rephrase to the following:

In this notebook, we are using two datasets with different resolutions (480km and 120km) from the MPAS Ocean Model. We will be remapping the bottomDepth variable, which measures the ocean depth.

Reply via ReviewNB

[philipc2]

Rephrase:

We can view the supported remapping methods by accessing the .remap attribute that is part of a UxDataArray

Reply via ReviewNB

[philipc2]

Maybe mention somewhere that the Nearest Neighbor method is a distance-based approach, using an internal KD or Ball Tree to determine the distances?

Reply via ReviewNB

[philipc2]

Small change.

We can remap from the 480km grid to the 120km one, which would perform an upsampling operation.

Reply via ReviewNB

[philipc2]

Added a few more suggestions using ReviewNB.

Once we get a second set of eyes to proof read this, I think it'll be ready to go. This notebook is looking fantastic.

[rajeeja]

Nice work and detailed description. Thanks

Possible to add a figure to explain the general remapping idea? two grids with a value mapped from one to another.

Reply via ReviewNB

[philipc2]

Once #819 is merged, we need to update the references to destination_obj to destination_grid

[philipc2]

Can you make sure to clear the output & restart the kernel for the notebook? Looks like some unnecessary outputs and metadata were included in the commit.

[philipc2]

Lets change up the order one last time to what we had before. We can move the import block back below the introductory paragraph, like you had before. Can you do the same for the other user guide notebooks as part of this PR too?

Should be

Title

Intro Paragraph

Imports

.. Rest of the nobook

Reply via ReviewNB

[philipc2]

Add a sub-title, something like

Simple Remapping Example

Reply via ReviewNB

[philipc2]

I'm going to make a very basic quad-triangle grid that you can use as the destination here, since remapping to the same grid could be a little confusing to the reader.

This example is great though! Very minimal and get the point across very nicely.

Reply via ReviewNB

[aaronzedwick]

Can you make sure to clear the output & restart the kernel for the notebook? Looks like some unnecessary outputs and metadata were included in the commit.

Yeah, sorry about that, I forgot to hit save when I did that right before committing.

[philipc2]

Fantastic work Aaron!