mirror of
https://github.com/heyarne/earth-observation-for-journalism.git
synced 2026-05-06 19:13:40 +02:00
Start writing jupyter book
This commit is contained in:
parent
ff7520e58d
commit
58749556b8
19 changed files with 57 additions and 498 deletions
48
README.md
48
README.md
|
|
@ -1,17 +1,51 @@
|
|||
# Earth Observation Data in a Journalistic Context
|
||||
# Remote sensing for journalism
|
||||
|
||||
This repository contains a series of notebooks describing interaction with the Copernicus Open Acces Hub in order to obtain and manipulate earth observation data. A (free) Scihub account is needed in order to execute them, the registration form can be found at https://scihub.copernicus.eu/dhus/.
|
||||
This repository contains a series of notebooks describing interaction with the Copernicus Open Acces Hub in order to obtain and manipulate earth observation data.
|
||||
The aim is to document common tasks that might make the data from the Copernicus Sentinel missions attractive for usage in data journalism reporting.
|
||||
|
||||
The Docker image can be built using the following command:
|
||||
The publication and research uses [Jupyter notebooks](https://jupyter.org) and is published using [jupyter-books](https://jupyter-book.org), an open-source python project that allows generating HTML pages from a collection of Jupyter notebooks.
|
||||
|
||||
## Copernicus Open Access Hub
|
||||
|
||||
Copernicus Open Access Hub is the platform which is openly distributing the Terrabytes of Sentinel-2 data which these notebooks rely on.
|
||||
A (free) Scihub account is needed in order to follow this documentation interactively.
|
||||
The registration form can be found at https://scihub.copernicus.eu/dhus/.
|
||||
|
||||
## Obtaining and running the code
|
||||
|
||||
The source code lives at https://github.com/heyarne/remote-sensing-for-journalism.
|
||||
|
||||
A `Dockerfile` is present at the root of the repository to help with reproducing the computing environment.
|
||||
The image can be built by running the following command from the project root:
|
||||
|
||||
``` bash
|
||||
docker build . -t eratosthenes:latest
|
||||
```
|
||||
|
||||
The resulting notebook is based on the [jupyter/scipy-notebook](https://github.com/jupyter/docker-stacks/tree/master/scipy-notebook). Follow the link for more information on installed packages or other configuration details.
|
||||
|
||||
You need to define your Scihub user credentials as environment variables in order to be able to execute the notebooks:
|
||||
When running the docker image you need to define your Scihub user credentials as environment variables:
|
||||
|
||||
``` bash
|
||||
docker run -it -e SCIHUB_USERNAME='<username>' -e SCIHUB_PASSWORD='<password>' eratosthenes:latest
|
||||
docker run -it \
|
||||
--name eratosthenes \
|
||||
--net host \
|
||||
--volume "$(pwd)":/home/jovyan \
|
||||
-e SCIHUB_USERNAME='<username>' \
|
||||
-e SCIHUB_PASSWORD='<password>' \
|
||||
eratosthenes:latest
|
||||
```
|
||||
|
||||
This starts up a `JupyterLab` environment which allows you to interactively execute all notebooks and modify them to suit your needs.
|
||||
|
||||
The Docker image is based on the [jupyter/scipy-notebook](https://github.com/jupyter/docker-stacks/tree/master/scipy-notebook).
|
||||
Follow the link for more information on installed packages or other configuration details.
|
||||
|
||||
## Building the Jupyter Book
|
||||
|
||||
The `jupyter-book` dependency is included in the `Dockerfile`.
|
||||
You can build a book from a running container by executing the following command on the Docker host:
|
||||
|
||||
```
|
||||
docker run -it eratosthenes jupyter-book build .
|
||||
```
|
||||
|
||||
The resulting book can be found in the directory `_build/html/`.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue