V3.0.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is. If you hit some error please paste the entire Python stacktrace message.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - QGIS release [e.g. QGIS 3.28]
+ - geovita_processing_provider release [e.g. 2.0.2]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots and URL about the feature request here.

.github/workflows/test_plugin.yml

@@ -0,0 +1,97 @@
+name: Test plugin
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+    paths:
+    - "geovita_processing_plugin/**"
+    - ".github/workflows/test_plugin.yml"
+  pull_request:
+    branches:
+      - main
+      - dev
+    paths:
+    - "geovita_processing_plugin/**"
+    - ".github/workflows/test_plugin.yml"
+  workflow_dispatch:
+
+env:
+  # plugin name/directory where the code for the plugin is stored
+  PLUGIN_NAME: geovita_processing_plugin
+  # python notation to test running inside plugin
+  TESTS_RUN_FUNCTION: geovita_processing_plugin.test_suite.test_package
+  # Docker settings
+  DOCKER_IMAGE: qgis/qgis
+
+jobs:
+
+  Test-geovita_processing_plugin:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        docker_tags: [release-3_28, latest]
+
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
+
+      - name: Docker pull and create qgis-testing-environment
+        run: |
+          docker pull "$DOCKER_IMAGE":${{ matrix.docker_tags }}
+          docker run -d -e XDG_RUNTIME_DIR=/tmp/runtime-root --name qgis-testing-environment -v ${{ github.workspace }}:/tests_directory -e DISPLAY=:99 "$DOCKER_IMAGE":${{ matrix.docker_tags }}
+
+      - name: List mounted directory contents
+        run: |
+          docker exec qgis-testing-environment ls -la /tests_directory
+          docker exec qgis-testing-environment ls -la /tests_directory/$PLUGIN_NAME
+
+      - name: Docker set up QGIS
+        run: |
+          docker exec qgis-testing-environment sh -c "qgis_setup.sh $PLUGIN_NAME"
+          docker exec qgis-testing-environment sh -c "cat /root/.local/share/QGIS/QGIS3/profiles/default/QGIS/QGIS3.ini"
+          docker exec qgis-testing-environment sh -c "rm -f /root/.local/share/QGIS/QGIS3/profiles/default/python/plugins/$PLUGIN_NAME"
+          docker exec qgis-testing-environment sh -c "ln -s /tests_directory/$PLUGIN_NAME /root/.local/share/QGIS/QGIS3/profiles/default/python/plugins/$PLUGIN_NAME"
+          docker exec qgis-testing-environment sh -c "pip3 install -r /tests_directory/REQUIREMENTS_TESTING.txt"
+
+          docker exec qgis-testing-environment sh -c "ls -l /root/.local/share/QGIS/QGIS3/profiles/default/python/plugins/"
+          docker exec qgis-testing-environment sh -c "ls -l /root/.local/share/QGIS/QGIS3/profiles/default/python/plugins/$PLUGIN_NAME"
+
+      - name: Prepare REMEDY_GIS_RiskTool submodule
+        run: |
+          docker exec qgis-testing-environment sh -c "touch /tests_directory/$PLUGIN_NAME/REMEDY_GIS_RiskTool/__init__.py"
+          docker exec qgis-testing-environment ls -la /tests_directory/$PLUGIN_NAME/REMEDY_GIS_RiskTool  
+
+      - name: Docker run plugin tests
+        run: |
+          docker exec qgis-testing-environment sh -c "export PYTHONPATH=/root/.local/share/QGIS/QGIS3/profiles/default/python/plugins:$PYTHONPATH && qgis_testrunner.sh $TESTS_RUN_FUNCTION"
+
+  Check-code-quality:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+          architecture: 'x64'
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install packages
+        run: |
+          pip install -r REQUIREMENTS_TESTING.txt
+          pip install pylint pycodestyle
+
+      - name: Pylint
+        run: make pylint
+
+      - name: Pycodestyle
+        run: make pycodestyle

.gitignore

@@ -155,4 +155,7 @@ cython_debug/
 zip_build/
 
 #VSCode stuff
-.vscode/
+.vscode/
+
+#Ruff
+.ruff*

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "REMEDY_GIS_RiskTool"]
 	path = REMEDY_GIS_RiskTool
 	url = https://github.com/norwegian-geotechnical-institute/REMEDY_GIS_RiskTool.git
+[submodule "geovita_processing_plugin/REMEDY_GIS_RiskTool"]
+	path = geovita_processing_plugin/REMEDY_GIS_RiskTool
+	url = https://github.com/norwegian-geotechnical-institute/REMEDY_GIS_RiskTool.git

Makefile

@@ -65,7 +65,7 @@ PEP8EXCLUDE=pydev,resources.py,conf.py,third_party,ui
 #	* Windows:
 #	  AppData\Roaming\QGIS\QGIS3\profiles\default\python\plugins'
 
-QGISDIR=C:\Users\dpe\AppData/Roaming/QGIS/QGIS3/profiles/default/python/plugins
+QGISDIR=.local/share/QGIS/QGIS3/profiles/default/python/plugins/
 
 #################################################
 # Normally you would not need to edit below here
@@ -222,7 +222,7 @@ pylint:
 	@echo "-----------------"
 	@echo "Pylint violations"
 	@echo "-----------------"
-	@pylint --reports=n --rcfile=pylintrc . || true
+	@pylint --reports=n --rcfile=pylintrc geovita_processing_plugin || true
 	@echo
 	@echo "----------------------"
 	@echo "If you get a 'no module named qgis.core' error, try sourcing"
@@ -231,14 +231,14 @@ pylint:
 	@echo "----------------------"
 
 
-# Run pep8 style checking
+# Run pep8/pycodestyle style checking
 #http://pypi.python.org/pypi/pep8
-pep8:
+pycodestyle:
 	@echo
 	@echo "-----------"
-	@echo "PEP8 issues"
+	@echo "pycodestyle PEP8 issues"
 	@echo "-----------"
-	@pep8 --repeat --ignore=E203,E121,E122,E123,E124,E125,E126,E127,E128 --exclude $(PEP8EXCLUDE) . || true
+	@pycodestyle --repeat --ignore=E203,E121,E122,E123,E124,E125,E126,E127,E128 --exclude $(PEP8EXCLUDE) geovita_processing_plugin || true
 	@echo "-----------"
 	@echo "Ignored in PEP8 check:"
 	@echo $(PEP8EXCLUDE)

README.md

@@ -1,68 +1,33 @@
-![Geovita Logo](icons/geovita.ico)
+![Geovita Logo](geovita_processing_plugin/icons/geovita.ico)
 
-# Geovita Processing Provider
+Geovita Processing Provider
+===========================
+[![Static Badge](https://img.shields.io/badge/plugins.QGIS.org-published-green)](https://plugins.qgis.org/plugins/geovita_processing_plugin/)
+[![Test plugin](https://github.com/danpejobo/geovita_processing_plugin/actions/workflows/test_plugin.yml/badge.svg)](https://github.com/danpejobo/geovita_processing_plugin/actions/workflows/test_plugin.yml)
+[![GitHub Release](https://img.shields.io/github/v/release/danpejobo/geovita_processing_plugin)](https://github.com/danpejobo/geovita_processing_plugin/releases)
 
-A QGIS plugin for different Geovita custom processing algorithms. This plugin is currently under development, so new features may be expected!
+The Geovita processing provider for QGIS!
 
-**New algorithms are added to this repo as they are developed, and new releases published!**
-
-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 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** - 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 (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.
+**New algorithms are added to the provider as they are developed**
 
 QGIS Plugin
 ===========
 
-This provider functions as a QGIS plugin (for QGIS >= 3.4) and is available via the standard QGIS plugins repository, so you can install it directly from within QGIS itself.
+This provider functions as a QGIS plugin (for QGIS >= 3.28) and is available via the standard QGIS plugins repository, so you can install it directly from within QGIS itself.
 
 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
-==============
-
-It is crucial to understand the limitations of the [REMEDY GIS RiskTool](https://github.com/norwegian-geotechnical-institute/REMEDY_GIS_RiskTool) calculation methods. I would highly suggest reading the paper and the manual within the REMEDY repository.
+Check it out [here!](/geovita_processing_plugin/)
 
-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/paste the values so they match!
-
-| Class | Foundation                                              | Structure                        | Condition              |
-|-------|---------------------------------------------------------|----------------------------------|------------------------|
-| A     | To bedrock                                              | Steel                            | Excellent              |
-| A     | Peler                                                   | A - Stål                         | A - Meget god tilstand |
-| A     | A - Til berg - Direktefundamentert, peler               | -                                | -                      |
-| 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                            | Medium                 |
-| C     | Grunnmur                                                | C - Tre eller varierende         | C - Brukbar tilstand   |
-| C     | C - På løsmasser - Stripefundament (heller)             | -                                | -                      |
-| D     | Wooden piles                                            | Masonry                          | Bad                    |
-| D     | Trepeler                                                | D - Murstein eller spesiell type | D - Dårlig             |
-| D     | D - På løsmasser - Punkt- og trefundamenter (banketter) | -                                | -                      |
+Overview
+========
+- Implemented [REMEDY GIS RiskTool](https://github.com/norwegian-geotechnical-institute/REMEDY_GIS_RiskTool) to run from QGIS processing
 
-## Results
+## Example results from the REMEDY GIS RiskTool
 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. |
-
-

REQUIREMENTS_TESTING.txt

@@ -0,0 +1,6 @@
+# For tests execution:
+deepdiff
+mock
+flake8
+pep257
+pylint