deploy: 1daa915

GFDRR · Nov 13, 2024 · 48206b2 · 48206b2
1 parent 569f715
commit 48206b2
Show file tree

Hide file tree

Showing 11 changed files with 53 additions and 24 deletions.
diff --git a/_images/GUI_F3.png b/_images/GUI_F3.png
diff --git a/_images/GUI_F3_country.png b/_images/GUI_F3_country.png
diff --git a/_images/GUI_F3_exp.png b/_images/GUI_F3_exp.png
diff --git a/_images/GUI_F3_hzd.png b/_images/GUI_F3_hzd.png
diff --git a/_images/GUI_F3_rsk.png b/_images/GUI_F3_rsk.png
diff --git a/_images/GUI_F3_vln.png b/_images/GUI_F3_vln.png
diff --git a/_images/GUI_pre_charts.jpg b/_images/GUI_pre_charts.jpg
diff --git a/_images/GUI_pre_map.png b/_images/GUI_pre_map.png
diff --git a/_sources/docs/tool-setup.md b/_sources/docs/tool-setup.md
@@ -70,7 +70,7 @@ Exampe for Nepal, running analysis on undefended flood, 2020, RP100:
    - common.py
    - ...
    - Data/
-     - HZD/NPL/FLUVIAL_UNDEFENDED/2020/1in100.tif	  	Hazard layers
+     - HZD/NPL/FLUVIAL_UNDEFENDED/2020/1in100.tif	  	  Hazard layers
      - EXP/		                                  Exposure layers
      - RSK/		                                  Output directory
   ```
@@ -82,22 +82,39 @@ Exampe for Nepal, running analysis on undefended flood, 2020, RP100:
 
 ## Running the analysis
 
-- Select the country first.
-- Select one or more (CTRL+Click / drag mouse) Return Periods.
-- Select one or more (CTRL+Click / drag mouse) Exposure categories.
-- Select custom exposure and enter the name of the file in the EXP folder if you don't want to use the default sources.
+- 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_pre_map.png
----
-width: 100%
-align: center
----
-```
-```{figure} images/GUI_pre_charts.jpg
+```{figure} images/GUI_F3_rsk.png
 ---
 width: 100%
 align: center

diff --git a/docs/tool-setup.html b/docs/tool-setup.html
@@ -851,7 +851,7 @@ <h2>Input data management<a class="headerlink" href="#input-data-management" tit
  <span class="o">-</span> <span class="n">common</span><span class="o">.</span><span class="n">py</span>
  <span class="o">-</span> <span class="o">...</span>
  <span class="o">-</span> <span class="n">Data</span><span class="o">/</span>
-   <span class="o">-</span> <span class="n">HZD</span><span class="o">/</span><span class="n">NPL</span><span class="o">/</span><span class="n">FLUVIAL_UNDEFENDED</span><span class="o">/</span><span class="mi">2020</span><span class="o">/</span><span class="mi">1</span><span class="n">in100</span><span class="o">.</span><span class="n">tif</span>	  	<span class="n">Hazard</span> <span class="n">layers</span>
+   <span class="o">-</span> <span class="n">HZD</span><span class="o">/</span><span class="n">NPL</span><span class="o">/</span><span class="n">FLUVIAL_UNDEFENDED</span><span class="o">/</span><span class="mi">2020</span><span class="o">/</span><span class="mi">1</span><span class="n">in100</span><span class="o">.</span><span class="n">tif</span>	  	  <span class="n">Hazard</span> <span class="n">layers</span>
    <span class="o">-</span> <span class="n">EXP</span><span class="o">/</span>		                                  <span class="n">Exposure</span> <span class="n">layers</span>
    <span class="o">-</span> <span class="n">RSK</span><span class="o">/</span>		                                  <span class="n">Output</span> <span class="n">directory</span>
 </pre></div>
@@ -864,24 +864,36 @@ <h2>Input data management<a class="headerlink" href="#input-data-management" tit
 </section>
 <section id="running-the-analysis">
 <h2>Running the analysis<a class="headerlink" href="#running-the-analysis" title="Permalink to this heading">#</a></h2>
-<ul class="simple">
-<li><p>Select the country first.</p></li>
-<li><p>Select one or more (CTRL+Click / drag mouse) Return Periods.</p></li>
-<li><p>Select one or more (CTRL+Click / drag mouse) Exposure categories.</p></li>
-<li><p>Select custom exposure and enter the name of the file in the EXP folder if you don’t want to use the default sources.</p></li>
+<ul>
+<li><p>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).</p>
+<figure class="align-center">
+<a class="reference internal image-reference" href="../_images/GUI_F3_country.png"><img alt="../_images/GUI_F3_country.png" src="../_images/GUI_F3_country.png" style="width: 100%;" /></a>
+</figure>
+</li>
+<li><p>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).</p>
+<figure class="align-center">
+<a class="reference internal image-reference" href="../_images/GUI_F3_hzd.png"><img alt="../_images/GUI_F3_hzd.png" src="../_images/GUI_F3_hzd.png" style="width: 100%;" /></a>
+</figure>
+</li>
+<li><p>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).</p>
+<figure class="align-center">
+<a class="reference internal image-reference" href="../_images/GUI_F3_exp.png"><img alt="../_images/GUI_F3_exp.png" src="../_images/GUI_F3_exp.png" style="width: 100%;" /></a>
+</figure>
+</li>
 <li><p>Select the approach to use for the analysis:</p>
 <ul>
 <li><p>When using “function”, the best impact function is selected for the selected country and exposure categories.</p></li>
-<li><p>When using “classes”, hazard intensity thresholds must be specified by the user.</p></li>
+<li><p>When using “classes”, hazard intensity thresholds must be specified by the user.</p>
+<figure class="align-center">
+<a class="reference internal image-reference" href="../_images/GUI_F3_vln.png"><img alt="../_images/GUI_F3_vln.png" src="../_images/GUI_F3_vln.png" style="width: 100%;" /></a>
+</figure>
+</li>
 </ul>
 </li>
 <li><p>Check “Preview results” to generate map and charts output in the GUI.</p></li>
 </ul>
 <figure class="align-center">
-<a class="reference internal image-reference" href="../_images/GUI_pre_map.png"><img alt="../_images/GUI_pre_map.png" src="../_images/GUI_pre_map.png" style="width: 100%;" /></a>
-</figure>
-<figure class="align-center">
-<a class="reference internal image-reference" href="../_images/GUI_pre_charts.jpg"><img alt="../_images/GUI_pre_charts.jpg" src="../_images/GUI_pre_charts.jpg" style="width: 100%;" /></a>
+<a class="reference internal image-reference" href="../_images/GUI_F3_rsk.png"><img alt="../_images/GUI_F3_rsk.png" src="../_images/GUI_F3_rsk.png" style="width: 100%;" /></a>
 </figure>
 <section id="manual-run">
 <h3>Manual Run<a class="headerlink" href="#manual-run" title="Permalink to this heading">#</a></h3>

diff --git a/searchindex.js b/searchindex.js