Skip to content

Commit

Permalink
pip install xee now supported.
Browse files Browse the repository at this point in the history
This PR updates our documentation to instruct users to install `Xee` from PyPI. I've also added an extra step in the README walkthrough (imports).

Fixes #27.

PiperOrigin-RevId: 572361717
  • Loading branch information
Xee authors committed Oct 10, 2023
1 parent efcb3f2 commit 085de84
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ _An Xarray extension for Google Earth Engine._

## How to use

Install with pip (distributions on PyPi will come soon):
Install with pip:

```shell
pip install git+https://github.com/google/xee.git
pip install --upgrade xee
```

Then, authenticate Earth Engine:
Expand All @@ -20,6 +20,13 @@ Then, authenticate Earth Engine:
earthengine authenticate --quiet
```

Now, in your Python environment, make the following imports:

```python
import ee
import xarray
```

Next, initialize the EE client with the high volume API:

```python
Expand Down

0 comments on commit 085de84

Please sign in to comment.