Skip to content

Commit 1538552

Browse files
Update README for clarity and consistency in installation instructions
1 parent e5f34fc commit 1538552

File tree

1 file changed

+20
-23
lines changed

1 file changed

+20
-23
lines changed

README.md

Lines changed: 20 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
## Planet Interactive Guides
1+
# Planet Interactive Notebook Guides
22

33
In this repository, you'll find a collection of [Jupyter notebooks](http://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/what_is_jupyter.html) from the software developers, data scientists, and developer advocates at [Planet](https://www.planet.com/). These interactive, open-source ([APLv2](LICENSE)) guides are designed to help you work with our APIs and tools, explore Planet data, and learn how to extract information from our massive archive of high-cadence satellite imagery. We hope these guides will inspire you to ask interesting questions of Planet data. Need help? Find a bug? Please [file an issue](https://github.com/planetlabs/notebooks/issues/new) and we'll get back to you.
44

5-
## Install and use these notebooks
5+
## Install and Use Planet Jupyter Notebooks
66

77
### System Prerequisites
8-
* [Docker](https://store.docker.com/search?type=edition&offering=community)
9-
* [Planet Account](https://www.planet.com/explorer/?signup=1)
8+
* [Docker](https://docs.docker.com/get-started/get-docker/)
9+
* [Planet Account](https://insights.planet.com/sign-up)
1010
* [Planet API Key](https://www.planet.com/account/)
1111

12-
NOTE: After installing Docker, Windows users should install WSL2 Backend when prompted.
13-
14-
### Clone or update repo:
12+
### Clone or update repo
1513

1614
If you've never cloned the Planet notebooks repo, run the following:
1715

@@ -29,7 +27,7 @@ git pull
2927

3028
## Authentication
3129

32-
## Access your Planet API Key in Python
30+
## Access Your Planet API Key in Python
3331

3432
Authentication with Planet's API Key can be achieved by using a valid Planet API Key.
3533

@@ -53,7 +51,7 @@ PLANET_API_KEY = os.getenv('PL_API_KEY')
5351

5452
Now, your Planet API Key is stored in the variable ```PLANET_API_KEY``` and is ready to use in your Python code.
5553

56-
### Sentinel Hub Python SDK
54+
## Sentinel Hub Python SDK
5755
Some Notebooks in this repository use the [Sentinel Hub Python SDK](https://sentinelhub-py.readthedocs.io/en/latest/index.html). Currently, this SDK uses a different method of authenticating than what is used with the Planet APIs and SDK for Python.
5856

5957
For the Sentinel Hub Python SDK, you must provide a ```client_id``` and a ```client_secret``` which can be obtained from the [Dashboard](https://apps.sentinel-hub.com/dashboard/) app. You can find full instructions on setting up the client credentials in this SDK from the [SDK documentation](https://sentinelhub-py.readthedocs.io/en/latest/configure.html).
@@ -75,33 +73,31 @@ else:
7573
```
7674

7775
## Run Planet Notebooks in Docker
78-
Planet Notebooks rely on a complex stack of technologies that are not always easy to install and properly
79-
configure. To ease this complexity we provide a docker container for running the notebook on docker compatible
80-
systems. To install docker on your system please see docker's [documentation](https://docs.docker.com/engine/installation/)
81-
for your operating system.
76+
Planet Notebooks rely on a complex stack of technologies that are not always easy to install and properly configure. To ease this complexity we provide a Docker container for running the notebook on Docker compatible systems. To install Docker on your system please see [Docker documentation](https://docs.docker.com/get-started/get-docker/) for your operating system.
8277

8378
### Build the Docker image
8479

85-
First you must build the docker image. Note, this only has to be done the first time you use it. After checking out the
86-
repository, you run:
80+
First you must build the docker image. After checking out the repository, you run:
81+
8782
```bash
8883
docker build -t planet-notebooks planet-notebook-docker/
8984
```
9085

91-
This will build and install the Docker image on your system, making it available to run. This may take some
92-
time (from 10 minutes to an hour) depending on your network connection and how long Anaconda takes to configure
93-
its environment.
86+
This will build and install the Docker image on your system, making it available to run. This may take some time (from 10 minutes to an hour) depending on your network connection and how long Anaconda takes to configure its environment.
87+
88+
> [!IMPORTANT]
89+
> You may need to rebuild the Docker image if this repository changes or if you need to use newer versions of the Planet SDK for Python.
9490
9591
### Run the container
96-
To run the container (after building or downloading it), add your Planet API key below and issue the following command from the git repository root directory:
92+
To run the container after building it, add your Planet API key to the command below and run it from the cloned `planetlabs/notebooks` repository root directory in Unix bash, Windows PowerShell, Git Bash, or WSL.
9793

9894
```bash
9995
docker run -it --rm -p 8888:8888 -v "$(pwd)/jupyter-notebooks:/home/jovyan/work" -e PL_API_KEY='your-key' planet-notebooks
100-
101-
# If you get a permissions error running the above, you should add sudo to the front:
102-
# sudo docker run -it --rm -p 8888:8888 -v $PWD:/home/jovyan/work -e PL_API_KEY='[YOUR-API-KEY]' planet-notebooks
10396
```
10497

98+
> [!TIP]
99+
> If you get permission errors: Add sudo to the front (Linux/Mac) or run PowerShell as Administrator (Windows).
100+
105101
This does several things:
106102

107103
1. **Maps port 8888** - Makes the container accessible at http://localhost:8888
@@ -117,4 +113,5 @@ with your browser.
117113
http://localhost:8888/?token=<UNIQUE-TOKEN>
118114
```
119115

120-
NOTE: This security token will change every time you start your Docker container.
116+
> [!NOTE]
117+
> This security token will change every time you start your Docker container.

0 commit comments

Comments
 (0)