documentatie

Documentatie/Gebruikershandleiding/basisgebruik.qmd

@@ -7,14 +7,20 @@ format: html
 
 ## Inleiding
 
-In dit hoofdstuk beschrijven we de meest basale vorm waarin Klimaatatlas kan worden gebruikt. Dit behelst het inladen van een SQLite database-bestand, een JSON-bestand (.json) met rekenregels en het laten doorrekenen van die regels.
+In dit hoofdstuk beschrijven we de meest basale vorm waarin Klimaatatlas kan worden gebruikt. Dit behelst het inladen van een configuratiebestand (.json). Na het inladen van de configuratie kunnen de regels worden doorgerekend.
+
+Het JSON-bestand bevat in essentie de volgende zaken:
+
+* Een specificatie van (klimaat)scenario's
+* Een verwijzing naar een Geopackage-bestand (.gpkg) wat de watervlakken van het gebied vertegenwoordigt
+* Definities van risicofactoren voor slechte waterkwaliteit en de onderliggende maatlatten en hun wegingsfactoren.
 
 Het resultaat van de analyse en berekeningen wordt door Klimaatatlas automatisch weggeschreven naar de Geopackage file. 
 
-Per risicofactor is dit:
+Voor risicofactor bestaat het rekenresultaat uit:
 
 * het risicogetal: een getal tussen 0 (geen risico) en 1 (maximaal risico)
-* voor elke maatlat die bijdroeg aan het risicogetal het percentuele aandeel in dat risico.
+* en voor elke maatlat die bijdroeg aan het risicogetal het percentuele aandeel in dat risico.
 
 ## Klimaatatlas opstarten
 
@@ -30,29 +36,6 @@ Na installatie kan het programma gevonden worden via het start-menu, onder de na
 :::
 :::
 
-## Een SQLite-database aanmaken
-
-::: {.columns}
-::: {.column width="50%"}
-* Indien u nog geen SQLite database heeft, maak er eentje aan via het menu 
-:::
-::: {.column width="50%"}
-![Bladeren naar het database-bestand.](img/dlg_database.png)
-:::
-:::
-
-## De SQLite-database selecteren
-
-::: {.columns}
-::: {.column width="50%"}
-* Klik op de button achter 'database file'
-* Blader naar de SQLite database (.db)
-:::
-::: {.column width="50%"}
-![Bladeren naar het database-bestand.](img/dlg_database.png)
-:::
-:::
-
 ## Het configuratiebestand inlezen
 
 ::: {.columns}
@@ -65,5 +48,17 @@ Na installatie kan het programma gevonden worden via het start-menu, onder de na
 :::
 :::
 
+## Berekening starten
+
+Door op de button 'Uitvoeren' te drukken wordt de berekening gestart. Voor ieder scenario zoals gespecificeerd in het JSON-bestand worden alle risicofactoren doorlopen en berekend. Iedere risicofactor is opgebouwd uit verschillende maatlatten met elk een wegingsfactor.
+
+De rekenresultaten worden weggeschreven naar het Geopackage (.gpkg) bestand. iedere risicofactor krijgt daarin een eigen kolom met het risicogetal (tussen 0 en 1) en iedere maatlat krijgt een eigen kolom met daarin de percentuele bijdrage (tussen 0 en 1) van die maatlat aan het berekende risicogetal.
+
+## Resultaten nabewerken
+
+Het aangepaste Geopackage-bestand kan worden ingeladen in de meeste GIS-programma's.
 
+* QGis biedt volledige ondersteuning
+* ArcGIS biedt ondersteuning mits de kolomnamen niet te lang zijn.
 
+ In GIS kunnen voor iedere resultaatkolom de watervlakken worden ingekleurd met een kleur als functie van de risicowaarde. Binnen het ontwikkelproject heeft Rijnland echter ook een eigen workflow ontwikkeld om de uitkomsten te kunnen publiceren in ArcGIS Online. 'link invoegen'.

Documentatie/Gebruikershandleiding/installatie.qmd

@@ -1,13 +1,13 @@
 ---
 title: "Klimaatatlas installeren"
 author: "Siebe Bosch"
-date: "`r Sys.Date()`"  # This will print the current date
+date: "`r format(Sys.Date(), '%B %d, %Y')`"  # This will print the current date in a more readable format
 format: html
 ---
 
 ## Stappenplan
 
-Het installatiebestand van Klimaatatlas versie 1.1.1 vindt u <a href="https://www.dropbox.com/s/t3k8o8cscxz6dso/KlimaatatlasSetup-v1.1.1-x64.zip?dl=0>hier</a>.
+Het installatiebestand van Klimaatatlas versie 1.2.0, inclusief voorbeeldbestanden, vindt u <a href="https://www.dropbox.com/scl/fi/96cz0e10j3xoodfcyyzif/KlimaatatlasSetup-v1.2.0-x64.zip?rlkey=4dvc8u8ws2c3rhb1qm4dgj2wu&dl=0>hier</a>.
 
 U installeert het programma door het bestand KlimaatatlasSetup-[versienummer]-x64.exe te starten.
 

Documentatie/_quarto.yml

@@ -21,6 +21,12 @@ website:
             text: "Klimaatatlas installeren"
           - href: gebruikershandleiding/basisgebruik.qmd
             text: "Basisgebruik"
+      - section: "Risicofactoren"
+        contents:
+          - href: risicofactoren/inleiding.qmd
+            text: "Inleiding"
+          - href: risicofactoren/biomassa.qmd
+            text: "Biomassa"
       - section: "Technische documentatie"
         contents:
           - href: technische_documentatie/configuratiebestand.qmd

Documentatie/risicofactoren/biomassa.qmd

@@ -0,0 +1,74 @@
+---
+title: "Risicofactor biomassa"
+author: "Siebe Bosch"
+date: "`r Sys.Date()`"  # This will print the current date
+format: html
+---
+
+## Inleiding
+
+De risicofactor 'biomassa' gaat onder meer over de hoeveelheid algen die de waterkwaliteit kan verslechteren. Deze hoeveelheid biomassa hangt af van allerlei factoren zoals: watertemperatuur en de aanwezigheid van vermestende stoffen. In dit hoofdstuk werken we deze risicofactor uit.
+
+## Maatlatten
+
+Voor 'biomassa' hebben we de volgende maatlatten onderscheiden:
+
+### Overschrijdingstemperatuur
+
+De gedachte achter overschrijdingstemperatuur als maatlat is dat er een temperatuur is waarbij algen maximaal groeien. Deze temperatuur ligt rond de 30 graden celcius. Bij 15 graden of lager is de algengroei minimaal, en ook boven de 45 graden komt hij tot stilstand.
+
+Als parameter nemen we de 'de watertemperatuur die gemiddeld één week per jaar wordt overschreden'. Deze temperatuur verschilt per waterlichaam. Voor dieper water zal de waarde lager liggen dan voor ondiepe sloten. In de voorbewerking hebben we voor ieder waterlichaam deze overschijdingstemperatuur Tex bepaald, als functie van de waterdiepte. 
+
+Het risicogetal van deze maatlat wordt berekend op basis van lineaire interpolatie tussen de volgende drie getalsparen:
+
+* 15 graden: risicogetal 0
+* 30 graden: risicogetal 1
+* 45 graden: risicogetal 0
+
+Als wegingsfactor voor de maatlat 'Overschrijdingstemperatuur' hanteren we de waarde 1.
+
+### Vermesting stikstof
+
+De aanwezigheid van nutriënten in de waterkolom vormen de drijvende kracht achter de groei van algen. Daarom hebben we ook de vermesting met stikstof meegenomen als maatlat. Als invoerparameter voor deze maatlat nemen we de 50-percentielwaarde van de stikstofconcentratie Nt uit het SOBEK-model van het hoogheemraadschap. Middels een uitgebreide voorbewerking hebben we deze concentraties weten te vertalen naar waarden in de watervlakkenkaart.
+
+Het risicogetal van deze maatlat wordt berekend op basis van lineaire interpolatie tussen de volgende twee getalsparen:
+
+* 0 mg/l: risicogetal 0
+* 15 mg/l: risicogetal 1
+
+Als wegingsfactor voor de maatlat 'Vermesting met stikstof' hanteren we de waarde 0.5 omdat er ook nog vermesting met fosfor bij komt.
+
+### Vermesting fosfor
+
+Ook de aanwezigheid van fosfor in de waterkolom veroorzaakt groei van algen. Net als bij stikstof nemen we vermesting met fosfor mee als maatlat. Invoerparameter is de 50-percentielwaarde van de fosforconcentratie Pt uit het SOBEK-model. Ook hier hebben we in de voorbewerkingen gezorgd dat de concentraties uit SOBEK naar de watervlakkenkaart konden worden geïnterpoleerd.
+
+Het risicogetal van deze maatlat wordt berekend op basis van lineaire interpolatie tussen de volgende twee getalsparen:
+
+* 0 mg/l: risicogetal 0
+* 1.5 mg/l: risicogetal 1
+
+Net als bij stikstof hanteren we als wegingsfactor voor deze maatlat de waarde 0.5.
+
+### Maximale hoeveelheid biomassa
+
+De hoeveelheid biomassa die een waterlichaam kan opnemen is een functie van de waterdiepte. Daarom passen we voor deze maatlat een transformatiefunctie toe op de waterdiepte van het waterlichaam. De formule voor deze transformatie luidt:
+
+maximale biomassa = 1683.6*EXP(-0.578*watediepte)
+
+Vervolgens berekenen we het risicogetal middels lineaire interpolatie tussen de volgende twee getalsparen:
+
+* 0: risicogetal 0
+* 1400: risicogetal 1
+
+Als wegingsfactor nemen we 1.
+
+## Weging
+
+Samenvattend berekenen we de risicofactor 'biomassa' op basis van de volgende maatlatten en hun wegingsfactoren:
+
+* Overschrijdingstemperatuur: wegingsfactor 1
+* Vermesting stikstof: wegingsfactor 0.5
+* Vermesting fosfor: wegingsfactor 0.5
+* Maximale biomassa: wegingsfactor 1
+
+

Documentatie/risicofactoren/inleiding.qmd

@@ -0,0 +1,14 @@
+---
+title: "Risicofactoren"
+author: "Siebe Bosch"
+date: "`r Sys.Date()`"  # This will print the current date
+format: html
+---
+
+## Inleiding
+
+In dit hoofdstuk werken we een aantal risicofactoren uit, samen met de maatlatten en hun wegingsfactoren.
+
+Deze risicofactoren moeten worden gezien als een vertrekpunt voor toepassingen in andere gebieden dan Rijnland; niet als een volwaardige implementatie die ongewijzigd overgenomen kan worden. Ieder gebied heeft zijn eigen karakteristieken en mogelijk andere factoren die belangrijk zijn bij het ontstaan van slechte waterkwaliteit.
+
+Bij het werken met de klimaatatlas is het de kunst om de juiste factoren te identificeren en hun onderlinge weegfactoren af te stemmen en daar kennis van het gebied en notoire knelpunten in mee te nemen.

Documentatie/technische_documentatie/configuratiebestand.qmd

@@ -1,6 +1,10 @@
 ## Configuratiebestand rekenregels
 
-Het configuratiebestand met de rekenregels (.json) vormt het hart van de applicatie. Hierin ligt vast welke risicoparameters voor waterkwaliteit worden berekend, van welke maatlatten die gebruik maken en welke weegfactoren gelden voor elke maatlat.
+Het configuratiebestand met de rekenregels (.json) vormt het hart van de applicatie. In dit bestand ligt vast:
+
+* welke risicoparameters voor waterkwaliteit worden berekend
+* van welke maatlatten die gebruik maken en
+* welke weegfactoren gelden voor elke maatlat.
 
 In dit hoofdstuk beschrijven we welke elementen het bestand bevat en aan welke voorwaarden die moeten voldoen.
 
@@ -62,6 +66,62 @@ Cruciaal is het bestand met watervlakken. Dit zijn immers de watergangen waarvoo
 ### Rekenregels
 
 Rekenregels is een array (lijst) van JSON-objecten waarvan elk element een unieke rekenregel beschrijft. 
-Onderstaand tonen we een voorbeeld
+Onderstaand tonen we een voorbeeld-rekenregel voor het risico op kroos.
+
+    {
+      "name": "kroos",
+	  "benchmarks":[
+		{
+			"name": "doodlopend",
+			"comment":"of het waterlichaam doodlopend is.",
+			"fieldname":[
+				{"scenario":"K2023", "field":"doodlopend"},
+				{"scenario":"K2050", "field":"doodlopend"},
+				{"scenario":"K2100", "field":"doodlopend"}
+			],
+			"classification": "discrete",
+			"classes": [
+				{"name": "nee", "value": 0}, 
+				{"name": "Null", "value": 0}, 
+				{"name": "ja", "value": 1}				
+			]
+		},
+		{
+			"name": "diepte",
+			"comment":"diepte van het waterlichaam.",
+			"fieldname":[
+				{"scenario":"K2023", "field":"waterdiept"},
+				{"scenario":"K2050", "field":"waterdiept"},
+				{"scenario":"K2100", "field":"waterdiept"}			
+			],
+			"classification": "continuous",
+			"valuesRange": [{"value":0,"verdict":1},{"value":1.5,"verdict":0}],
+		},
+	  ],
+      "resultsfield": "kroos",
+      "components": [
+        {"benchmark": "doodlopend", "weight": 1, "resultsfield": "kroos_doodl", "comment": "kroos, aandeel doodlopendheid watergang"},
+        {"benchmark": "diepte", "weight": 1, "resultsfield": "kroos_diep", "comment": "kroos, aandeel diepte watergang"}
+      ]
+    },
+
+In deze rekenregel is de naam van de risicofactor 'kroos'. In het voorbeeld wordt het risico op kroos bepaald door twee maatlatten:
+
+* doodlopendheid
+
+    Doodlopendheid is een discrete factor. De waarde "ja" wordt geïnterpreteerd als 'hoog risico' (waarde 1) en de waarde "nee" of een leeg veld als 'geen risico' (waarde 0).
+
+* waterdiepte
+
+    Waterdiepte is een traploze factor. Er wordt lineair geïnterpoleerd tussen de waterdieptes 0 en 1.5 m. Dit levert een risicowaarde tussen 0 en 1 op. 
+
+Het resultaat van de berekening wordt weggeschreven naar een kolom: scenario +'_' + _name_, bijvoorbeeld: K2023_kroos.Ook de bijdragen van de individuele componenten worden weggeschreven naar de Geopackage. De naamgeving van de kolommen wordt: scenario + '_' + _resultsfield_.
+
+Tot slot ligt vast naar welke dataset het resultaat moet worden weggeschreven:
+
+    "results": {
+        "dataset": "watervlakken"
+    }
+