diff --git a/docs/src/user/guide/about.md b/docs/src/user/guide/about.md index 3b86b907..76c59571 100644 --- a/docs/src/user/guide/about.md +++ b/docs/src/user/guide/about.md @@ -49,12 +49,6 @@ The Goal section outlines the primary objective of the platform, providing you w [![Impact Report](./img/guide-about-img-4.png)](https://arw.dev.do.kartoza.com/static/CSA-Impact-report-11-04-23_hi-res.pdf) -#### Contact Us - -To contact the ARW team, use the contact us form. Fill in the required details in the 1️⃣ `Form` and click the 2️⃣ `Submit` button to send your message. - -[![Contact Us](./img/guide-about-img-5.png)](./img/guide-about-img-5.png) - ## Conversation ## Learn More @@ -65,4 +59,4 @@ The aim of this joint initiative of Conservation International and Peace Parks F ### Pamphlet -Herding for Health [Pamphlet](https://arw.dev.do.kartoza.com/static/Herding.for.Health.pdf). \ No newline at end of file +Herding for Health [Pamphlet](https://arw.dev.do.kartoza.com/static/Herding.for.Health.pdf). diff --git a/docs/src/user/guide/img/guide-about-img-5.png b/docs/src/user/guide/img/guide-about-img-5.png deleted file mode 100644 index 17972ef6..00000000 Binary files a/docs/src/user/guide/img/guide-about-img-5.png and /dev/null differ diff --git a/docs/src/user/guide/img/guide-map-img-19.png b/docs/src/user/guide/img/guide-map-img-19.png new file mode 100644 index 00000000..b1e8d549 Binary files /dev/null and b/docs/src/user/guide/img/guide-map-img-19.png differ diff --git a/docs/src/user/guide/img/guide-map-img-2.png b/docs/src/user/guide/img/guide-map-img-2.png index 81df37d3..b5c20711 100644 Binary files a/docs/src/user/guide/img/guide-map-img-2.png and b/docs/src/user/guide/img/guide-map-img-2.png differ diff --git a/docs/src/user/guide/img/guide-map-img-20.png b/docs/src/user/guide/img/guide-map-img-20.png new file mode 100644 index 00000000..ac9b753b Binary files /dev/null and b/docs/src/user/guide/img/guide-map-img-20.png differ diff --git a/docs/src/user/guide/img/guide-map-img-21.png b/docs/src/user/guide/img/guide-map-img-21.png new file mode 100644 index 00000000..bf050e1b Binary files /dev/null and b/docs/src/user/guide/img/guide-map-img-21.png differ diff --git a/docs/src/user/guide/img/guide-map-img-22.png b/docs/src/user/guide/img/guide-map-img-22.png new file mode 100644 index 00000000..d2d9582f Binary files /dev/null and b/docs/src/user/guide/img/guide-map-img-22.png differ diff --git a/docs/src/user/guide/img/guide-map-img-23.png b/docs/src/user/guide/img/guide-map-img-23.png new file mode 100644 index 00000000..30781baa Binary files /dev/null and b/docs/src/user/guide/img/guide-map-img-23.png differ diff --git a/docs/src/user/guide/img/guide-map-img-3.png b/docs/src/user/guide/img/guide-map-img-3.png index a5b28acf..5ea1a4d0 100644 Binary files a/docs/src/user/guide/img/guide-map-img-3.png and b/docs/src/user/guide/img/guide-map-img-3.png differ diff --git a/docs/src/user/guide/img/guide-map-img-4.png b/docs/src/user/guide/img/guide-map-img-4.png index 738b43e1..5e8efbfa 100644 Binary files a/docs/src/user/guide/img/guide-map-img-4.png and b/docs/src/user/guide/img/guide-map-img-4.png differ diff --git a/docs/src/user/guide/map.md b/docs/src/user/guide/map.md index 07e04825..c7ec594c 100644 --- a/docs/src/user/guide/map.md +++ b/docs/src/user/guide/map.md @@ -80,6 +80,12 @@ Bare ground cover refers to the proportion of the landscape where the surface is [![Bare Grounds Cover](./img/guide-map-img-16.png)](./img/guide-map-img-16.png) +### User Defined + +By clicking on this `User Defined` dropdown menu you will be able to view the shape files you have uploaded here. + +[![User Defined Shape Files](./img/guide-map-img-23.png)](./img/guide-map-img-23.png) + ### Analysis? Analysis allows you to select specific landscape from the 1️⃣ `Select Landscape` drop down menu. @@ -94,11 +100,12 @@ Available options in `Select analysis type` are: #### How to do Baseline Analysis? -* **Baseline:** After selecting this option you have to select the polygons from the map and then you can go for the analysis. +* **Baseline:** After selecting this option you have to select the polygons from the map and then you can go for the analysis. To see the process of how to select the polygon click [here](#how-to-select-polygon) #### How to do Temporal Analysis? -* **Temporal:** After selecting the temporal you will be able to select to the following options: +* **Temporal:** After selecting the temporal you will be able to select the following options: + - **Select temporal resolution:** You can choose whether to use the `Annual` or `Quarterly` option based on their preference. - **Select variable:** You can choose the variable they want to analyse from the available options. @@ -109,9 +116,11 @@ Available options in `Select analysis type` are: [![Temporal Analysis Type](./img/guide-map-img-7.png)](./img/guide-map-img-7.png) + - After filling in the form, select the polygon from the map and then you can go for the analysis. To see the process of how to select the polygon click [here](#how-to-select-polygon) + #### How to do Spatial Analysis? -* **Spatial:** After selecting this option, you can choose a specific variable. Next, you need to select a polygon from the map. Once the selections are made, you can proceed with the analysis. +* **Spatial:** After selecting this option, you can choose a specific variable. Next, you need to select a polygon from the map. Once the selections are made, you can proceed with the analysis. To see the process of how to select the polygon click [here](#how-to-select-polygon) [![Spatial Analysis Type](./img/guide-map-img-8.png)](./img/guide-map-img-8.png) @@ -119,10 +128,20 @@ Available options in `Select analysis type` are: * **BACI:** This option allows you to directly go for analysis by clicking on the `Run Analysis` button. - [![Spatial Analysis Type](./img/guide-map-img-8.png)](./img/guide-map-img-8.png) + [![BACI](./img/guide-map-img-19.png)](./img/guide-map-img-19.png) After filling in the necessary details, you can proceed with the analysis by clicking on the 3️⃣ `Run Analysis` button. If you wish to reset the form, simply click on the 2️⃣ `Reset Form` button. +The `Reset Form` button will reset the form to its default state, including the selected polygon. + +[![Reset Form](./img/guide-map-img-22.png)](./img/guide-map-img-22.png) + +#### Statistics + +This is the report generated after running the analysis. It contains the results of the analysis. + +[![Statistics](./img/guide-map-img-21.png)](./img/guide-map-img-21.png) + ### How to Upload Shape File Click on the 1️⃣ `Upload` button and then click on the 2️⃣ `Select File` button to upload your shape file. @@ -132,3 +151,9 @@ Click on the 1️⃣ `Upload` button and then click on the 2️⃣ `Select File` Select the desired 1️⃣ `File` then click on the 2️⃣ `Select` button to upload the file or can click on the 3️⃣ `Cancel` button to close the file explorer. [![File Explorer](./img/guide-map-img-18.png)](./img/guide-map-img-18.png) + +### How to Select Polygon + +To select the polygon for the analysis, you first need to select the land from the 1️⃣ `Landscape` dropdown menu. This will zoom you into the landscape, and then you can select the polygon by simply clicking on the 2️⃣ `polygon`. You can also see the location of the polygon in the 3️⃣ `description` to recognise whether the polygon is situated in the northern, eastern, western, or southern part of the landscape. + +[![Select Polygon](./img/guide-map-img-20.png)](./img/guide-map-img-20.png) diff --git a/docs/src/user/manual/about.md b/docs/src/user/manual/about.md index 06009c25..3d5720cb 100644 --- a/docs/src/user/manual/about.md +++ b/docs/src/user/manual/about.md @@ -55,24 +55,6 @@ The Goal section outlines the primary objective of the platform, providing users [![Impact Report](./img/about-img-8.png)](https://arw.dev.do.kartoza.com/static/CSA-Impact-report-11-04-23_hi-res.pdf) -#### Contact Us - -Contact us section allows users to get in touch with the team behind the platform. - -[![Contact Us](./img/about-img-6.png)](./img/about-img-6.png) - -* **First Name:** Users can enter their first name. - -* **Last Name:** Users can enter their last name - -* **Email:** Users verified email address. - -* **Organisation:** The details about the organisation that wishes to contact the platform. - -* **Additional Details:** Users can enter any additional details they wish to share with the platform. - -* **Submit:** By clicking on this button user will bw able to submit their contact information to the platform. - ## Conversation ## Learn More diff --git a/docs/src/user/manual/img/about-img-6.png b/docs/src/user/manual/img/about-img-6.png deleted file mode 100644 index ac0b2c09..00000000 Binary files a/docs/src/user/manual/img/about-img-6.png and /dev/null differ diff --git a/docs/src/user/manual/img/manual-map-img-14.png b/docs/src/user/manual/img/manual-map-img-14.png index a124f113..0d3cefe2 100644 Binary files a/docs/src/user/manual/img/manual-map-img-14.png and b/docs/src/user/manual/img/manual-map-img-14.png differ diff --git a/docs/src/user/manual/img/manual-map-img-2.png b/docs/src/user/manual/img/manual-map-img-2.png index 41c3ab53..a6db396d 100644 Binary files a/docs/src/user/manual/img/manual-map-img-2.png and b/docs/src/user/manual/img/manual-map-img-2.png differ diff --git a/docs/src/user/manual/img/manual-map-img-24.png b/docs/src/user/manual/img/manual-map-img-24.png new file mode 100644 index 00000000..f3d26f37 Binary files /dev/null and b/docs/src/user/manual/img/manual-map-img-24.png differ diff --git a/docs/src/user/manual/img/manual-map-img-25.png b/docs/src/user/manual/img/manual-map-img-25.png new file mode 100644 index 00000000..1065b8c4 Binary files /dev/null and b/docs/src/user/manual/img/manual-map-img-25.png differ diff --git a/docs/src/user/manual/img/manual-map-img-26.png b/docs/src/user/manual/img/manual-map-img-26.png new file mode 100644 index 00000000..7da07af3 Binary files /dev/null and b/docs/src/user/manual/img/manual-map-img-26.png differ diff --git a/docs/src/user/manual/img/manual-map-img-27.png b/docs/src/user/manual/img/manual-map-img-27.png new file mode 100644 index 00000000..45b69a95 Binary files /dev/null and b/docs/src/user/manual/img/manual-map-img-27.png differ diff --git a/docs/src/user/manual/img/manual-map-img-28.png b/docs/src/user/manual/img/manual-map-img-28.png new file mode 100644 index 00000000..de20f76a Binary files /dev/null and b/docs/src/user/manual/img/manual-map-img-28.png differ diff --git a/docs/src/user/manual/img/manual-map-img-3.png b/docs/src/user/manual/img/manual-map-img-3.png index f5fb6d72..bc175979 100644 Binary files a/docs/src/user/manual/img/manual-map-img-3.png and b/docs/src/user/manual/img/manual-map-img-3.png differ diff --git a/docs/src/user/manual/img/manual-map-img-4.png b/docs/src/user/manual/img/manual-map-img-4.png index d925b41e..16672074 100644 Binary files a/docs/src/user/manual/img/manual-map-img-4.png and b/docs/src/user/manual/img/manual-map-img-4.png differ diff --git a/docs/src/user/manual/map.md b/docs/src/user/manual/map.md index 23ee3703..73a0451d 100644 --- a/docs/src/user/manual/map.md +++ b/docs/src/user/manual/map.md @@ -69,6 +69,8 @@ license: This program is free software; you can redistribute it and/or modify it [![Bare Ground Cover](./img/manual-map-img-21.png)](./img/manual-map-img-21.png) + **3. User Defined:** allows users to view the shape files they have uploaded. Users can also apply their shape files onn the checking the corresponding checkbox. + 2. **Analysis:** This section allows users to perform analyses based on various conditions and run the analysis on the map to visualise the results. [![Analysis Section](./img/manual-map-img-5.png)](./img/manual-map-img-5.png) @@ -77,35 +79,43 @@ license: This program is free software; you can redistribute it and/or modify it [![Analysis Type](./img/manual-map-img-6.png)](./img/manual-map-img-6.png) - * Analysis type allows to select the type of analysis to be performed. The available options are: + * When users select a landscape, the map zooms into the selected area. From there, they can choose a polygon on the map to run the desired analysis. + + - **For example:** + + - If a user selects `Bahine NP` from the landscape drop-down menu, they will automatically be zoomed into that location on the map, eliminating the need to navigate to it manually. + + [![Bahine NP](./img/manual-map-img-24.png)](./img/manual-map-img-24.png) - **1. Baseline:** Baseline describes a 5-year (and in some cases longer) average of each variable. Baseline variables are visible at the whole extent of southern Africa. After this user have to select the polygon from the map. + **2. Select analysis type:** Analysis type allows to select the type of analysis to be performed. The available options are: - **2. Temporal:** Temporal analysis gives users greater control over the time period they wish to examine. After selecting this option, users can access additional settings. + **1. Baseline:** Baseline describes a 5-year (and in some cases longer) average of each variable. Baseline variables are visible at the whole extent of southern Africa. After this user have to select the polygon from the map. - [![Temporal Type](./img/manual-map-img-7.png)](./img/manual-map-img-7.png) + **2. Temporal:** Temporal analysis gives users greater control over the time period they wish to examine. After selecting this option, users can access additional settings. - **1. Select temporal resolution:** This option enables users to customise the time period by selecting either an Annual or Quarterly timeframe, based on users needs. + [![Temporal Type](./img/manual-map-img-7.png)](./img/manual-map-img-7.png) - **2. Select variables:** variables are those that are used to compute temporal and spatial statistics for different areas within the app. + **1. Select temporal resolution:** This option enables users to customise the time period by selecting either an Annual or Quarterly timeframe, based on users needs. - [![Variables](./img/manual-map-img-8.png)](./img/manual-map-img-8.png) + **2. Select variables:** variables are those that are used to compute temporal and spatial statistics for different areas within the app. - - **EVI:** The Enhanced Vegetation Index (EVI) is a satellite-derived metric used to measure vegetation health, greenness, and biomass. + [![Variables](./img/manual-map-img-8.png)](./img/manual-map-img-8.png) - - **NDVI:** The Normalised Difference Vegetation Index (NDVI) is similar to the Enhanced Vegetation Index (EVI) but is more sensitive to sparse vegetation, making it ideal for monitoring arid regions with low vegetation greenness. + - **EVI:** The Enhanced Vegetation Index (EVI) is a satellite-derived metric used to measure vegetation health, greenness, and biomass. - - **Bare ground cover:** Bare ground cover refers to the proportion of the landscape where the surface is exposed without significant vegetation, such as grass or woody plants. These areas may consist of soil, sand, or rock and are important in ecological assessments as they affect processes like erosion, water infiltration, and habitat stability. + - **NDVI:** The Normalised Difference Vegetation Index (NDVI) is similar to the Enhanced Vegetation Index (EVI) but is more sensitive to sparse vegetation, making it ideal for monitoring arid regions with low vegetation greenness. - - After selecting the variable, user will be able to select the time period. + - **Bare ground cover:** Bare ground cover refers to the proportion of the landscape where the surface is exposed without significant vegetation, such as grass or woody plants. These areas may consist of soil, sand, or rock and are important in ecological assessments as they affect processes like erosion, water infiltration, and habitat stability. - [![Temporal Type](./img/manual-map-img-9.png)](./img/manual-map-img-9.png) + - After selecting the variable, user will be able to select the time period. - **1. Select reference period:** This option allows users to choose a reference period for comparison. After this user will be able to select comparison period. + [![Temporal Type](./img/manual-map-img-9.png)](./img/manual-map-img-9.png) - **2. Select comparison period:** This option allows users to choose a comparison period for comparison with the reference period. + **1. Select reference period:** This option allows users to choose a reference period for comparison. After this user will be able to select comparison period. - **3. Select quarter:** Allows users to select the specific quarter of the year. This option is only available when the temporal resolution is set to quarterly. + **2. Select comparison period:** This option allows users to choose a comparison period for comparison with the reference period. + + **3. Select quarter:** Allows users to select the specific quarter of the year. This option is only available when the temporal resolution is set to quarterly. **3. Spatial:** After selecting this option, the user can choose the desired variable, select a polygon from the map, and proceed to run the analysis. @@ -113,9 +123,27 @@ license: This program is free software; you can redistribute it and/or modify it **4. BACI:** BACI (Before-After-Control-Impact) evaluates land management effects by comparing changes over time between impacted and control areas. - **5. Run Analysis:** After selecting the desired analysis type, users can proceed to run the analysis by clicking the Run Analysis. + **5. Run Analysis:** Users are required to select the polygon before running the analysis. + + * **Select polygon:** To select a polygon, users need to click on the desired polygon after choosing the landscape. Users can only select one polygon at a time. + + [![Polygons](./img/manual-map-img-25.png)](./img/manual-map-img-25.png) + + **1 Landscape:** For example, we have selected the `Bahine NP` landscape. + + **2 Polygons:** The highlighted area displays the available polygons within the selected landscape. + + **3 Click polygon the map:** This description provides users with the location of the polygon, specifying whether it is situated in the eastern, northern, western, or southern section of the landscape. + + [![Polygons 2](./img/manual-map-img-26.png)](./img/manual-map-img-26.png) + + * After successfully running the analysis, the user will be able to view the results in the statistics pop up. The `Statistics` table provides quantitative data for the selected polygon. It includes the following columns: Name, EVI, and Bare Ground % etc. + + [![Statistics](./img/manual-map-img-27.png)](./img/manual-map-img-27.png) + + **6. Reset From:** This option allows users to reset the form to its default state, including the selected polygon. - **6. Reset From:** This option allows users to reset the analysis to its default state. + [![Map](./img/manual-map-img-28.png)](./img/manual-map-img-28.png) 3. **Upload:** Users can upload their own data to the app for analysis. This feature is useful for users who have their own data and want to perform analysis on it. Click on this `Upload` button to upload the shape file.