You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-23Lines changed: 20 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,15 @@
1
-
##Planet Interactive Guides
1
+
# Planet Interactive Notebook Guides
2
2
3
3
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.
Now, your Planet API Key is stored in the variable ```PLANET_API_KEY``` and is ready to use in your Python code.
55
53
56
-
###Sentinel Hub Python SDK
54
+
## Sentinel Hub Python SDK
57
55
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.
58
56
59
57
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:
75
73
```
76
74
77
75
## 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.
82
77
83
78
### Build the Docker image
84
79
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:
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.
94
90
95
91
### 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.
0 commit comments