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
+29-4Lines changed: 29 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,15 @@ See Workshop entry doc https://geopython.github.io/geopython-workshop.
8
8
9
9
### Requirements
10
10
11
-
The workshop requires [Docker](https://docker.com)
12
-
and [Docker Compose](https://docs.docker.com/compose/) on your system
11
+
The workshop uses Jupyter Notebooks. [Jupyter](https://jupyter.org/) is an interactive development environment suitable for documenting and reproducing workflows using live code.
12
+
13
+
As the installation of all dependencies on all platforms (Windows, Mac, Linux) can be quite involved and complex this workshop provides all components within a Docker Image.
14
+
15
+
In addition, geospatial web services like pygeoapi and pycsw in this workshop are provided by Docker images.
16
+
17
+
The core requirement is to have Docker and Docker Compose installed on the system. Once you have Docker and Docker Compose installed you will be able to install and run the workshop without any other dependencies.
18
+
19
+
Alternatively, if you're confident with Python development, you can run the notebook in a local Anaconda or Python environment. [Read more about running locally](#running-locally)
NB [Jupyter notebook](https://en.wikipedia.org/wiki/Project_Jupyter) needs a **token**. The token is displayed in the jupyter container logs on startup:
@@ -81,6 +86,26 @@ cd geopython-workshop.git/workshop/jupyter
81
86
- by default the web services pygeoapi and pycsw are not required for the regular workshop like FOSS4G
82
87
- if you use pygeoapi: there is an issue with MacOS Monterey where the port 5000 is already used and therefore conflicting with that one used by pygeoapi. If you are facing this error `OSError: [Errno 48] Address already in use` then your machine is affected. To overcome the issue you can disable the *Airplay Receiver* from `System Preferences->Sharing` of your MacOS (detailed description in this blog [post](https://progressstory.com/tech/port-5000-already-in-use-macos-monterey-issue/)).
83
88
89
+
### Running locally
90
+
91
+
If you're confident with Python development, consider to run the Jupyter notebook locally. The operations below require a [anaconda](https://www.anaconda.com/) or [(micro)mamba](https://mamba.readthedocs.io/en/latest/user_guide/mamba.html) environment.
Copy file name to clipboardExpand all lines: web/docs/index.md
+29-3Lines changed: 29 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,11 @@ able to install and run the workshop without any other dependencies.
25
25
26
26
More information on installing Docker can also be found [here](./docker.md).
27
27
28
+
Alternatively, if you're confident with Python development, you can run the notebook
29
+
in a local Anaconda or Python environment. [Read more about running locally](#running-locally).
30
+
Or run the notebook in the cloud, using `Jupyter Binder`. [Read more about
31
+
running in binder](#run-notebook-in-the-cloud).
32
+
28
33
### Optional requirements
29
34
30
35
Users may optionally install [QGIS](https://qgis.org) as a GIS data viewer.
@@ -183,12 +188,33 @@ In that case you could also try `http://0.0.0.0:8888?token=<token>`.
183
188
184
189
There is an issue with MacOS Monterey where the port 5000 is already used and therefore conflicting with that one used by pygeoapi. If you are facing this error `OSError: [Errno 48] Address already in use` then your machine is affected. To overcome the issue you can disable the *Airplay Receiver* from `System Preferences->Sharing` of your MacOS (detailed description in this blog [post](https://progressstory.com/tech/port-5000-already-in-use-macos-monterey-issue/)).
185
190
186
-
## No Docker Installed?
191
+
## Running locally
192
+
193
+
If you're confident with python development, consider to run the Jupyter notebook locally. The operations below require a [anaconda](https://www.anaconda.com/) or [(micro)mamba](https://mamba.readthedocs.io/en/latest/user_guide/mamba.html) environment.
# Run the notebook, copy URL (with token) to browser if browser does not open automatically
208
+
jupyter notebook
209
+
```
210
+
211
+
## Run notebook in the cloud
187
212
188
213
If you somehow were not able to install Docker:
189
-
there is a Cloud version of the Jupyter-Notebook-part of the workshop via "Jupyter Binder".
214
+
there is a Cloud version of the Jupyter-Notebook-part of the workshop,
215
+
available via [Jupyter Binder](https://jupyter.org/binder).
190
216
191
-
With some limits (e.g. no local geo-services, no data publication), you can follow most of the workshop using a remote Docker instance within your browser via "Jupyter Binder". Click on the button below
217
+
With some limits (e.g. no local geo-services, no data publication), you can follow most of the workshop using a remote Docker instance within your browser via `Jupyter Binder`. Click on the button below
192
218
to launch the Workshop Binder Instance. Startup takes a while, be patient...
0 commit comments