From 71662b4b60502cc9e102dd6a3b57123dcde3a1b6 Mon Sep 17 00:00:00 2001 From: heyarne Date: Tue, 2 Mar 2021 13:58:46 +0100 Subject: [PATCH] Slightly rewrite README.md --- README.md | 11 +++++++---- _config.yml | 0 2 files changed, 7 insertions(+), 4 deletions(-) mode change 100755 => 100644 _config.yml diff --git a/README.md b/README.md index e39bdc4..cabf4cd 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # 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. +This repository contains a series of notebooks describing interaction with the Copernicus Open Acces Hub in order to obtain, manipulate and analyze earth observation data. +The aim is to document common tasks that might make the data from the Copernicus Sentinel-2 mission attractive for usage in data journalism. 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. @@ -13,6 +13,7 @@ The registration form can be found at https://scihub.copernicus.eu/dhus/. ## Obtaining and Running the Code +The notebooks are published for reading at https://arne.schlueter.is/working-on/remote-sensing-for-journalism. 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. @@ -43,7 +44,9 @@ Follow the link for more information on installed packages or other configuratio Note that working with this kind of data is resource intensive. These notebooks download or create roughly 50GB of data, most of which is occupied by compressed GeoTIFF files. -They have been executed and tested on a virtual server with 4 CPU cores at 2.6 GHz each and 32 GB of RAM. +They have been executed and tested on a virtual server with 4 CPU cores with a clock speed of 2.6 GHz each and 32 GB of RAM. + +There are notebooks cells with `%%time` or `%%timeit` magic commands. There ouput contains infromation about execution time on the system described above. ## Building the Jupyter Book @@ -51,7 +54,7 @@ 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 . +docker run eratosthenes jupyter-book build . ``` The resulting book can be found in the directory `_build/html/`. diff --git a/_config.yml b/_config.yml old mode 100755 new mode 100644