Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added import instance doc #102

Merged
merged 2 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 42 additions & 2 deletions docs/src/user/guide/gea-reforestation-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ This tutorial, will walk you through using the `Drawing Tool` to create project

* Author of the Site Capture: Enter the name of the person who recorded the site details.

* Country: Select the project's country from the dropdown list.
* Project: Select the project's origin from the dropdown list.

* Project Folder: Choose the folder where plugin data will be stored.

Expand All @@ -162,10 +162,50 @@ This tutorial, will walk you through using the `Drawing Tool` to create project

- Important: Clear the polygon before saving a new project, as existing shape files in the Sites folder won't be automatically deleted.

## 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)

After clicking on the `Import Project Instance`, a pop-up window will appear. Locate your project instance directory, then select the instance and click the 1️⃣ `Open` button.

![Select Project Instance Window](./img/gea-reforestation-tool-17.png)

After selecting the desired project instance, a `Project Instance Attributes` pop-up window will appear, where you need to fill in some information to proceed.

![Project Instance Attributes](./img/gea-reforestation-tool-18.png)

- **Report Author :** Name of the person generating the report.
- **Project :** Select the origin of the project from dropdown menu.
- **Cencel :** Click on the `Cancel` button to stop the process.
- **Save :** Click on the `Save` button to complete the process.

**Error Message:** If the author, project, IncepDate, or area names are already present in the project instance, you will encounter this error.

![Error](./img/gea-reforestation-tool-20.png)

* **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.

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

## Automated Report Generation

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

**Generating an Automated Report:** After drawing and saving your project area, click the Generate Report` button. The system will create an automated report based on your project area and details.
**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.

![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).

![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.


Binary file modified docs/src/user/guide/img/gea-reforestation-tool-10.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-11.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-12.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-13.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.
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/guide/img/gea-reforestation-tool-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-tool-9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
84 changes: 72 additions & 12 deletions docs/src/user/manual/gea-reforestation-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,38 +46,98 @@ 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.
**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 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.
* **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.
* **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.
* **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.
* **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.
* **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.
* **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.
* **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.
* **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.
* **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.

**Import project instance:** The user can use the `Import project instance` button to import project instances directly from the system. After clicking on the `Import project instance` button, a pop-up window will appear where the user can select an instance from the available options.

![Import Project Instance](./img/gea-reforestation-tool-10.png)

* **Cancel:** Close the pop-up window.
* **Open:** Select the file and click on the `Open button` to proceed.
* **Shapefiles:** Extension of the file.

After selecting the desired project instance user will click on the `open` button and a pop up project instance attributes dialog box will appear.

![Project Instance Attributes](./img/gea-reforestation-tool-11.png)

* **X:** Close the pop-up dialog box.
* **Report Author:** The name of the person generating the report.
* **Project:** The name of the country where the project is located.
* **Cancle:** Terminate the process.
* **Save:** Save the instance to proceed.

**Error Message:** If the author, project, IncepDate, or area names are already present in the project instance, you will encounter this error.

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

* **X:** Close the window.
* **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.

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

## Automated Report

Click on the generate report button to generate an 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.

![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.

## Genenrated Report

This is the report generated after completing the process.

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

1. **GEA Reforestation Site Report:** Displaying the report information.
- **Date of Project Inception:** The date when the project started.
- **Version of Site Referrence:** The version of the site reference.
- **Date of Site Capture:** The date when the site was captured.
- **Site Refference:** The site reference.
- **Author of Site Capture:** The person who captured the site.
- **Country Location:** The country where the project is located.
- **Site Area:** The area of the site.

2. **Site Location Maps:** Displaying the site location on the maps.

3. **Landscape Exclusion and Inclusion Areas:** Displaying the Historical Landsat 2013 with and without exclusion masks and
proposed site.
Binary file modified docs/src/user/manual/img/gea-reforestation-tool-1.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.
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/gea-reforestation-tool-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/gea-reforestation-tool-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/gea-reforestation-tool-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/gea-reforestation-tool-5.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-7.png
Loading