Skip to content

Commit efbe4c1

Browse files
authoredApr 6, 2021
add docs for examples commands (#288)
1 parent a5e956e commit efbe4c1

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed
 

‎README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
Xarray-Spatial implements common raster analysis functions using Numba and provides an easy-to-install, easy-to-extend codebase for raster analysis.
3232

33-
#### Installation
33+
### Installation
3434
```bash
3535
# via pip
3636
pip install xarray-spatial
@@ -39,6 +39,18 @@ pip install xarray-spatial
3939
conda install -c conda-forge xarray-spatial
4040
```
4141

42+
### Dowloading our starter examples and data
43+
Once you have xarray-spatial installed in your environment, you can use one of the following in your terminal (with the environment active) to download our examples and/or sample data into your local directory.
44+
45+
```xrspatial examples``` : Download the examples notebooks and the data used.
46+
47+
```xrspatial copy-examples``` : Download the examples notebooks but not the data. Note: you won't be able to run many of the examples.
48+
49+
```xrspatial fetch-data``` : Download just the data and not the notebooks.
50+
51+
In all the above, the command will download and store the files into your current directory inside a folder named 'xrspatial-examples'.
52+
53+
4254
| | | | | |
4355
|:-------------------------:|:-------------------------:|:-------------------------:|:-------------------------:|:-------------------------:|
4456
|<a href="/examples/"><img width="1604" src="img/0-0.png"></a> | <a href="/examples/user_guide/2_Proximity.ipynb"><img width="1604" src="img/0-1.png"></a> |<a href="/examples/user_guide/2_Proximity.ipynb"><img width="1604" src="img/0-2.png"></a> |<a href="/examples/user_guide/2_Proximity.ipynb"><img width="1604" src="img/0-3.png"></a> |<a href="/examples/pharmacy-deserts.ipynb"><img width="1604" src="img/0-4.png"></a>|

0 commit comments

Comments
 (0)
Please sign in to comment.