Gea reforestation tool (#76)

* Add GEA doc * Update video file * Drawing tool manual * Suggested changes * Minor updates * Change the file name * Update complete-gea-re-afforestation.md (#41) * Add GEA doc * Update video file * Drawing tool manual * Update complete-gea-re-afforestation.md @ketankartoza see the update I made we need to just use the term reforestation instead or re-aforestation (we may need to update this in all the docs) also for nicfi, we need to call that recent imagery and not current imagery. the current imager is the google imagery in the layer list. --------- Co-authored-by: ketan <[email protected]> * Add reforestation tool manual * Update gea-reforestation-tool.md changes from afforestation to reforestation * Update GIFs * Add content update screenshots * Update screenshot --------- Co-authored-by: Amy B <[email protected]>
kartoza · Aug 29, 2024 · 2a0c03c · 2a0c03c
1 parent 0d7a54c
commit 2a0c03c
Show file tree

Hide file tree

Showing 14 changed files with 87 additions and 1 deletion.
diff --git a/docs/mkdocs-base.yml b/docs/mkdocs-base.yml
@@ -57,6 +57,7 @@ nav:
                           - Sign Up: user/manual/sign-up.md
                           - Login: user/manual/login.md
                           - GEA Reforestation: user/manual/gea-reforestation.md
+                          - GEA Reforestation Tool: user/manual/gea-reforestation-tool.md
                           - Image Style: user/manual/image-style.md
                           - Reports: user/manual/reports.md
                   - user/user-workflow.md

diff --git a/docs/src/user/manual/gea-reforestation-tool.md b/docs/src/user/manual/gea-reforestation-tool.md
@@ -0,0 +1,83 @@
+# GEA Reforestation Tool (Plugin) User Manual
+
+Welcome to the GEA Reforestation Tool user manual. This guide will help you navigate and utilise the tool to visualise historical imagery, access different landscape maps, and generate reports for potential reforestation sites.
+
+![GEA reforestation](./img/gea-reforestation-tool-1.png)
+
+1. **Time Slider:** Allows users to view selected imagery on the map canvas. Users can drag the toggle to the next or previous increment to view the corresponding imagery
+
+2. **Drawing Tool:** Allows users to draw polygons on the map canvas. Users can use the `Draw Project Area` button to draw a polygon. Users must provide site reference, project inception date, site reference version, author of site capture, and country before drawing the polygon.
+
+3. **Generate Report:** Click on the generate report button to generate an automated report.
+
+## Time Slider 
+
+**Slide Bar:** The slide bar allows users to view the selected imagery on the map canvas. The functionality of the slide bar depends on the checkbox selection:
+
+- **Historical Imagery (Landsat) Checkbox Checked:** The map canvas will display historical imagery from Landsat.
+
+![Historical Imagery](./img/gea-reforestation-tool-2.png)
+
+- **Recent Imagery (Nicfi) Checkbox Checked:** The map canvas will display recent imagery from NICFI.
+
+![Recent Imagery](./img/gea-reforestation-tool-3.png)
+
+The user can use the slide bar by dragging the toggle to the next or previous increment to view the corresponding imagery on the map canvas.
+
+**Play Button:** The play button allows users to play through the selected imagery. This feature is useful for visualising changes in the landscape over time.
+
+**Frame Rate:** allows users to set the frame rate to a larger or smaller number to play through the images quicker or slower respectively
+
+**Loop Checbox:** This checkbox allows the user to continuously loop through the selected images.
+
+****Current Time Range:** Current time range shows the year and month of the image being shown on the map canvas.
+
+**Historical Imagery**
+
+![Historical Imagery play](./img/HistoricalLandsat.gif)
+
+**Recent Imagery**
+
+![Recent Imagery play](./img/Nicfi.gif)
+
+## Drawing tool
+
+The user can use the drawing tool to draw polygons on the map canvas.
+
+![Drawing tool](./img/gea-reforestation-tool-5.png)
+
+5.1 **Draw Project Area Button:** The user can use this button to draw the polygon on the map canvas. Before using the `Draw Project Area` button, ensure that the site reference has been provided. After drawing the polygon right-click. Upon clicking the pop-up will open for entering the ID, ID should be 1.
+
+![Id popup](./img/gea-reforestation-tool-9.png)
+
+- **Error Handling:** If any of the fields is empty, an error message will be displayed for example for the site reference field the message would be: `Please add the site reference before starting drawing the project area.`
+
+    ![Error message](./img/gea-reforestation-tool-4.png)
+
+- **Editing:** After drawing the polygon, you can edit it using the options available in the toolbar. The edit icon will appear in front of the project in the layer list, allowing modifications before saving.
+
+    ![Edit options](./img/gea-reforestation-tool-6.png)
+
+5.2 **Project Inception Date:** To choose the project inception date, click on the field to open a calendar. Select the desired date from the calendar interface.
+
+![Calander](./img/gea-reforestation-tool-7.png)
+
+5.3 **Site Reference:** Enter the site reference to identify the specific location or area for the project.
+
+5.4 **Version of the Site Reference:** Add the version number corresponding to the site reference for version control and tracking.
+
+5.5 **Author of the Site Capture:** Enter the name of the individual who captured or recorded the site details.
+
+5.6 **Country Dropdown:** Choose the country from the dropdown list to specify the location of the project.
+
+5.7 **Project Folder:** Select the project folder where plugin data is stored. The shape files will be saved in the `Sites` directory, which is automatically generated when you save the project.
+
+![Sites directory](./img/gea-reforestation-tool-8.png)
+
+5.8 **Save Project Area Button:** Click the `Save Project Area` button to save the project after drawing the polygon. The shape files will be stored in the `Sites` directory.
+
+5.9 **Clear Button:** Use the `Clear` button to remove the polygon from the map. Note that the polygon must be cleared before saving the project, as shape files stored in the sites folder will not be deleted after saving.
+
+## Automated Report
+
+Click on the generate report button to generate an automated report.
diff --git a/docs/src/user/manual/img/HistoricalLandsat.gif b/docs/src/user/manual/img/HistoricalLandsat.gif
diff --git a/docs/src/user/manual/img/Nicfi.gif b/docs/src/user/manual/img/Nicfi.gif
diff --git a/docs/src/user/manual/img/gea-reforestation-tool-1.png b/docs/src/user/manual/img/gea-reforestation-tool-1.png
diff --git a/docs/src/user/manual/img/gea-reforestation-tool-2.png b/docs/src/user/manual/img/gea-reforestation-tool-2.png
diff --git a/docs/src/user/manual/img/gea-reforestation-tool-3.png b/docs/src/user/manual/img/gea-reforestation-tool-3.png
diff --git a/docs/src/user/manual/img/gea-reforestation-tool-4.png b/docs/src/user/manual/img/gea-reforestation-tool-4.png
diff --git a/docs/src/user/manual/img/gea-reforestation-tool-5.png b/docs/src/user/manual/img/gea-reforestation-tool-5.png
diff --git a/docs/src/user/manual/img/gea-reforestation-tool-6.png b/docs/src/user/manual/img/gea-reforestation-tool-6.png
diff --git a/docs/src/user/manual/img/gea-reforestation-tool-7.png b/docs/src/user/manual/img/gea-reforestation-tool-7.png
diff --git a/docs/src/user/manual/img/gea-reforestation-tool-8.png b/docs/src/user/manual/img/gea-reforestation-tool-8.png
diff --git a/docs/src/user/manual/img/gea-reforestation-tool-9.png b/docs/src/user/manual/img/gea-reforestation-tool-9.png
diff --git a/docs/src/user/manual/index.md b/docs/src/user/manual/index.md
@@ -22,6 +22,8 @@ you may prefer to work through our [user guide](../guide/index.md).
 
 * **[GEA Reforestation:](gea-reforestation.md)** This documentation provides detailed instructions on what to do with the shared project and how to open it with QGIS also explains some useful options that users can use in the QGIS.
 
-* **[Image Style:](Image-style.md)** This page will show how the user can style the image for a better experience.
+* **[GEA Reforestation Tool:](gea-reforestation-tool)** This documentation will explain how to user the plugin.
+
+* **[Image Style:](Image-style.md)** This page will show how the user can style the image for the better experience.
 
 * **[Reports:](reports.md)** This page will show how the user can generate the reports.