Update documentation

opengisch · Mar 28, 2023 · c3274e4 · c3274e4
1 parent 3cb3f32
commit c3274e4
Show file tree

Hide file tree

Showing 23 changed files with 160 additions and 3 deletions.
diff --git a/docs/algorithms.md b/docs/algorithms.md
@@ -1 +1,48 @@
-# Algo
+# Algoritmi
+
+Gli algoritmi utilizzati dal plugin sono anche disponibili in QGIS
+come "Algoritmi di Processing" utilizzabili singolarmente.
+
+![Algoritmi](./assets/algoritmi.png)
+
+## Applica matrice
+
+![Applica matrice](./assets/algoritmo_applica_matrice.png)
+
+### Scopo
+Questo algoritmo aggiunge un campo con il valore della matrice a ogni geometria del layer con le intensità
+
+### Parametri input
+- Layer con le geometrie (intensità)
+  - Campo contenente il periodo di ritorno
+  - Campo contenente l'intensità
+- Matrice da utilizzare (predefinita o manuale)
+
+### Output
+Viene generato un layer uguale al layer in ingresso con l'aggiunta di
+un campo contenente il valore della matrice per ogni geometria.
+
+## Correggi geometrie
+
+![Correggi geometrie](./assets/algoritmo_correggi_geometrie.png)
+
+## Fondi layer intensità
+
+![Fondi layer intensità](./assets/algoritmo_fondi_intensita.png)
+
+## Propagazione
+
+![Propagazione](./assets/algoritmo_propagazione.png)
+
+
+## Semplifica intensità
+
+![Semplifica intensità](./assets/algoritmo_semplifica_intensita.png)
+
+## Zone di pericolo
+
+![Zone di pericolo](./assets/algoritmo_zone_pericolo.png)
+
+## Zone nessun impatto
+
+![Zone nessun impatto](./assets/algoritmo_zone_nessun_impatto.png)
diff --git a/docs/assets/aggiungi_dati_base.gif b/docs/assets/aggiungi_dati_base.gif
diff --git a/docs/assets/aggiungi_processo.gif b/docs/assets/aggiungi_processo.gif
diff --git a/docs/assets/aggiungi_processo.webm b/docs/assets/aggiungi_processo.webm
diff --git a/docs/assets/algoritmi.png b/docs/assets/algoritmi.png
diff --git a/docs/assets/algoritmo_applica_matrice.png b/docs/assets/algoritmo_applica_matrice.png
diff --git a/docs/assets/algoritmo_correggi_geometrie.png b/docs/assets/algoritmo_correggi_geometrie.png
diff --git a/docs/assets/algoritmo_fondi_intensita.png b/docs/assets/algoritmo_fondi_intensita.png
diff --git a/docs/assets/algoritmo_propagazione.png b/docs/assets/algoritmo_propagazione.png
diff --git a/docs/assets/algoritmo_semplifica_intensita.png b/docs/assets/algoritmo_semplifica_intensita.png
diff --git a/docs/assets/algoritmo_zone_nessun_impatto.png b/docs/assets/algoritmo_zone_nessun_impatto.png
diff --git a/docs/assets/algoritmo_zone_pericolo.png b/docs/assets/algoritmo_zone_pericolo.png
diff --git a/docs/assets/calcolo_nessun_impatto.gif b/docs/assets/calcolo_nessun_impatto.gif
diff --git a/docs/assets/calcolo_zone_pericolo.gif b/docs/assets/calcolo_zone_pericolo.gif
diff --git a/docs/assets/matrice_alluvionamento.png b/docs/assets/matrice_alluvionamento.png
diff --git a/docs/assets/matrice_caduta_sassi.png b/docs/assets/matrice_caduta_sassi.png
diff --git a/docs/assets/matrice_scivolamento.png b/docs/assets/matrice_scivolamento.png
diff --git a/docs/assets/matrice_valanga.png b/docs/assets/matrice_valanga.png
diff --git a/docs/assets/modifica_possibilita_multiple.gif b/docs/assets/modifica_possibilita_multiple.gif
diff --git a/docs/assets/repository_plugin.png b/docs/assets/repository_plugin.png
diff --git a/docs/assets/toolbar.png b/docs/assets/toolbar.png
diff --git a/docs/plugin.md b/docs/plugin.md
@@ -3,28 +3,77 @@
 
 ## Installazione
 
-Aggiungere un nuovo repository dei plugin in QGIS:
+Per installare il plugin in QGIS è necessario aggiungere un nuovo
+repository dei plugin in QGIS:
+
+È possibile aggiungere il repository andando nel menu *Plugins -> Gestisci ed Installa Plugin...*
+
+![Aggiungere repository](./assets/repository_plugin.png)
 
 ```
 https://download.opengis.ch/repos/ticino/plugins.xml
 ```
 
-Installare il plugin `pzp`
+A questo punto è possibile installare il plugin chiamato `pzp`.
 
 !!! Note
     Richiede QGIS 3.16 o superiore
 
 
 ## Funzionalità
 
+Le funzionalità del plugin sono accessibili tramite la toolbar del plugin.
+
+![Toolbar](./assets/toolbar.png)
+
+In particolare tramite la toolbar è possibile:
+- aggiungere un nuovo processo con i relativi layer al progetto QGIS attuale
+- aggiungere dei layer con dati di base o mappe di base
+- eseguire il calcolo delle zone di pericolo
+- eseguire il calcolo delle zone di nessun impatto
+- modificare il valore delle zone di pericolo che hanno possibilità multiple
+- consultare questo manuale
+
 ### Aggiunta dei layer per la registrazione di un processo al progetto QGIS
 
+Tramite il pulsante "Aggiuni proceso" è possible aggiungere al
+progetto QGIS attuale un nuovo gruppo contenente i layer per
+digitalizzare le intensità.
+
+Viene chiesto il percorso di una directory in cui salvare i dati (in
+formato GeoPackage) e il tipo di processo da aggiungere. Il processo
+che viene aggiunto consiste in un gruppo di layer.
+
+![Aggiungi processo](./assets/aggiungi_processo.gif)
+
 ### Aggiunta di layer con dati o mappe di base
 
+Tramite i pulsanti "Aggiungi mappa base" e "Aggiungi dati base" è
+possibile aggiungere al progetto QGIS attuale i layer contenenti le
+mappe di base o i layer di base.
+
+![Aggiungi dati_base](./assets/aggiungi_dati_base.gif)
+
+### Digitalizzazione delle geometrie
+
+#### Area di studio
+
+#### Intensità
+
+#### Probabilità di propagazione
+
+#### Probabilità di rottura
+
 ### Calcolo delle zone di pericolo
 
+![Calcolo zone di pericolo](./assets/calcolo_zone_pericolo.gif)
+
 ### Calcolo delle zone di nessun impatto
 
+![Calcolo zone di nessun impatto](./assets/calcolo_nessun_impatto.gif)
+
 ### Modifica delle zone con possibilità multiple
 
+![Modifica zone con possibilità multiple](./assets/modifica_possibilita_multiple.gif)
+
 ### Ottenere informazioni
diff --git a/docs/reference.md b/docs/reference.md
@@ -2,8 +2,69 @@
 
 ## Matrici del pericolo utilizzate
 
+### Flusso di detrito e alluvionamento
+
 ![Alluvionamento](./assets/matrice_alluvionamento.png)
 
+### Scivolamento spontaneo e colata detritica di versante
+
+![Scivolamento](./assets/matrice_scivolamento.png)
+
+### Caduta sassi/blocchi/massi
+
+![Caduta sassi](./assets/matrice_caduta_sassi.png)
+
+### Valanga radente e valanga polverosa
+
+![Valanga](./assets/matrice_valanga.png)
+
 ## Codici domini
 
+### Probabilità di evento
+
+| Codice | Descrizione |
+|--------|-------------|
+| 1000   | Molto bassa |
+| 1001   | Bassa       |
+| 1002   | Media       |
+| 1003   | Alta        |
+
+### Intensità
+
+| Codice | Descrizione      |
+|--------|------------------|
+| 1000   | Nessun impatto   |
+| 1001   | Impatto presente |
+| 1002   | Debole           |
+| 1003   | Medio            |
+| 1004   | Forte            |
+
+### Pericolo
+
+| Codice | Descrizione      |
+|--------|------------------|
+| 1000   | Non in pericolo  |
+| 1001   | Pericolo residuo |
+| 1002   | Basso            |
+| 1003   | Medio            |
+| 1004   | Elevato          |
+
+### Tipo di processo
+
+| Codice | Descrizione                             |
+|--------|-----------------------------------------|
+| 1110   | Alluvionamento corso d'acqua minore     |
+| 1120   | Alluvionamento corso d'acqua principale |
+| 1200   | Flusso detrito                          |
+| 1400   | Ruscellamento superficiale              |
+| 2001   | Scivolamento spontaneo                  |
+| 2002   | Colata detritica di versante            |
+| 3000   | Caduta sassi o blocchi                  |
+| 4100   | Valanga radente                         |
+| 4200   | Valanga polverosa                       |
+
 ## Versioni
+
+| Versione | Data pubblicazione | Descizione |
+|----------|--------------------|------------|
+|          |                    |            |