search

ocean-eddy-cpt / gcm-filters

Diffusion-based Spatial Filtering of Gridded Data
https://gcm-filters.readthedocs.io/
Other
37 stars 24 forks source link

add environment file/ extra dependencies for example notebooks #118

Closed isgiddy closed 2 years ago

isgiddy commented 2 years ago

I was running through the documentation file examples - which are really great! and needed to install dependencies along the way. I noticed there was an environment file in the docs folder but think this is not for running the individual notebooks, but rather compiling the documentation?

For users who might want to do what I did, it could be nice to state these extra dependencies (beyond numpy, xarray and dask) /provide an environment file to run through the examples.

Listing them here for reference: matplotlib cupy (optional) intake intake-xarray s3fs cartopy

NoraLoose commented 2 years ago

Thanks for pointing out this issue, @isgiddy! I just opened a PR (#120) that should solve this for the user.

I'm also tagging our JOSS review thread so we can keep track over there of which issues are open / closed.