Skip to content

Commit 0917a47

Browse files
authored
Update README.md
1 parent 9b5e428 commit 0917a47

1 file changed

Lines changed: 13 additions & 8 deletions

File tree

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,30 @@
22
[![DOI](https://zenodo.org/badge/792319296.svg)](https://zenodo.org/doi/10.5281/zenodo.11073060)
33

44
# Introduction
5-
This repository contains the codes for the Geo-INQUIRE tool to compute the rainfall-induced landslide hazard over an area. This verison of the code assumes a constant 24-h rainfall acummulation over the entire area covered by the susceptibility map.
5+
This repository contains the codes for the Geo-INQUIRE tool to compute the rainfall-induced landslide hazard over an area. This verison of the code can assume a constant 24-h rainfall acummulation over the entire area covered by the susceptibility map, or use a user-provided map with the 24h rainfall acummulations over the area covered by the susceptibility map.
66

77
# Getting Started
88
1. Installation process: The landslide hazard tool requires to have installed python and Poetry.
99
2. Software dependencies: Python version and dependecies are specified in the Poetry .toml file.
1010

1111
## REQUIRED INPUT DATA AND FILES:
1212
Input files must be saved (before running the hazard tool) in the ../Data/ folder:
13-
- `input_variables.csv`: csv file where input rainfall can be specified.
13+
- `input_variables.csv`: csv file where the mode and input rainfall can be specified.
1414
- `*_sus.tif` : Tile of the susceptibility map over hazard will be computed. Must be downloaded from map repository.
1515
- `StdMaxDayRain.txt`: Standard deviation of the maximum daily rainfall.
1616

1717
## RUN THE HAZARD TOOL:
18-
1. In place the tile of the susceptibiluty map covering the area you want to compute the hazard in the folder `./Tool-Hazard-Map/input`
19-
2. Modify the `input_variables.csv` excel with the 24 h rainfall acummulation in [mm] you want to check.
20-
2. The code you need to runn is stored in `./Tool-Hazard-Map/Code` folder
21-
3. Before you runn the code make sure you have activated the poetry enviroment: `poetry shell`
22-
4. From the `./Tool-Hazard-Map/Code` folder in the terminal run: `python Hazard.py`
23-
5. The outpurs are stored in the `../Results/constant/` folder.
18+
1. In place the tile of the susceptibiluty map covering the area you want to compute the hazard in the folder `./Tool-Hazard-Map/input`.
19+
2. In the case of wanting to use a spatial-variable rainfall map place it in the folder the folder `./Tool-Hazard-Map/input`. The map needs to be in ".tif" format, cover the area of the susceptibility map and use the WGS84 (EPSG: 4326) projection.
20+
3. Modify the `input_variables.csv` excel:
21+
3.3. Select mode; "constant" if you desire to apply a constat user-specified rainfall acummulation over an area. "map" if you desire to use your own rainfall map.
22+
3.4. In case of using the mode "constant" specify the 24 h rainfall acummulation in [mm] over the area.
23+
3.5. In case of using teh mode "map" specify the name of the .tif file containing the rainfall map (without the file extension).
24+
25+
5. The code you need to runn is stored in `./Tool-Hazard-Map/Code` folder
26+
6. Before you runn the code make sure you have activated the poetry enviroment: `poetry shell`
27+
7. From the `./Tool-Hazard-Map/Code` folder in the terminal run: `python Hazard.py`
28+
8. The outpurs are stored in the `../Results/constant/` folder.
2429

2530
## OUTPUT:
2631
Results from the Hazard Tool are saved in the following folder which is authomatically generated `../Results/constant/`

0 commit comments

Comments
 (0)