earth-observation-for-journ.../README.md
2021-03-01 11:47:21 +00:00

51 lines
2.2 KiB
Markdown

# 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.
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 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
```
When running the docker image you need to define your Scihub user credentials as environment variables:
``` bash
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/`.