Skip to content

Commit

Permalink
Added project instance and attribute table docs (#111)
Browse files Browse the repository at this point in the history
  • Loading branch information
ketankartoza authored Oct 20, 2024
1 parent e1eeeb8 commit cd434bf
Show file tree
Hide file tree
Showing 24 changed files with 120 additions and 45 deletions.
34 changes: 27 additions & 7 deletions docs/src/user/guide/gea-reforestation-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,6 @@ This tutorial will walk you through using the `Drawing Tool` to create project a

## How to import project instance


**Accessing Import project instance:** Click on the 1️⃣ `Import project instance` on the qgis interface.

![Image Project Instance](./img/gea-reforestation-tool-16.png)
Expand All @@ -200,23 +199,44 @@ After selecting the desired project instance, a `Project Instance Attributes` po
* **No:** Cancel the process.
* **Yes:** Overwrite names.

After saving the instance, your selected instance will be added to the project instance in the layer section.
## Project Instances

After importing the project instances or drawing them manually, they will be added to the `Project Instances` group within the `Layers` section.

![Import Project Instances](./img/gea-reforestation-tool-19.png)

### Attribute table

The attribute table contains information about the project instances, including the farmer's ID and other relevant details associated with the land. This table provides an organised view of all the data linked to each farmer and their land.

* To open the attribute table right click on the project instance and choose 1️⃣ `Open Attribute Table` from the menu.

![Attribute table](./img/gea-reforestation-tool-24.png)

* The attribute table will look like this.

![Attribute Table Details](./img/gea-reforestation-tool-25.png)

* The attribute table includes several key details such as the farmer's ID, author ID, project country, area of the land (rounded to two decimal places), and the date of inception. This data provides a comprehensive overview of each project instance and its associated attributes.

## Automated Report Generation

![Report](./img/gea-reforestation-tool-13.png)

**Generating an Automated Report:** After drawing and saving your project area, click on the 1️⃣ `Generate Report` button, upon clicking the button report generation process will start and the pop-up window will open, showing the status of the process.
**Generating an Automated Report:** After drawing and saving your project area, click on the 1️⃣ `Generate Report` button, upon clicking the button report generation process will start and the pop-up window `Report Progress` will open, showing the status of the process.

![Report Progress Dialog](./img/gea-reforestation-tool-21.png)

* **Close:** Close the dialog to continue working on your project.
* **Open PDF:** Open the generated report PDF in a new pop-up window (Shown below).
* **Cancel:** Close the dialog to continue working on your project.
* **Open reports folder:** Open the folder that contains all the generated reports along with the file which contains land location.

![Report PDF](./img/gea-reforestation-tool-22.png)
![Report Folder](./img/gea-reforestation-tool-23.png)

By following these steps, you will be able to effectively use the Drawing Tool to define your project areas and generate automated reports for the GEA Reforestation project.
* The report will be generated based on the farmer's ID. If there are multiple farmers, the system will generate individual reports for each farmer.

* Double-click on any report to open it.

![Report PDF](./img/gea-reforestation-tool-22.png)

By following these steps, you will be able to effectively use the Drawing Tool to define your project areas and generate automated reports for the GEA Reforestation project.

15 changes: 12 additions & 3 deletions docs/src/user/guide/gea-reforestation.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,9 @@ The folder should contain the following components:

You can use the `Layers` panel to visualise and interact with the various layers in the project. In the Layers panel, you will see the following layers listed:

- Malawi 2 Area of Interest
- Project Instances
- Malawi 2 Buffer
- Malawi 2 Area of Interest
- Proposed Site Boundaries
- Administrative Areas (Malawi 2 Country, Malawi 2 District, Malawi 2 Sub-divisional Administrative Unit)
- Exclusion Masks (Grass, Wetland, Forest, Soil Carbon)
Expand All @@ -96,14 +97,22 @@ You can use the `Layers` panel to visualise and interact with the various layers

![Malavi 2](./img/gea-reforestation-9.png)

**Malawi 2 Area of Interest:**
**Project Instances:**

- Check the `Malawi 2 Area of Interest` checkbox to visualise the area of interest on the map canvas. You will see a black line outlining the area.
- `Project Instances` This layer contains all the project instances the user has drawn on the canvas, including the imported ones.

- Check the instance checkbox to visualise the instance on the map.

![Project Instances](./img/gea-reforestation-14.png)

**Malawi 2 Buffer:**

- Check the `Malawi 2 Buffer` checkbox to visualise the buffer area around the Malawi 2 area of interest. You will see a yellow line on the map canvas.

**Malawi 2 Area of Interest:**

- Check the `Malawi 2 Area of Interest` checkbox to visualise the area of interest on the map canvas. You will see a black line outlining the area.

**Proposed Site Boundaries:**

- Check the `Proposed Site Boundaries` checkbox to display the proposed boundaries created by the user for the project. You will see red lines on the map canvas representing the proposed boundaries.
Expand Down
Binary file added docs/src/user/guide/img/gea-reforestation-14.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/user/guide/img/gea-reforestation-8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/user/guide/img/gea-reforestation-9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/user/guide/img/gea-reforestation-tool-21.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/user/guide/img/gea-reforestation-tool-22.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
63 changes: 48 additions & 15 deletions docs/src/user/manual/gea-reforestation-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,37 +115,70 @@ After selecting the desired project instance user will click on the `open` butto
* **No:** Cancel the process.
* **Yes:** Overwrite names.

After saving the instance, the selected instance will be added to the project instances in the layer section.
## Project Instances

After importing the project instances or drawing them manually, they will be added to the `Project Instances` group within the `Layers` section.

![Qgis Interface](./img/gea-reforestation-tool-12.png)


### Attribute Table

The attribute table contains information about the project instances, including the farmer's ID and other relevant details associated with the land. This table provides an organized view of all the data linked to each farmer and their land.

* To open the attribute table right click on the project instance and choose 1️⃣ `Open Attribute Table` from the menu.

![Attribute table](./img/gea-reforestation-tool-18.png)

* The attribute table will look like this.

![Attribute Table Details](./img/gea-reforestation-tool-19.png)

* These are the major details in the attribute table, associated with each farmer's ID.

![Major Elements of Table](./img/gea-reforestation-tool-20.png)

**1. author:** ID of the associated author.

**2. project:** Country of the project.

**3. IncepDate:** Date when the project started.

**4. area(ha):** Area of the land in hectares (rounded to 2 decimal places).

## Automated Report

![Generate Report](./img/gea-reforestation-tool-14.png)

1. **Generate Report:** Click on the `Generate Report` button to generate an automated report.

After clicking the `Generate Report` button **Site Report Progress** pop-up window will appear displaying the status of the report.
After clicking on the 1️⃣ `Generate Report`, a `Report Progress` pop-up window will appear, showing the current status of the report generation process.

![Site Report Progress](./img/gea-reforestation-tool-15.png)

* **Progress Bar:** Displaying the current status of the process.
* **Close:** Cancel the process.
* **Open PDF:** Open the PDF in a new pop-up window.
* **cancel:** Cancel the process.
* **Open reports folder:** Open the folder that contains all the generated reports along with the file which contains land location.

![Report Folder](./img/gea-reforestation-tool-17.png)

* The report will be generated based on the farmer's ID. If there are multiple farmers, the system will generate individual reports for each farmer.

* Double-click on any report to open it.

## Generated Report

## Generated Report
This is the report generated after completing the process.

This is the report generated after completing the process.
![Generated Report](./img/gea-reforestation-tool-16.png)

![Generated Report](./img/gea-reforestation-tool-16.png)
1. **Area Eligibility:** Displaying the ID of the farmer.
- **Date of Project Inception:** The date when the project started.
- **Project:** The name of the country.
- **Report Author:** The person who captured the site.
- **Total Area:** The area of the site.

1. **Area Eligibility:** Displaying the ID of the farmer.
- **Date of Project Inception:** The date when the project started.
- **Project:** The name of the country.
- **Report Author:** The person who captured the site.
- **Total Area:** The area of the site.
2. **Project Instance Sites:** Displaying the site location on the map.

2. **Project Instance Sites:** Displaying the site location on the maps.
3. **Landscape Exclusion and Inclusion Areas:** Displaying the Historical Landsat 2013 with and without exclusion masks and the proposed site.

3. **Landscape Exclusion and Inclusion Areas:** Displaying the Historical Landsat 2013 with and without exclusion masks and the
proposed site.
53 changes: 33 additions & 20 deletions docs/src/user/manual/gea-reforestation.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,52 +52,65 @@ license: the reforestation tool is made available to Global Evergreening Global

The map navigation toolbar offers many options, some of which are:

1. **Pan:** Allows the user to pan the map to a specific location.
2. **Zoom in:** Zooms in on the map to show more detail.
3. **Zoom out:** Zooms out of the map to show a wider area.
4. **Full zoom:** Zooms in or out to the maximum extent.
5. **Show map tips:** Displays additional information about the map, such as coordinates and scale.
**1. Pan:** Allows the user to pan the map to a specific location.

**2. Zoom in:** Zooms in on the map to show more detail.

**3. Zoom out:** Zooms out of the map to show a wider area.

**4. Full zoom:** Zooms in or out to the maximum extent.

**5. Show map tips:** Displays additional information about the map, such as coordinates and scale.

3.3 **Digitising Toolbar:**

![Vector toolbar](./img/gea-reforestation-8.png)

The digitising toolbar offers many options, some of which are:

1. **Current edits:** Displays the current editing state of the layer.
2. **Toggle editing:** Toggles the editing mode on or off.
3. **Save layer edits:** Saves any changes made to the layer.
4. **Add polygon feature:** Creates a new polygon feature on the map.
**1. Current edits:** Displays the current editing state of the layer.

**2. Toggle editing:** Toggles the editing mode on or off.

**3. Save layer edits:** Saves any changes made to the layer.

**4. Add polygon feature:** Creates a new polygon feature on the map.

### 3.4 Layer List

The user can use the QGIS project with emphasis on the Layers List panel to contextualise and review the area of interest. The Layers List for all of the areas of interest (`Malawi 2` shown here) includes the following:

![Layers List](./img/layer-list-1.png)

- Malawi 2 Area of Interest
- Project Instances
- Malawi 2 Buffer
- Malawi 2 Area of Interest
- Proposed Site Boundaries
- Gea Afforestation Tool-Malawi 2
- Administrative Areas
- Exclusion Masks
- Current Google Imagery
- Recent NICFI Imagery
- Historical Landsat Imagery

1. **Malawi 2 Area of Interest:** Check the `Malawi 2 Area of Interest` checkbox to visualise the area of interest, it will be shown on the map canvas with a black line.
**1. Project Instances:** This layer contains all the project instances the user has drawn on the canvas, including the imported ones.

![Area of interest](./img/layer-list-2.png)
- Check the instance `checkbox` to visualise the instance on the map.

![Project Instances](./img/layer-list-19.png)

2. **Malawi 2 Buffer:** Check the `Malawi 2 Buffer` checkbox to visualise the buffer area, it will be shown on the map canvas with a yellow line.
**2. Malawi 2 Buffer:** Check the `Malawi 2 Buffer` checkbox to visualise the buffer area, it will be shown on the map canvas with a yellow line.

![Buffer](./img/layer-list-3.png)

3. **Proposed Site Boundaries:** Displays the proposed boundaries created by the user for the project. Check the `Proposed Site Boundaries` checkbox and the proposed boundaries will be shown on the map canvas with a red line.
**3. Malawi 2 Area of Interest:** Check the `Malawi 2 Area of Interest` checkbox to visualise the area of interest, it will be shown on the map canvas with a black line.

![Area of interest](./img/layer-list-2.png)

**4. Proposed Site Boundaries:** Displays the proposed boundaries created by the user for the project. Check the `Proposed Site Boundaries` checkbox and the proposed boundaries will be shown on the map canvas with a red line.

![Proposed boundaries](./img/layer-list-4.png)

4. **Administrative Areas:** This includes three options with checkboxes that allow users to visualise different administrative areas on the map canvas.
**5. Administrative Areas:** This includes three options with checkboxes that allow users to visualise different administrative areas on the map canvas.

![Administrative areas](./img/layer-list-5.png)

Expand All @@ -113,7 +126,7 @@ license: the reforestation tool is made available to Global Evergreening Global

![sub-divisional administrative units areas](./img/layer-list-8.png)

5. **Exclusion Masks:**
**6. Exclusion Masks:**

![Exclusion Masks](./img/layer-list-9.png)

Expand All @@ -134,11 +147,11 @@ license: the reforestation tool is made available to Global Evergreening Global
> Additional Notes on Viewing Different Imagery Layers:
To effectively view the different imagery layers (Google Imagery, NICFI, and Landsat), you need to toggle the visibility of these layers.

6. **Current Google Imagery:** Displays the most recent Google imagery. Check the relevant checkbox to view `Current Google imagery`.
**7. Current Google Imagery:** Displays the most recent Google imagery. Check the relevant checkbox to view `Current Google imagery`.

![Google Imagery](./img/layer-list-14.png)

7. **Recent NICFI Imagery:**
**8. Recent NICFI Imagery:**

- **Turn Off Google Imagery/Historical Landsat Imagery to View NICFI Imagery:** In the Layers panel, locate the Google Imagery/Historical Landsat Imagery layer. Click the checkbox next to the Google Imagery/Historical Landsat Imagery layer to turn it off. This will allow the NICFI imagery to be visible.

Expand All @@ -155,7 +168,7 @@ license: the reforestation tool is made available to Global Evergreening Global
![NICFI Imagery](./img/layer-list-16.png)
![NICFI Imagery](./img/layer-list-18.png)

8. **Historical Landsat Imagery:** Displays historical Landsat imagery. Check the relevant checkbox to view historical Landsat imagery. The user can use the historical imagery to compare the current and historical imagery differences.
**9. Historical Landsat Imagery:** Displays historical Landsat imagery. Check the relevant checkbox to view historical Landsat imagery. The user can use the historical imagery to compare the current and historical imagery differences.

- **Turn Off Google Imagery/NICFI Imagery to View Landsat Imagery:** In the Layers panel, locate the Google Imagery/NICFI imagery layer. Click the checkbox next to the Google Imagery/NICFI imagery layer to turn it off. This will reveal the Landsat imagery layer below.

Expand Down
Binary file modified docs/src/user/manual/img/gea-reforestation-tool-15.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/user/manual/img/gea-reforestation-tool-16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/user/manual/img/layer-list-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/user/manual/img/layer-list-19.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/user/manual/img/layer-list-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/user/manual/img/layer-list-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/user/manual/img/layer-list-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/src/user/manual/img/layer-list-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cd434bf

Please sign in to comment.