mirror of
https://github.com/heyarne/earth-observation-for-journalism.git
synced 2026-05-06 19:13:40 +02:00
Slightly rewrite README.md
This commit is contained in:
parent
d16798eaed
commit
71662b4b60
2 changed files with 7 additions and 4 deletions
11
README.md
11
README.md
|
|
@ -1,7 +1,7 @@
|
||||||
# Remote Sensing for Journalism
|
# 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.
|
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 missions attractive for usage in data journalism reporting.
|
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.
|
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
|
## 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.
|
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.
|
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.
|
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.
|
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
|
## 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:
|
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/`.
|
The resulting book can be found in the directory `_build/html/`.
|
||||||
|
|
|
||||||
0
_config.yml
Executable file → Normal file
0
_config.yml
Executable file → Normal file
Loading…
Add table
Add a link
Reference in a new issue