Skip to content

Commit 8970b50

Browse files
committed
Updated installation instruction
Former-commit-id: 278b5224730c77690ce3624ba7c7414d7d528985
1 parent 5833c53 commit 8970b50

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

readme.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,23 @@ Sample input dataset is extracted from [ESA Sentinel-2](https://collections.sent
2323
All configuration to execute Jupyter Notebooks is pre-defined for the sample dataset in the [configuration YAML file](src/config/config.yaml): paths, filenames, API parameters, user-defined numerical parameters.
2424
Data flow within the Data4Land tool can be also explored on the overarching diagram:![diagram](visualisation/workflow.png).
2525

26+
### Installation
27+
Each Jupyter Notebook is recommended to execute through a built Docker to ensure that all dependencies needed are installed correctly. Otherwise, some of the libraries used by Data4Land may face issues. Multiple ways to configure and install Docker are available:
28+
[Windows](https://www.docker.com/products/docker-desktop/), [Linux](https://docs.docker.com/desktop/setup/install/linux/), [Mac](https://docs.docker.com/desktop/setup/install/mac-install/).
29+
Once Docker is installed, user need to:
30+
- download the software repository
31+
- in command line run 'cd /path/data4land' (navigate to the working directory on local machine, replace the directory name if required)
32+
- then run 'docker-compose up' (this will run all Docker commands and start up a Jupyter server)
33+
34+
To execute Jupyter Notebook users need to either:
35+
- navigate to http:localhost:9999 or
36+
- copy URL with token from the console and paste it to browser or another tool used to run Jupyter Notebook (for example, *http://localhost:9999/?token=abcd123400000000000000000000000*)
37+
38+
Now, everything is prepared to execute the Jupyter Notebooks within a Docker environment.
39+
40+
#### Impact
41+
The example of follow-up calculations of habitat connectivity based on non-enriched and enriched LULC datasets is given [here](stats/) to illustrate the significant impact of enriched raster pixels.
42+
2643
#### Further development
2744
This tool is mostly completed, but a few improvements are planned to be done:
2845

@@ -33,8 +50,5 @@ This tool is mostly completed, but a few improvements are planned to be done:
3350
- Implement iterations over multiple LULC files (by year and location) and multiple OSM requests (iterating over the combination of filename-yearname).
3451
- For use case studies: revisit Catalonian government data and decide on its usage, whether it can support OSM data or not.
3552

36-
#### Impact
37-
The example of follow-up calculations of habitat connectivity based on non-enriched and enriched LULC datasets is given [here](stats/) to illustrate the significant impact of enriched raster pixels.
38-
3953
#### Acknowledgement
4054
This software is the part of the [AD4GD project, biodiversity pilot](https://ad4gd.eu/biodiversity/). The AD4GD project is co-funded by the European Union, Switzerland and the United Kingdom.

0 commit comments

Comments
 (0)