Skip to content

Commit

Permalink
add some docs to the top level README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Avery authored and Ryan Avery committed Jul 14, 2024
1 parent f646f08 commit 629a33c
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions examples/README.md
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 more efficient Map Reduce.
`pydot` allows plotting the Cubed execution plan.
`rich` is for showing progress of array operations within callbacks applied to Cubed plan operations.

0 comments on commit 629a33c

Please sign in to comment.