Updates

Author: matamadio

docs/_toc.yml

@@ -18,6 +18,7 @@ parts:
           - file: docs/hzd_env-data
         - file: docs/global-exposure
         - file: docs/global-vulnerability
+        - file: docs/risk-poverty
         - file: docs/disaster-data
         - file: docs/rdl
         - file: docs/external-tools
@@ -27,19 +28,16 @@ parts:
         sections:
           - file: docs/run_fl
           - file: docs/run_tc
-          - file: docs/run_ci
           - file: docs/run_ch
+          - file: docs/run_ci
+          - file: docs/run_bv
       - file: docs/validation
-      - file: docs/risk-poverty
-        sections:
-        - file: tools/code/merge_tiles/GUI_bivariate-maps.ipynb      
       - file: docs/presentation
       - file: docs/utility
         sections:
         - file: tools/utility/merge_tiles/Merge_tiles.ipynb
         - file: tools/utility/Fetch_data/Fetch_WSF19.ipynb
         - file: tools/utility/mapping.ipynb
-        - file: tools/utility/RWI/RWI-norm.ipynb
       - file: docs/philosophy_of_mapping
   - caption: Credits
     chapters:

docs/images/GUI.jpg

@@ -0,0 +1,68 @@
+# Bi-variate mapping
+
+WIP
+
+## Input data management
+
+This script is meant for custom input from the user on all three risk components. It can still fetch national and sub-national boundaries from the [WB ArcGIS repository](https://services.arcgis.com/iQ1dY19aHwbSDYIF/ArcGIS/rest/services/World_Bank_Global_Administrative_Divisions_VIEW/FeatureServer).
+
+The [**exposure data**](global-exposure.md) and the [**hazard data**](global-hazard.md) selected by the user need to be manually downloaded and placed in the respecive folders; in case of tiled data, use the [pre-processing script](https://github.com/GFDRR/CCDR-tools/blob/main/tools/code/F3/) to merge those into country-sized data. Each dataset is expected as a raster file (`.tif`).<br>
+
+Exampe:
+
+  ```
+  Work dir/
+   - GUI.ipynb		Place the notebooks and related files in the main work directory
+   - common.py
+   - ...
+   - Data/
+     - HZD/country_hazard.tif				Hazard layers
+     - EXP/country_exposure.tif				Exposure layers
+     - RSK/						Output directory
+  ```
+
+  ```{caution}
+  All spatial data must use the same CRS: `EPSG 4326` (WGS 84)
+  ```
+<hr>
+
+## Running the analysis
+
+- Select the country first. Sub-national boundaries for level 1 and 2 can be fetched automatically. Else, you can load custom boundaries as geopackage (WGS 84). You will need to specify the field to be used to run zonal statistics, and related label name (e.g. ADM3_PCODE and ADM3_EN).
+    ```{figure} images/GUI_F3_country.png
+    ---
+    width: 100%
+    align: center
+    ---
+    ```
+- Move to Hazard tab: select the hazard process, the minimum hazard intensity threshold, the time period and climate scenario. Select one or more Return Periods (CTRL+Click / drag mouse).
+    ```{figure} images/GUI_F3_hzd.png
+    ---
+    width: 100%
+    align: center
+    ---
+    ```
+- Select one or more Exposure categories (CTRL+Click / drag mouse). You can select a custom exposure layer for each selected category (.tif raster, WGS 84).
+    ```{figure} images/GUI_F3_exp.png
+    ---
+    width: 100%
+    align: center
+    ---
+    ```
+- Select the approach to use for the analysis:
+  - When using "function", the best impact function is selected for the selected country and exposure categories.
+  - When using "classes", hazard intensity thresholds must be specified by the user.
+    ```{figure} images/GUI_F3_vln.png
+    ---
+    width: 100%
+    align: center
+    ---
+    ```
+- Check "Preview results" to generate map and charts output in the GUI.
+
+```{figure} images/GUI_F3_rsk.png
+---
+width: 100%
+align: center
+---
+```

docs/images/GUI.png

@@ -34,7 +34,7 @@ DATA_DIR = C:/Workdir/RDL-tools
   ```
 The main interface should pop up in your browser.
 
-```{figure} images/GUI.png
+```{figure} images/GUI.jpg
 ---
 width: 100%
 align: center