Merge pull request #2 from danpejobo/dev

v.2.0.0

Author: danpejobo

.gitignore

@@ -150,3 +150,9 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+#QGIS stuff
+zip_build/
+
+#VSCode stuff
+.vscode/

README.md

@@ -6,17 +6,22 @@ A QGIS plugin for different Geovita custom processing algorithms. This plugin is
 
 **New algorithms are added to this repo as they are developed, and new releases published!**
 
-Status
+Status and Limitations
 =====
 
 - Implemented [REMEDY GIS RiskTool](https://github.com/norwegian-geotechnical-institute/REMEDY_GIS_RiskTool) to run from QGIS processing
-  - It is important to read the manual for this project. Especially if you want to perform `vulnerability analysis`. This will require you to edit the polygon layers containing the `building` features (see specifications section).
+  - It is important to read the manual for this project. Especially if you want to perform `vulnerability analysis`. This will require you to edit the polygon layers containing the `building` features (see specifications section below).
+  - Supported filetypes: `.shp`
+    - If you have an "in memory" layer or other fileformats you will need to save it to a `.shp` file. This is a restriction imposed by the underlaying submodule.
+  - Projection of layers:
+    - All layers `need the same projection` before you can run the algorithms
+    - The algorithm does not (yet) reproject layers. This means you have to do it manually first.
 
 Tools
 =====
-- **REMEDY GIS RiskTool**
+- **REMEDY GIS RiskTool** - These algorithms create a log directory in this location `%user%/Downloads/REMEDY`. For the moment this is hardcoded.
   - `Begrens Skade - Excavation` The Begrens Skade - Excavation algorithm provides a comprehensive analysis of building settlements and risks associated with subsidence and inclination.
-  - `Begrens Skade - ImpactMap` The BegrensSkade ImpactMap alorithm calculates both short-term and long-term settlements that occur due to the establishment of a construction pit.
+  - `Begrens Skade - ImpactMap` The BegrensSkade ImpactMap alorithm calculates both short-term and long-term settlements that occur due to the establishment of a construction pit (this alg. takes a bit of time to run, open the log and refresh it to see the logged progress).
   - `Begrens Skade - Tunnel` The BegrensSkade Tunnel alorithm provides a comprehensive analysis of building settlements and risks associated with subsidence and inclination due to tunnel excavation.
 
 QGIS Plugin
@@ -26,6 +31,8 @@ This provider functions as a QGIS plugin (for QGIS >= 3.4) and is available via
 
 The plugin adds a new group to the Processing Toolbox for "Geovita", containing sub-groups with tools and algorithms to perform different tasks.
 
+If you enconter bugs of any sort, PLEASE consider reporting them through [the bugtracker at GitHub](https://github.com/danpejobo/geovita_processing_plugin/issues). Everyone benefits!
+
 Specifications
 ==============
 
@@ -34,7 +41,7 @@ It is crucial to understand the limitations of the [REMEDY GIS RiskTool](https:/
 If you want to enable `vulnerability analysis` you will need some information on the buildings near the excavation/tunnel. You will need to add text fields to each feature in the building polygon layer for `Foundation`, `Structure` and `Condition`. See below for the allowed values! 
 - Class A is the best and D the worst. 
 - If i cell contains `-` it only means that this field only have 2 possible values.
-- Copy/pasete the values so they match!
+- Copy/paste the values so they match!
 
 | Class | Foundation                                              | Structure                        | Condition              |
 |-------|---------------------------------------------------------|----------------------------------|------------------------|
@@ -44,9 +51,18 @@ If you want to enable `vulnerability analysis` you will need some information on
 | B     | Raft                                                    | Reinforced concrete              | Good                   |
 | B     | Betong                                                  | B - Armert betong                | B - God tilstand       |
 | B     | B - På løsmasser - Hel plate (betong, såle)             | -                                | -                      |
-| C     | Strip                                                   | Mixed                            | -                      |
-| C     | Grunnmur                                                | C - Tre eller varierende         | -                      |
+| C     | Strip                                                   | Mixed                            | Medium                 |
+| C     | Grunnmur                                                | C - Tre eller varierende         | C - Brukbar tilstand   |
 | C     | C - På løsmasser - Stripefundament (heller)             | -                                | -                      |
-| D     | Wooden piles                                            | Masonry                          | Medium                 |
-| D     | Trepeler                                                | D - Murstein eller spesiell type | C - Brukbar tilstand   |
-| D     | D - På løsmasser - Punkt- og trefundamenter (banketter) | -                                | -                      |
+| D     | Wooden piles                                            | Masonry                          | Bad                    |
+| D     | Trepeler                                                | D - Murstein eller spesiell type | D - Dårlig             |
+| D     | D - På løsmasser - Punkt- og trefundamenter (banketter) | -                                | -                      |
+
+## Results
+The following images show some example results. Both the excavation and the tunnel algorithm produces results for short and/or longterm settlements, but uses different calculation methods. The impact map calculates and illustrate total settlements in the impaced soil around the excavation.
+
+| Loaded Layers | Short term | Long term | Impact map |
+|---------------|------------|-----------|------------|
+| ![Loaded layers](resources/example-short-term-layers.png) <br><br> The symbology of the loaded layers | ![Short term](resources/example-short-term.png) <br><br> Blue hatch is the excavation. Status of corners, walls and buildings | ![Long term](resources/example-long-short-term.png) <br><br> Blue hatch is the excavation. Dark background is the depth to bedrock raster used for long term settlements. | ![Impact map](resources/example-impact-map.png) <br><br> Red hatch is the excavation. The impact map for total settlements around the excavation. |
+
+

__init__.py

@@ -26,7 +26,7 @@
 __date__ = '2024-01-17'
 __copyright__ = '(C) 2024 by DPE'
 
-__version__ = "1.0.1"
+__version__ = "2.0.0"
 
 import sys
 from pathlib import Path
@@ -49,6 +49,17 @@ def classFactory(iface):  # pylint: disable=invalid-name
     submodule_dir = plugin_dir / "REMEDY_GIS_RiskTool"
     if str(submodule_dir) not in sys.path:
         sys.path.append(str(submodule_dir))
+        
+    # The styles are provided in a styles.zip archive. As such it is neccessary to extract them the first time the plugin is loaded
+    styles_dir = plugin_dir / "styles"
+    if not styles_dir.is_dir():
+        import zipfile
+        import os
+        # Ensure the styles directory exists
+        # styles_dir.mkdir(parents=True, exist_ok=True)
+        with zipfile.ZipFile(plugin_dir / 'styles.zip', 'r') as zip_ref:
+            zip_ref.extractall(plugin_dir)
+        os.remove(plugin_dir / 'styles.zip')
 
     # Now you can import your main plugin class
     from .geovita_processing_plugin import GeovitaProcessingPluginPlugin