Skip to content

Commit

Permalink
Add pipenv installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
aazuspan committed Mar 8, 2021
1 parent 4f7c7fe commit 6b506cd
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,21 @@ Visualize classified time series data with interactive Sankey plots in Google Ea
`sankee` provides a dead-simple API that combines the power of [GEE](https://github.com/google/earthengine-api) and [Plotly](https://github.com/plotly/plotly.py) to visualize changes in land cover, plant health, burn severity, or any other classified imagery over a time series in a region of interst using interactive Sankey plots. Use a library of built-in datasets like NLCD, MODIS Land Cover, or CGLS for convenience or define your own custom datasets for flexibility.

## Installation
### Using pip
```
pip install sankee
```

### Using pipenv
Pipenv can be used to create an isolated environment for running `sankee`. The following commands set up the environment and create a kernel so that you can run a notebook from it.
```sh
pip install pipenv
pipenv install sankee
pipenv shell
python -m ipykernel install --user --name=my-virtualenv-name
```


## Requirements
- An authenticated GEE Python environment ([offical guide](https://developers.google.com/earth-engine/guides/python_install))

Expand Down

0 comments on commit 6b506cd

Please sign in to comment.