Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

document what needs to be installed to run climatology anomaly example #501

Merged
merged 3 commits into from
Jul 20, 2024
Merged

document what needs to be installed to run climatology anomaly example #501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f646f08
document what needs to be installed to run example
Jul 14, 2024
629a33c
add some docs to the top level README
Jul 14, 2024
46475ce
Update examples/README.md
rbavery Jul 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,14 @@ The plots are SVG files and are written in the `history` directory in a director
```shell
open $(ls -d history/compute-* | tail -1)/timeline.svg
```

## Running the notebook examples

Before running these notebook examples, you will need to install some additional dependencies (besides Cubed).

`mamba install rich pydot flox cubed-xarray`

`cubed-xarray` is necessary to wrap Cubed arrays as Xarray DataArrays or Xarray Datasets.
`flox` is for supporting efficient groupby operations in Xarray.
`pydot` allows plotting the Cubed execution plan.
`rich` is for showing progress of array operations within callbacks applied to Cubed plan operations.
Loading
Loading