DRAFT: E3SM UXarray and Dask Examples

[rytam2]

Closes #822

Overview

Expected Usage

import uxarray as ux

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

uxds = ux.open_dataset(grid_path, data_path)

# this is how you use this function
some_output = uxds.some_function()

# this is another way to use this function
other_output = uxds.some_function(some_param = True)

PR Checklist

General

• [x] An issue is linked created and linked
• [x] 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

Examples

• [ ] Any new notebook examples added to docs/examples/ folder
• [ ] Clear the output of all cells before committing
• [ ] New notebook files added to docs/examples.rst toctree
• [ ] New notebook files added to new entry in docs/gallery.yml with appropriate thumbnail photo in docs/_static/thumbnails/

[review-notebook-app[bot]]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[review-notebook-app[bot]]

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:20Z ----------------------------------------------------------------

Maybe we could change the title to something that better reflects the content of the notebook?

"Analysis of E3SMv2 Model Output"

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:21Z ----------------------------------------------------------------

Overview

This workflow example showcases how to use UXarray to analyze the unstructured grid output from the Energy Exascale Earth System Model (E3SM) model directly without needing to perform any regridding operations.

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:22Z ----------------------------------------------------------------

Line #22.    warnings.filterwarnings("ignore")

We want to have this warning filter be the first thing we execute so that none of the warnings show up.

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:23Z ----------------------------------------------------------------

This is great!

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:24Z ----------------------------------------------------------------

The latex appears to be broken in the rendered documentation.

https://uxarray--836.org.readthedocs.build/en/836/examples/e3sm-calc-workflow.html#calculating-cloud-radiative-effect-netcre-with-uxarray

You want to use the following syntax instead (for example)

{math}4{\pi}{r^2}

_rytam2 commented on 2024-07-08T22:16:31Z_ ----------------------------------------------------------------

Hi Philip, thanks for the comment! For the syntax, do you mean I'll do the following:

$$
{SWCRE = FSNT-FSNTC}
$$

Or do you mean adding {math} before the SWCRE...FSNTC equation, and have $$ removed?

_philipc2 commented on 2024-07-09T06:22:00Z_ ----------------------------------------------------------------

Correct, it should look like {math}{SWCRE = FSNT - FSNTC}

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:25Z ----------------------------------------------------------------

I do like the idea of having this example of plots in a single row compared to the stacked ones below, but I think for consistency we should keep these plots the same as the ones below.

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:25Z ----------------------------------------------------------------

Line #45.        * features.opts(fig_size=160)

This applies to the other plots too. Can we try a slightly larger fig_size.Maybe 250?

rytam2 commented 15 hours ago

Hi Philip, thanks for the comment! For the syntax, do you mean I'll do the following:

$$
{SWCRE = FSNT-FSNTC}
$$

Or do you mean adding {math} before the SWCRE...FSNTC equation, and have $$ removed?

--- View entire conversation on ReviewNB

philipc2 commented 7 hours ago

Correct, it should look like {math}{SWCRE = FSNT - FSNTC}

---

View entire conversation on ReviewNB

• © Githubissues.
• Githubissues is a development platform for aggregating issues.

[review-notebook-app[bot]]

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:21Z ----------------------------------------------------------------

Overview

This workflow example showcases how to use UXarray to analyze the unstructured grid output from the Energy Exascale Earth System Model (E3SM) model directly without needing to perform any regridding operations.

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:22Z ----------------------------------------------------------------

Line #22.    warnings.filterwarnings("ignore")

We want to have this warning filter be the first thing we execute so that none of the warnings show up.

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:23Z ----------------------------------------------------------------

This is great!

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:24Z ----------------------------------------------------------------

The latex appears to be broken in the rendered documentation.

https://uxarray--836.org.readthedocs.build/en/836/examples/e3sm-calc-workflow.html#calculating-cloud-radiative-effect-netcre-with-uxarray

You want to use the following syntax instead (for example)

{math}4{\pi}{r^2}

_rytam2 commented on 2024-07-08T22:16:31Z_ ----------------------------------------------------------------

Hi Philip, thanks for the comment! For the syntax, do you mean I'll do the following:

$$
{SWCRE = FSNT-FSNTC}
$$

Or do you mean adding {math} before the SWCRE...FSNTC equation, and have $$ removed?

_philipc2 commented on 2024-07-09T06:22:00Z_ ----------------------------------------------------------------

Correct, it should look like {math}{SWCRE = FSNT - FSNTC}

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:25Z ----------------------------------------------------------------

I do like the idea of having this example of plots in a single row compared to the stacked ones below, but I think for consistency we should keep these plots the same as the ones below.

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:25Z ----------------------------------------------------------------

Line #45.        * features.opts(fig_size=160)

This applies to the other plots too. Can we try a slightly larger fig_size.Maybe 250?

rytam2 commented 15 hours ago

Hi Philip, thanks for the comment! For the syntax, do you mean I'll do the following:

$$
{SWCRE = FSNT-FSNTC}
$$

Or do you mean adding {math} before the SWCRE...FSNTC equation, and have $$ removed?

--- View entire conversation on ReviewNB

philipc2 commented 7 hours ago

Correct, it should look like {math}{SWCRE = FSNT - FSNTC}

---

View entire conversation on ReviewNB

• © Githubissues.
• Githubissues is a development platform for aggregating issues.

[review-notebook-app[bot]]

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:22Z ----------------------------------------------------------------

Line #22.    warnings.filterwarnings("ignore")

We want to have this warning filter be the first thing we execute so that none of the warnings show up.

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:23Z ----------------------------------------------------------------

This is great!

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:24Z ----------------------------------------------------------------

The latex appears to be broken in the rendered documentation.

https://uxarray--836.org.readthedocs.build/en/836/examples/e3sm-calc-workflow.html#calculating-cloud-radiative-effect-netcre-with-uxarray

You want to use the following syntax instead (for example)

{math}4{\pi}{r^2}

_rytam2 commented on 2024-07-08T22:16:31Z_ ----------------------------------------------------------------

Hi Philip, thanks for the comment! For the syntax, do you mean I'll do the following:

$$
{SWCRE = FSNT-FSNTC}
$$

Or do you mean adding {math} before the SWCRE...FSNTC equation, and have $$ removed?

_philipc2 commented on 2024-07-09T06:22:00Z_ ----------------------------------------------------------------

Correct, it should look like {math}{SWCRE = FSNT - FSNTC}

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:25Z ----------------------------------------------------------------

I do like the idea of having this example of plots in a single row compared to the stacked ones below, but I think for consistency we should keep these plots the same as the ones below.

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:25Z ----------------------------------------------------------------

Line #45.        * features.opts(fig_size=160)

This applies to the other plots too. Can we try a slightly larger fig_size.Maybe 250?

rytam2 commented 15 hours ago

Hi Philip, thanks for the comment! For the syntax, do you mean I'll do the following:

$$
{SWCRE = FSNT-FSNTC}
$$

Or do you mean adding {math} before the SWCRE...FSNTC equation, and have $$ removed?

--- View entire conversation on ReviewNB

philipc2 commented 7 hours ago

Correct, it should look like {math}{SWCRE = FSNT - FSNTC}

---

View entire conversation on ReviewNB

• © Githubissues.
• Githubissues is a development platform for aggregating issues.

[review-notebook-app[bot]]

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:23Z ----------------------------------------------------------------

This is great!

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:24Z ----------------------------------------------------------------

The latex appears to be broken in the rendered documentation.

https://uxarray--836.org.readthedocs.build/en/836/examples/e3sm-calc-workflow.html#calculating-cloud-radiative-effect-netcre-with-uxarray

You want to use the following syntax instead (for example)

{math}4{\pi}{r^2}

_rytam2 commented on 2024-07-08T22:16:31Z_ ----------------------------------------------------------------

Hi Philip, thanks for the comment! For the syntax, do you mean I'll do the following:

$$
{SWCRE = FSNT-FSNTC}
$$

Or do you mean adding {math} before the SWCRE...FSNTC equation, and have $$ removed?

_philipc2 commented on 2024-07-09T06:22:00Z_ ----------------------------------------------------------------

Correct, it should look like {math}{SWCRE = FSNT - FSNTC}

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:25Z ----------------------------------------------------------------

I do like the idea of having this example of plots in a single row compared to the stacked ones below, but I think for consistency we should keep these plots the same as the ones below.

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:25Z ----------------------------------------------------------------

Line #45.        * features.opts(fig_size=160)

This applies to the other plots too. Can we try a slightly larger fig_size.Maybe 250?

rytam2 commented 15 hours ago

Hi Philip, thanks for the comment! For the syntax, do you mean I'll do the following:

$$
{SWCRE = FSNT-FSNTC}
$$

Or do you mean adding {math} before the SWCRE...FSNTC equation, and have $$ removed?

--- View entire conversation on ReviewNB

philipc2 commented 7 hours ago

Correct, it should look like {math}{SWCRE = FSNT - FSNTC}

---

View entire conversation on ReviewNB

• © Githubissues.
• Githubissues is a development platform for aggregating issues.

[review-notebook-app[bot]]

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:24Z ----------------------------------------------------------------

The latex appears to be broken in the rendered documentation.

https://uxarray--836.org.readthedocs.build/en/836/examples/e3sm-calc-workflow.html#calculating-cloud-radiative-effect-netcre-with-uxarray

You want to use the following syntax instead (for example)

{math}4{\pi}{r^2}

_rytam2 commented on 2024-07-08T22:16:31Z_ ----------------------------------------------------------------

Hi Philip, thanks for the comment! For the syntax, do you mean I'll do the following:

$$
{SWCRE = FSNT-FSNTC}
$$

Or do you mean adding {math} before the SWCRE...FSNTC equation, and have $$ removed?

_philipc2 commented on 2024-07-09T06:22:00Z_ ----------------------------------------------------------------

Correct, it should look like {math}{SWCRE = FSNT - FSNTC}

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:25Z ----------------------------------------------------------------

I do like the idea of having this example of plots in a single row compared to the stacked ones below, but I think for consistency we should keep these plots the same as the ones below.

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:25Z ----------------------------------------------------------------

Line #45.        * features.opts(fig_size=160)

This applies to the other plots too. Can we try a slightly larger fig_size.Maybe 250?

rytam2 commented 15 hours ago

Hi Philip, thanks for the comment! For the syntax, do you mean I'll do the following:

$$
{SWCRE = FSNT-FSNTC}
$$

Or do you mean adding {math} before the SWCRE...FSNTC equation, and have $$ removed?

--- View entire conversation on ReviewNB

philipc2 commented 7 hours ago

Correct, it should look like {math}{SWCRE = FSNT - FSNTC}

---

View entire conversation on ReviewNB

• © Githubissues.
• Githubissues is a development platform for aggregating issues.

[review-notebook-app[bot]]

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:25Z ----------------------------------------------------------------

I do like the idea of having this example of plots in a single row compared to the stacked ones below, but I think for consistency we should keep these plots the same as the ones below.

review-notebook-app[bot] commented 21 hours ago

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:25Z ----------------------------------------------------------------

Line #45.        * features.opts(fig_size=160)

This applies to the other plots too. Can we try a slightly larger fig_size.Maybe 250?

rytam2 commented 15 hours ago

Hi Philip, thanks for the comment! For the syntax, do you mean I'll do the following:

$$
{SWCRE = FSNT-FSNTC}
$$

Or do you mean adding {math} before the SWCRE...FSNTC equation, and have $$ removed?

--- View entire conversation on ReviewNB

philipc2 commented 7 hours ago

Correct, it should look like {math}{SWCRE = FSNT - FSNTC}

---

View entire conversation on ReviewNB

• © Githubissues.
• Githubissues is a development platform for aggregating issues.

[review-notebook-app[bot]]

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-08T16:41:25Z ----------------------------------------------------------------

Line #45.        * features.opts(fig_size=160)

This applies to the other plots too. Can we try a slightly larger fig_size.Maybe 250?

rytam2 commented 15 hours ago

Hi Philip, thanks for the comment! For the syntax, do you mean I'll do the following:

$$
{SWCRE = FSNT-FSNTC}
$$

Or do you mean adding {math} before the SWCRE...FSNTC equation, and have $$ removed?

--- View entire conversation on ReviewNB

philipc2 commented 7 hours ago

Correct, it should look like {math}{SWCRE = FSNT - FSNTC}

---

View entire conversation on ReviewNB

• © Githubissues.
• Githubissues is a development platform for aggregating issues.

[rytam2]

Hi Philip, thanks for the comment! For the syntax, do you mean I'll do the following:

$$
{SWCRE = FSNT-FSNTC}
$$

Or do you mean adding {math} before the SWCRE...FSNTC equation, and have $$ removed?

--- View entire conversation on ReviewNB

[philipc2]

Correct, it should look like {math}{SWCRE = FSNT - FSNTC}

---

View entire conversation on ReviewNB