uxarray E3SM UXarray and Dask Examples

trafficstars

Closes #822

Overview

Added user guide notebook on parallel loading with Dask; and workflow examples with E3SM output with visualization and calculations.

PR Checklist

General

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

Examples

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

Jul 03 '24 18:07 rytam2

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

Jul 03 '24 18:07 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"

Jul 08 '24 16:07 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.

Jul 08 '24 16:07 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.

Jul 08 '24 16:07 review-notebook-app[bot]

View / edit / reply to this conversation on ReviewNB

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

This is great!

Jul 08 '24 16:07 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}

Jul 08 '24 16:07 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.

Jul 08 '24 16:07 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?

Jul 08 '24 16:07 review-notebook-app[bot]

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

Jul 08 '24 22:07 rytam2

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

View entire conversation on ReviewNB

Jul 09 '24 06:07 philipc2

Looks like the LaTex is still broken. Can you add the following to our conf.py and see if it fixes things?

https://github.com/UXARRAY/uxarray/blob/main/docs/conf.py

myst_enable_extensions = [
    "amsmath",
    "attrs_inline",
    "colon_fence",
    "deflist",
    "dollarmath",
    "fieldlist",
    "html_admonition",
    "html_image",
    "linkify",
    "replacements",
    "smartquotes",
    "strikethrough",
    "substitution",
    "tasklist",
]

Jul 11 '24 21:07 philipc2

@rytam2

Now that you've marked the PR as ready for review, there's a few things that you can also do:

Remove the DRAFT from the title
Add reviewers (can add orhan, rajeev, aaron and myself)

Jul 12 '24 16:07 philipc2

@anissa111

Any idea on why LatEx isn't rendering correctly in the notebooks? We've tried a few things above but are still having some issues.

Jul 12 '24 17:07 philipc2

@anissa111

Any idea on why LatEx isn't rendering correctly in the notebooks? We've tried a few things above but are still having some issues.

I'll take a look!

Jul 12 '24 17:07 anissa111

Okay, locally either

```{math}
	SWCRE = FSNT - FSNTC
```

or

$$
	SWCRE = FSNT - FSNTC
$$

works for me

Jul 12 '24 18:07 anissa111

View / edit / reply to this conversation on ReviewNB

philipc2 commented on 2024-07-17T00:18:36Z ----------------------------------------------------------------

... as follows: