Merge pull request #371 from nens/BvH_tutorial_results_analysis

Tutorial results analysis
nens · Jan 30, 2024 · 845ed4f · 845ed4f
2 parents a097f70 + 5d1508f
commit 845ed4f
Show file tree

Hide file tree

Showing 13 changed files with 839 additions and 12 deletions.
diff --git a/README.rst b/README.rst
@@ -61,6 +61,11 @@ When the citation has been added to the .bib file, cite it in the text like this
 
   For further details, see :cite:p:`Volp2013`
 
+QGIS icons
+----------
+
+Instead of screenshotting the icons from QGIS, you can find the originals here: https://github.com/qgis/QGIS/tree/master/images/themes/default
+
 
 Some sphinx/restructuredtext notes
 ----------------------------------

diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md
@@ -23,3 +23,4 @@ Common spelling mistakes:
 - Wrong: ground water. Right: groundwater.
 - Wrong: timeseries. Right: time series.
 - Wrong: time serie. Right: time series (also if it is a single time series!!).
+- Wrong: waterlevel. Right: water level
diff --git a/source/e_results_analysis_tutorial.rst b/source/e_results_analysis_tutorial.rst
diff --git a/source/e_tutorials.rst b/source/e_tutorials.rst
@@ -14,4 +14,5 @@ If you are looking for instructions on more advanced topics, please check out th
    e_2d_tutorial
    e_2d_slope_tutorial
    e_2d_flood_tutorial
-   e_2d_flood_adaptation_tutorial.rst
+   e_2d_flood_adaptation_tutorial
+   e_results_analysis_tutorial
diff --git a/source/h_logging.rst b/source/h_logging.rst
@@ -3,6 +3,9 @@
 Log files
 =========
 
+
+.. _flow_summary:
+
 Flow summary
 ------------
 

diff --git a/source/i_overview_user_interface.rst b/source/i_overview_user_interface.rst
@@ -76,7 +76,7 @@ Activate the 3Di Models and Simulation panel by clicking the pictogram (|modelsS
 Access the 3Di Models and Simulation settings dialog by clicking *Main menu* > *Plugins* > *3Di Models and Simulations* > *Settings*.
 
 .. figure:: image/i_overview_models_sim_setting.png
-   :alt: Overview interface Models and Simulation Settings
+   :alt: Overview of the 3Di Models and Simulation Settings dialog
 
 * **Base API URL:** The Base API URL is in most cases https://api.3di.live.
 * **Uploads processing timeout:** If uploading data for a simulation (such as initial water levels or laterals time series) takes longer than the value specified here (in seconds), 3Di Models & Simulations will stop trying to initialize the simulation. Default value is 900 s.
@@ -89,16 +89,17 @@ Access the 3Di Models and Simulation settings dialog by clicking *Main menu* > *
 
 3Di Results Analysis toolbar
 ----------------------------
-.. todo::
-
-   describe the 3Di Results Analysis toolbar, include this thing about log file somewhere in that description:
-   .. _logfile:
-   Log file
-   --------
-
-   Clicking the (|loggingtoolbar|) saves the logging of your results analysis to your computer. By clicking the underlined path to the text file in the pop-up windows you can open the log file. This can provide helpful information about what went wrong in case of an error.
+
+.. figure:: image/i_3di_results_analysis_toolbar.png
+   :alt: 3Di Results Analysis toolbar
 
-   Also, it can be send as an attachment to our :ref:`servicedesk` at [email protected] in case of errors.
+The 3Di Results Analysis toolbar gives you access to all the :ref:`toctree_analysing_results`. 
+
+Clicking the |loggingtoolbar| saves the technical logging of the 3Di Results Analysis plugin to a file. This can be helpful for the our :ref:`servicedesk` when you run into any technical issues with the 3Di Results Analysis plugin.
+
+.. |loggingtoolbar| image:: /image/i_3di_results_analysis_toolbar_logging.png
+    :scale: 25%
+
 
 .. _temporal_controller:
 

diff --git a/source/i_results_aggregation.rst b/source/i_results_aggregation.rst
@@ -2,7 +2,7 @@
 
 Results aggregation tool
 ========================
-With the Results Aggregation Tool (|resultsaggregationtoolbar|) you can quickly aggregate the results over the entire simulation (or a part of it), using preset outputs and styling.
+With the Results Aggregation Tool |resultsaggregationtoolbar| you can quickly aggregate the results over the entire simulation (or a part of it), using preset outputs and styling.
 Running the tool produces temporary layers. If you want to save the output export the layers as a GeoPackage by clicking |savescratchlayer|. To save the styling with your GeoPackage right-click the temporary layer > Styles > Copy Style > All Style Categories. Paste the styling by right-clicking the GeoPackage-layer > Styles > Paste Style > All Style Categories. Save the styling to the GeoPackage, by making it the default styling. Go to the Layer Properties by double clicking the layer > Symbology > Style (at the bottom) > Save as Default > Save default styling to Datasource Database). Whenever you add this GeoPackage to your Modeller Interface at a later time it will automatically load with this styling.
 
 

diff --git a/source/image/langaa_waterbalans_antwoord.png b/source/image/langaa_waterbalans_antwoord.png
diff --git a/source/image/langaa_waterbalans_leeg.png b/source/image/langaa_waterbalans_leeg.png
diff --git a/source/image/new_geopackage.png b/source/image/new_geopackage.png
diff --git a/source/image/new_geopackage.svg b/source/image/new_geopackage.svg
diff --git a/source/image/value_tool.png b/source/image/value_tool.png