From 0f482aad2aa6d5fbe22cad1abdfe3b5d379b424e Mon Sep 17 00:00:00 2001 From: ketan Date: Thu, 10 Oct 2024 16:21:44 +0530 Subject: [PATCH] Revert "Merge branch 'kartoza:main' into main" This reverts commit 2736bcf95c4e70759f9d41b7ea2a17711d7ec191, reversing changes made to 1da32c388f54fea264d5f4e23e3c4c10c3511853. --- docs/src/about/code-of-conduct.md | 9 +++-- docs/src/about/contributing.md | 4 +- docs/src/about/index.md | 4 +- docs/src/about/running-instances.md | 2 +- docs/src/administrator/index.md | 2 +- docs/src/administrator/manual/index.md | 2 +- docs/src/developer/api/guide/index.md | 2 +- docs/src/developer/api/index.md | 2 +- docs/src/developer/api/manual/index.md | 2 +- docs/src/developer/documentation/overview.md | 2 +- docs/src/devops/guide/index.md | 2 +- docs/src/devops/index.md | 2 +- docs/src/devops/manual/index.md | 2 +- docs/src/index.md | 14 +++---- docs/src/user/Appendix1.md | 18 ++++----- docs/src/user/guide/gea-reforestation-tool.md | 18 ++++----- docs/src/user/guide/gea-reforestation.md | 40 +++++++++---------- docs/src/user/guide/index.md | 2 +- docs/src/user/guide/login.md | 6 +-- docs/src/user/guide/nicfi-imagery.md | 21 +++++----- docs/src/user/guide/sign-up.md | 4 +- docs/src/user/index.md | 6 +-- .../src/user/manual/gea-reforestation-tool.md | 14 +++---- docs/src/user/manual/gea-reforestation.md | 14 +++---- docs/src/user/manual/index.md | 2 +- docs/src/user/manual/login.md | 2 +- docs/src/user/manual/nicfi-imagery.md | 6 +-- docs/src/user/manual/sign-up.md | 4 +- docs/src/user/quickstart/index.md | 26 ++++++------ docs/src/user/user-workflow.md | 2 +- 30 files changed, 116 insertions(+), 120 deletions(-) diff --git a/docs/src/about/code-of-conduct.md b/docs/src/about/code-of-conduct.md index 350b3d6..5c93f4c 100644 --- a/docs/src/about/code-of-conduct.md +++ b/docs/src/about/code-of-conduct.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -13,7 +13,8 @@ license: the reforestation tool is made available to Global Evergreening Global ## Our pledge -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, @@ -32,7 +33,7 @@ include: Examples of unacceptable behaviour by participants include: -* The use of sexualised language or imagery and unwelcome sexual attention or +* The use of sexualized language or imagery and unwelcome sexual attention or advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment @@ -50,7 +51,7 @@ response to any instances of unacceptable behaviour. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviours that they deem inappropriate, +permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. ## Scope diff --git a/docs/src/about/contributing.md b/docs/src/about/contributing.md index c6c4ae7..1fe14ab 100644 --- a/docs/src/about/contributing.md +++ b/docs/src/about/contributing.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -125,7 +125,7 @@ Follow other PR title format on below. : Short Description (ref #111) ``` -* capitalise first letter of Type +* capitalize first letter of Type * use present tense: 'change' not 'changed' or 'changes' #### Description diff --git a/docs/src/about/index.md b/docs/src/about/index.md index 4587fb8..5ecb4ad 100644 --- a/docs/src/about/index.md +++ b/docs/src/about/index.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -26,7 +26,7 @@ Published under AGPL-3. See the [full license](license.md) text. ## Project funders/backers -This project was conceptualised and initially funded by [FUNDER_1](). +This project was conceptualized and initially funded by [FUNDER_1](). ## Logos diff --git a/docs/src/about/running-instances.md b/docs/src/about/running-instances.md index 72024c9..96c3b16 100644 --- a/docs/src/about/running-instances.md +++ b/docs/src/about/running-instances.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin diff --git a/docs/src/administrator/index.md b/docs/src/administrator/index.md index 99acd4a..499b3ab 100644 --- a/docs/src/administrator/index.md +++ b/docs/src/administrator/index.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin diff --git a/docs/src/administrator/manual/index.md b/docs/src/administrator/manual/index.md index c9de9b2..68525be 100644 --- a/docs/src/administrator/manual/index.md +++ b/docs/src/administrator/manual/index.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin diff --git a/docs/src/developer/api/guide/index.md b/docs/src/developer/api/guide/index.md index 64f46c1..31cb818 100644 --- a/docs/src/developer/api/guide/index.md +++ b/docs/src/developer/api/guide/index.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin diff --git a/docs/src/developer/api/index.md b/docs/src/developer/api/index.md index d776d22..e09b841 100644 --- a/docs/src/developer/api/index.md +++ b/docs/src/developer/api/index.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin diff --git a/docs/src/developer/api/manual/index.md b/docs/src/developer/api/manual/index.md index ab15d04..2ce9327 100644 --- a/docs/src/developer/api/manual/index.md +++ b/docs/src/developer/api/manual/index.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin diff --git a/docs/src/developer/documentation/overview.md b/docs/src/developer/documentation/overview.md index fb35a13..066731d 100644 --- a/docs/src/developer/documentation/overview.md +++ b/docs/src/developer/documentation/overview.md @@ -127,7 +127,7 @@ Whenever you create a new file, you should add the standard header to the top of ``` --- title: GeoRepo-OS Documentation -summary: GeoRepo is a UNICEF's geospatial web-based data storage and administrative boundary harmonisation platform. +summary: GeoRepo is a UNICEF's geospatial web-based data storage and administrative boundary harmonization platform. - Tim Sutton - Dimas Tri Ciputra - Danang Tri Massandy diff --git a/docs/src/devops/guide/index.md b/docs/src/devops/guide/index.md index 760ffa0..d4621de 100644 --- a/docs/src/devops/guide/index.md +++ b/docs/src/devops/guide/index.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin diff --git a/docs/src/devops/index.md b/docs/src/devops/index.md index d8ecf74..ac1a117 100644 --- a/docs/src/devops/index.md +++ b/docs/src/devops/index.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin diff --git a/docs/src/devops/manual/index.md b/docs/src/devops/manual/index.md index 0840a63..81db6a8 100644 --- a/docs/src/devops/manual/index.md +++ b/docs/src/devops/manual/index.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin diff --git a/docs/src/index.md b/docs/src/index.md index 1a7f6de..651f323 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -24,15 +24,15 @@ The GEA Reforestation Tool is a collaborative effort between: - The Cirrus Group - Kartoza -It combines the power of GIS software with historical and current satellite imagery to help identify potential reforestation sites. The tool includes a QGIS plugin and a custom QGIS project tailored for specific country zones of interest. +It combines the power of GIS software with historical and current satellite imagery to help identify potential reforestation sites. The Tool includes a QGIS plugin and a custom QGIS project tailored for specific country zones of interest. ## Development The reforestation site assessment tool and associated data content is a product-based service developed and provided by: -- [GeoTerra360](https://www.geoterra360.pt/) -- [Kartoza](https://kartoza.com/) -- [CIRRUS](https://www.linkedin.com/in/tony-knowles-94b9495/) +- **GeoTerra360** (https://www.geoterra360.pt/) +- **Kartoza** (https://kartoza.com/) +- **CIRRUS** (https://www.linkedin.com/in/tony-knowles-94b9495/) ## Documentation Sections @@ -46,12 +46,12 @@ Get up and running with the GEA Reforestation Tool quickly. This section provide A comprehensive guide to using the GEA Reforestation Tool. This section covers all the features and functionalities of the tool, providing step-by-step instructions for various workflows. -[Go to the user guide](./user/guide/index.md) +[Go to user guide](./user/guide/index.md) ### User Manual Detailed technical documentation for the GEA Reforestation Tool. This section includes in-depth explanations of the tool's architecture, data requirements, and advanced usage scenarios. -[Go to the user manual](./user/manual/index.md) +[Go to user manual](./user/manual/index.md) We hope this documentation helps you make the most of the GEA Reforestation Tool. If you have any questions or need further assistance, please don't hesitate to reach out to our support team. diff --git a/docs/src/user/Appendix1.md b/docs/src/user/Appendix1.md index 2ffe262..5fabfca 100644 --- a/docs/src/user/Appendix1.md +++ b/docs/src/user/Appendix1.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -31,10 +31,10 @@ The current, very high-resolution Google imagery is digitally streamed on-demand The Planet imagery is also digitally streamed on-demand, with permission, from Norway's International Climate & Forests Initiative (NICFI) with Planet Labs (https://www.planet.com/nicfi/). Detailed image backdrops are provided for 6-monthly periods (i.e. December and June) for the 2015 – 2020 time window (5m image resolution). -The historical Landsat imagery is pre-loaded data, included as part of the QGIS project data package, and provides a less detailed set of reference pictures, but over a much older and longer time frame that neither the Planet or Google image sources can. The Landsat image backdrops provide annualised landscape representations for 1990, 1995, 2000, 2013, 2014 & 2015 (15m and 30m resolutions, depending on age). +The historical Landsat imagery is pre-loaded data, included as part of the QGIS project data package, and provides a less detailed set of reference pictures, but over a much older and longer time frame that neither the Planet or Google image sources can. The Landsat image backdrops provide annualized landscape representations for 1990, 1995, 2000, 2013, 2014 & 2015 (15m and 30m resolutions, depending on age). The historical Landsat imagery is also presented as 3-band, natural colour mosaics, with each mosaic representing a seamless coverage across the full extent of each project area. The content within each Landsat-generated backdrop imagery has been constructed from all available archive imagery, captured in the target year. As far as possible, the final backdrop mosaics have been constructed as cloud-free coverages, but in some of the older years, especially 1990, the lack of archive content has unfortunately, but unavoidably, resulted in some cloud-obscured areas remaining in the backdrop content; simply because there is insufficient imagery available to create cloud-free content. -The resolution of each image backdrop is based on the resolution of the source Landsat imagery, with 1990, and 1995 is limited to 30m formats, whereas 2000 – 2023 inclusive are presented at 15m resolution by pan-merging spectral content with panchromatic band content. +The resolution of each image backdrop is based on the resolution of the source Landsat imagery, with 1990, 1995 being limited to 30m formats, whereas 2000 – 2023 inclusive are presented at 15m resolution by pan-merging spectral content with panchromatic band content. The Landsat imagery for 2015 allows QGIS tool users to compare the level of landscape detail available from coarse resolution Landsat with comparable 2015 date 5m Planet imagery, and better understand the content in the exclusion masks, which have been modelled from Landsat sourced data. This is important for tool-user orientation, since the recent and current NICFI-Planet and Google base map image resolutions (5m and 50cm respectively), far exceed the resolution (30m) and detail used to model and construct the exclusion map coverages. @@ -50,15 +50,15 @@ For each project area, a series of raster-based exclusion “masks” have been **4.1 Forest and Grassland Exclusion Masks** **4.1.2 Reference Land-Cover Datasets** -Both the forest and grassland exclusion masks are derived from the time-series land-cover (LC) datasets that have been specifically generated for this project. The time-series LC datasets represent the 2003, 2013 and 2023 landscapes, and have been modelled from archival Landsat imagery. All available and suitable Landsat image acquisition dates within a target calendar year have been used, to ensure a multi-seasonal representation of landscape characteristics, and minimise any single-season interpretation bias. +Both the forest and grassland exclusion masks are derived from the time-series land-cover (LC) datasets that have been specifically generated for this project. The time-series LC datasets represent the 2003, 2013 and 2023 landscapes, and have been modelled from archival Landsat imagery. All available and suitable Landsat image acquisition dates within a target calendar year have been used, to ensure a multi-seasonal representation of landscape characteristics, and minimize any single-season interpretation bias. The Landsat-based time-series LC datasets have all been time-extrapolated backward and forwards using models trained on an independently generated 2019 base reference LC dataset. -The 2019 base reference LC data has been generated from multi-date 20m resolution Sentinel-2 imagery, representing both the 2019 calendar year (i.e. 01-2019 to 12-2019) and the 2019 growth years (i.e. 07-2018 to 06-2019 and 07-2019 to 06-2020), in conjunction with the GLAD/GEDI 2019 global tree canopy height data. The use of both a target calendar year and overlapping growth years helps minimise any seasonal anomalies resulting from drought or excessively wet periods. The Sentinel-2 LC modelling procedure is the GeoTerraImage in-house capability that leverages cloud archive and cloud computing capabilities to enable the auto-generation of standardised land-cover characteristics, that are based on all available and suitable Sentinel image acquisition dates within the target window. +The 2019 base reference LC data has been generated from multi-date 20m resolution Sentinel-2 imagery, representing both the 2019 calendar year (i.e. 01-2019 to 12-2019) and the 2019 growth years (i.e. 07-2018 to 06-2019 and 07-2019 to 06-2020), in conjunction with the GLAD/GEDI 2019 global tree canopy height data. The use of both a target calendar year and overlapping growth years helps minimize any seasonal anomalies resulting from drought or excessively wet periods. The Sentinel-2 LC modelling procedure is the GeoTerraImage in-house capability that leverages cloud archive and cloud computing capabilities to enable the auto-generation of standardized land-cover characteristics, that are based on all available and suitable Sentinel image acquisition dates within the target window. -Both the 2019 base reference LC and the time-series LC datasets describe landscape characteristics with the same standardised legend. The legend contains a range of structural/physiognomic defined vegetation cover characteristics (i.e. forest, thicket / low forest, dense woodland, open woodland, grassland, low shrub), as well as water and bare ground surfaces. The LC classes do not attempt to describe any Land-Use (LU) characteristics in the landscape, as this is added at a later processing step, therefore grass-type crops such as maize would be described as “grassland” and tree crops, such as orchards, as “thicket” if the woody cover density was appropriate. LU content is added later. +Both the 2019 base reference LC and the time-series LC datasets describe landscape characteristics with the same standardized legend. The legend contains a range of structural/physiognomic defined vegetation cover characteristics (i.e. forest, thicket / low forest, dense woodland, open woodland, grassland, low shrub), as well as and water and bare ground surfaces. The LC classes do not attempt to describe any Land-Use (LU) characteristics in the landscape, as this is added at a later processing step, therefore grass-type crops such as maize would be described as “grassland” and tree crops, such as orchards, as “thicket” if the woody cover density was appropriate. LU content is added later. -Table 1 provides definitions of each of the image-modelled LC classes contained in the standardised legend. +Table 1 provides definitions of each of the image-modelled LC classes contained in the standardized legend. | Class | Name | Description | |-------|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -79,10 +79,10 @@ The final inclusion and spatial extent of each legend class in the LC classifica The Sentinel-2 2019 reference LC dataset is generated with a 20m raster resolution format, equivalent to the source imagery. All the Landsat-generated time-series LCs are presented in a -standardised 25m output format, which represents a re-sampling from the original 30m source data +standardized 25m output format, which represents a re-sampling from the original 30m source data resolution. The 25m standard raster resolution is used as the most appropriate format to integrate the 20m Sentinel and 30m Landsat derived data outcomes. All derived final exclusion masks are also -generated as a standardised 25m equivalent raster resolution. Figure 1 is a schematic of the LC +generated as a standardized 25m equivalent raster resolution. Figure 1 is a schematic of the LC modelling process used to generate the 2019 reference LC, and the ultimate target year LC’s. ![Figure 1](./img/figure-1.png) diff --git a/docs/src/user/guide/gea-reforestation-tool.md b/docs/src/user/guide/gea-reforestation-tool.md index a8a96f6..b9e9c09 100644 --- a/docs/src/user/guide/gea-reforestation-tool.md +++ b/docs/src/user/guide/gea-reforestation-tool.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -21,7 +21,7 @@ There are two ways to install the plugin 1. from the repository and 2. install f **Prerequisites:** -- QGIS installed on your computer. If QGIS is not installed on your system you can refer to [QGIS installation](../quickstart/index.md) for detailed instructions on how to install QGIS. +- QGIS installed on your computer. If QGIS is not installed on you system you can refer to [QGIS installation](../quickstart/index.md) for detailled instruction on how to install QGIS. - The plugin URL (available from the [Plugins GitHub Repository](https://github.com/kartoza/qgis-gea-plugin)) @@ -95,7 +95,7 @@ Congratulations! You have successfully installed the GEA Reforestation Tool plug ## How to use the time slider? -You can use the time slider for Historical Landsat Imagery as well as for Recent NICFI Imagery. +You can user the time slider for Historical Landsat Imagery as well as for Recent Nicfi Imagery. ### Use time slider for Historical Landsat Imagery @@ -113,17 +113,17 @@ Look for the play button near the slide bar. Click the play button to automatica Find the `Loop` checkbox next to the play button. Check this box if you want the playback to continuously loop through the imagery. When activated, the playback will restart from the beginning after reaching the most recent imagery. -## Use time slider for Recent NICFI Imagery +## Use time slider for Recent Nicfi Imagery ![Nicif imagery](./img/Timeslidernicfi.gif) -Select the `Recent Imagery (NICFI)` checkbox. The slide bar represents a timeline of available NICFI imagery. +Select the `Recent Imagery (Nicfi)` checkbox, The slide bar represents a timeline of available nicfi imagery. To view different time periods click, and drag the toggle on the slide bar. Move it left or right to navigate through time. As you move the toggle, the map canvas will update to display the corresponding imagery for that time period. Each increment on the slide bar represents a specific time period. Moving to the next or previous increment will show you how the landscape has changed over time. **Using the Play Button:** -Look for the play button near the slide bar. Click the play button to automatically cycle through the NICFI imagery. This feature is excellent for visualising changes over time without manual intervention. +Look for the play button near the slide bar. Click the play button to automatically cycle through the nicif imagery. This feature is excellent for visualising changes over time without manual intervention. **Activating the Loop Feature:** @@ -131,13 +131,13 @@ Find the `Loop` checkbox next to the play button. Check this box if you want the ## Drawing Tool -This tutorial will walk you through using the `Drawing Tool` to create project areas and how to generate automated reports. +This tutorial, will walk you through using the `Drawing Tool` to create project areas and how to generate automated reports. -**Accessing the Drawing Tool:** Click on the 1️⃣ `Drawing project area` button, in the QGIS interface. Ensure you have filled in the required fields. If field is missing, you will see an error message. +**Accessing the Drawing Tool:** Click on the 1️⃣ `Drawing project area` button, in the QGIS interface. Ensure you have fill the required fields. If the any field is missing, you will see an error message. ![Draw project](./img/gea-reforestation-tool-8.png) -- For example, if you forget to enter the site reference, an error will be displayed at the top. +- For eg. if you miss entering the site reference the error will show on the top. ![Error](./img/gea-reforestation-tool-9.png) diff --git a/docs/src/user/guide/gea-reforestation.md b/docs/src/user/guide/gea-reforestation.md index c6a5555..48a7b93 100644 --- a/docs/src/user/guide/gea-reforestation.md +++ b/docs/src/user/guide/gea-reforestation.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -30,7 +30,7 @@ The folder should contain the following components: **Extracting the Project Folder**: -- Download the project folder shared by the head office. +- Download the project folder sharesd by the head office. ![Shared folder](./img/gea-reforestation-1.png) @@ -49,39 +49,37 @@ The folder should contain the following components: ![QGIS interface](./img/gea-reforestation-7.png) -1. **Icons Toolbar -** +1. **Attributs Toolbar:** - a. Map Navigation Toolbar icons +- **Pan**: Click on the 1️⃣ `Pan` icon, to pan the map canvas. - - **Pan**: Click on the 1️⃣ `Pan` icon, to pan the map canvas. +- **Zoom In**: Click on the 2️⃣ `Zoom IN` icon, and drag to select the area you want to zoom in on on the map canvas. - - **Zoom In**: Click on the 2️⃣ `Zoom In` icon, and drag to select the area you want to zoom in on the map canvas. +- **Zoom Out**: Click on the 3️⃣ `Zoom Out` icon, and drag to select the area you want to zoom out on the map canvas. - - **Zoom Out**: Click on the 3️⃣ `Zoom Out` icon, and drag to select the area you want to zoom out on the map canvas. +- **Full Zoom**: Click on the 4️⃣ `Full Zoom` icon, to zoom to the full extent of the map. - - **Full Zoom**: Click on the 4️⃣ `Full Zoom` icon, to zoom to the full extent of the map. +- **Show Map Tips**: Click on the 5️⃣ `Show Map Tips` icon, to display additional information about the map, such as coordinates and scale. - - **Show Map Tips**: Click on the 5️⃣ `Show Map Tips` icon, to display additional information about the map, such as coordinates and scale. +![Attributes toolbar](./img/gea-reforestation-5.png) - ![Attributes toolbar](./img/gea-reforestation-5.png) +2. **Vector Toolbar:** -2. **Digitising toolbar icons:** +- **Current edits:** 1️⃣ `Current edits` displays the current editing state of the layer. - - **Current edits:** 1️⃣ `Current edits` display the current editing state of the layer. +- **Toggle editing:** Click on the 2️⃣ to toggles the editing mode on or off. - - **Toggle editing:** Click on the 2️⃣ to toggle the editing mode on or off. +- **Save layer edits:** Click on the 3️⃣ to save any changes made to the layer. - - **Save layer edits:** Click on the 3️⃣ to save any changes made to the layer. - - - **Add polygon feature:** Click on the 4️⃣ to create a new polygon feature on the map. +- **Add polygon feature:** Click on the 4️⃣ to creates a new polygon feature on the map. ![Vector toolbar](./img/gea-reforestation-6.png) -3. **List of layer in the Layers Panel:** +3. **Layer List:** ![layer list](./img/gea-reforestation-8.png) -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: +You can utilise the `Layers List` 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 - Malawi 2 Buffer @@ -133,11 +131,11 @@ Check the respective checkboxes to visualise the exclusion masks on the map canv - **Current Google Imagery:** Check the checkbox to view the most recent `Google imagery`. -- **Recent NICFI Imagery:** To view the `NICFI` imagery, you need to turn off the Google Imagery and Historical Landsat Imagery layers first and select the recent NICFI imagery. +- **Recent NICFI Imagery:** To view the `NICFI` imagery, you need to turn off the Google Imagery and Historical Landsat Imagery layers first and select the recent nicfi imagery. ![Nicfi](./img/gea-reforestation-12.png) - >NOTE: To view the NICFI imagery you need to register/log in to the Planet Explore site. If you are not already registered on the site you can refer to the below links for the detailed documentation on register/log in. + >NOTE: To view the NICFI imagery you need to register/login to the planet explore site. If you are not already register on the site you can refer the below links for the detailed documentation on register/login. - [Register to the Planet Explore site](./sign-up.md) @@ -151,7 +149,7 @@ By selectively toggling the visibility of the different layers, you can customis With the GEA Reforestation QGIS project opened and the basic navigation tools explored, you are now ready to dive deeper into the project and start working on the reforestation activities. -## How to style an image for better visualisation? +## How to style image for better visualisation? This user guide will show you how to change the image styles in QGIS symbology to enhance the quality and realism of your images. diff --git a/docs/src/user/guide/index.md b/docs/src/user/guide/index.md index 2df08a4..26a3592 100644 --- a/docs/src/user/guide/index.md +++ b/docs/src/user/guide/index.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin diff --git a/docs/src/user/guide/login.md b/docs/src/user/guide/login.md index 32a5174..4213038 100644 --- a/docs/src/user/guide/login.md +++ b/docs/src/user/guide/login.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -13,11 +13,11 @@ license: the reforestation tool is made available to Global Evergreening Global ## Why Logging In is Important -Logging into Planet.com is important for accessing the latest NICFI imagery. Through Norway’s International Climate & Forests Initiative (NICFI), users can use Planet’s high-resolution, analysis-ready mosaics of the world's tropics. This data is essential for efforts to reduce and reverse the loss of tropical forests, combat climate change, and conserve biodiversity. +Logging into Planet.com is crucial for accessing the latest NICFI imagery. Through Norway’s International Climate & Forests Initiative (NICFI), users can utilise Planet’s high-resolution, analysis-ready mosaics of the world's tropics. This data is essential for efforts to reduce and reverse the loss of tropical forests, combat climate change, and conserve biodiversity. ## Logging In -Click on the 1️⃣ `Login` button in QGIS. Upon clicking, the sign-in form will open. +Click on the 1️⃣ `Login` button. Upon clicking, the sign-in form will open. ![Login](./img/login-1.png) diff --git a/docs/src/user/guide/nicfi-imagery.md b/docs/src/user/guide/nicfi-imagery.md index 779856b..300bc16 100644 --- a/docs/src/user/guide/nicfi-imagery.md +++ b/docs/src/user/guide/nicfi-imagery.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -30,24 +30,23 @@ This tutorial will guide you through accessing and using NICFI (Norway's Interna ## Step 2: Access NICFI Imagery in QGIS 1. Open your QGIS project. - -2. Navigate to the layers panel. +2. Locate the layer list in your QGIS interface. ## Step 3: Disable Current Google Imagery/Historical Landsat Imagery -1. Uncheck the `Current Google Imagery` and `Historical Landsat Imagery` checkbox in the layers panel to view the NICFI imagery. +1. Uncheck the `Current Google Imagery` and `Historical Landsat Imagery` checkbox in the layer list to view the Nicfi imagery. ![Google/historical imagery disabled](./img/nicfi-imagery-1.png) ## Step 4: Enable NICFI Imagery -1. Check the 1️⃣ `Recent NICFI Imagery` checkbox in the layer list to enable NICFI imagery. +1. Check the 1️⃣ `Recent Nicfi Imagery` checkbox in the layer list to enable NICFI imagery. ![NICFI imagery enabled](./img/nicfi-imagery-2.png) ## Step 5: Select NICFI Imagery -1. After enabling NICFI imagery, you will see a list of available imagery. +1. After enabling NICFI imagery, you will see a list of available imageries. 2. Choose the imagery you want to view on the map canvas. ![Specific NICFI imagery enabled](./img/nicfi-imagery-3.png) @@ -78,16 +77,16 @@ Each imagery set provides a visual representation of the tropical regions for th 2. Use QGIS tools to analyse the imagery, such as: - Zoom in/out to examine areas of interest. - Use Pan to pan on the map canvas. - - See the tips using the show map tips. + - See the tips usign the show map tips. ## Tips for Using NICFI Imagery -1. **Compare time periods**: Use different imagery dates to observe changes in tropical forests over time. -2. **Combine with other data**: Overlay the NICFI imagery with other geographic data for comprehensive analysis. -3. **Performance optimisation**: Remember that NICFI imagery is streamed on demand. If you experience slow loading, try zooming in to a smaller area or checking your internet connection. +1. **Compare Time Periods**: Use different imagery dates to observe changes in tropical forests over time. +2. **Combine with Other Data**: Overlay the NICFI imagery with other geographic data for comprehensive analysis. +3. **Performance Optimization**: Remember that NICFI imagery is streamed on demand. If you experience slow loading, try zooming in to a smaller area or checking your internet connection. ## Conclusion -NICFI imagery provides a powerful tool for analysing tropical regions. By following this guide, you can effectively access and use this resource in your QGIS projects, supporting efforts in forest conservation, climate change mitigation, and sustainable development. +NICFI imagery provides a powerful tool for analysing tropical regions. By following this guide, you can effectively access and utilise this valuable resource in your QGIS projects, supporting efforts in forest conservation, climate change mitigation, and sustainable development. Remember, NICFI imagery is for non-commercial use only. Always comply with the usage terms and conditions set by NICFI and Planet. \ No newline at end of file diff --git a/docs/src/user/guide/sign-up.md b/docs/src/user/guide/sign-up.md index def96d4..c8e44ea 100644 --- a/docs/src/user/guide/sign-up.md +++ b/docs/src/user/guide/sign-up.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -17,7 +17,7 @@ Welcome to the user guide for registering on Planet.com. This guide will walk yo ## Why Register on Planet.com? -By registering on Planet.com, you can access the latest NICFI imagery. Through Norway’s International Climate & Forests Initiative (NICFI), users can use Planet’s high-resolution mosaics to help reduce and reverse the loss of tropical forests, combat climate change, and conserve biodiversity. +By registering on Planet.com, you can access the latest NICFI imagery. Through Norway’s International Climate & Forests Initiative (NICFI), users can now utilise Planet’s high-resolution mosaics to help reduce and reverse the loss of tropical forests, combat climate change, and conserve biodiversity. ## Step-by-Step Registration Guide diff --git a/docs/src/user/index.md b/docs/src/user/index.md index fefab33..be9fb97 100644 --- a/docs/src/user/index.md +++ b/docs/src/user/index.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -13,7 +13,7 @@ license: the reforestation tool is made available to Global Evergreening Global This is the homepage for all user-related documentation. -The user content is divided into five sections: +The user content is divided into three sections: - The [quickstart tutorial](quickstart/index.md) aims to get you familiar with the basics of the platform in around 5 minutes. @@ -23,4 +23,4 @@ The user content is divided into five sections: - [user workflow](./user-workflow.md) This document provides detailed instructions on the workflow, including how users can download and utilise project data. -- [Appendix 1](./Appendix1.md) provides the details about the liabilities, exclusion masks and imageries. +- [Appendix1](./Appendix1.md) provides the details about the liabilities, exclusion masks and imageries. diff --git a/docs/src/user/manual/gea-reforestation-tool.md b/docs/src/user/manual/gea-reforestation-tool.md index d4e8a33..7b3c249 100644 --- a/docs/src/user/manual/gea-reforestation-tool.md +++ b/docs/src/user/manual/gea-reforestation-tool.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -29,7 +29,7 @@ Welcome to the GEA Reforestation Tool user manual. This guide will help you navi ![Historical Imagery](./img/gea-reforestation-tool-2.png) -- **Recent Imagery (NICFI) Checkbox Checked:** The map canvas will display recent imagery from NICFI. +- **Recent Imagery (Nicfi) Checkbox Checked:** The map canvas will display recent imagery from NICFI. ![Recent Imagery](./img/gea-reforestation-tool-3.png) @@ -104,7 +104,7 @@ After selecting the desired project instance user will click on the `open` butto * **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. -* **Cancel:** Terminate the process. +* **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. @@ -133,7 +133,7 @@ After saving the instance, the selected instance will be added to the project in * **Close:** Cancel the process. * **Open PDF:** Open the PDF in a new pop-up window. - ## Generated Report + ## Genenrated Report This is the report generated after completing the process. @@ -141,14 +141,14 @@ After saving the instance, the selected instance will be added to the project in 1. **GEA Reforestation Site Report:** Displaying the report information. - **Date of Project Inception:** The date when the project started. - - **Version of Site Reference:** The version of the site reference. + - **Version of Site Referrence:** The version of the site reference. - **Date of Site Capture:** The date when the site was captured. - - **Site Reference:** The site reference. + - **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 the + 3. **Landscape Exclusion and Inclusion Areas:** Displaying the Historical Landsat 2013 with and without exclusion masks and proposed site. \ No newline at end of file diff --git a/docs/src/user/manual/gea-reforestation.md b/docs/src/user/manual/gea-reforestation.md index 8c67d7a..e09678e 100644 --- a/docs/src/user/manual/gea-reforestation.md +++ b/docs/src/user/manual/gea-reforestation.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -46,11 +46,11 @@ license: the reforestation tool is made available to Global Evergreening Global ![Plugins](./img/gea-reforestation-6.png) - 3.2 **Icon Toolbar** + 3.2 **Attribute Toolbar** ![Attribut toolbar](./img/gea-reforestation-7.png) - The map navigation toolbar offers many options, some of which are: + The attribute 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. @@ -58,11 +58,11 @@ license: the reforestation tool is made available to Global Evergreening Global 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:** + 3.3 **Vector Toolbar:** ![Vector toolbar](./img/gea-reforestation-8.png) - The digitising toolbar offers many options, some of which are: + The vector 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. @@ -93,7 +93,7 @@ license: the reforestation tool is made available to Global Evergreening Global ![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. **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) @@ -101,7 +101,7 @@ license: the reforestation tool is made available to Global Evergreening Global ![Administrative areas](./img/layer-list-5.png) - - **Malawi 2 Country:** Displays the country boundaries of Malawi. Check the `Malawi 2 Country` checkbox to visualise the country boundaries, it will be shown on the map canvas with a green administrative boundary line. + - **Malawi 2 Country:** Displays the country boundaries of Malawi. Check the `Malawi 2 Country` checkbox to visualise the country boundaries, it will be shown on the map canvas with a green line. ![Country areas](./img/layer-list-6.png) diff --git a/docs/src/user/manual/index.md b/docs/src/user/manual/index.md index 275cffc..6953a54 100644 --- a/docs/src/user/manual/index.md +++ b/docs/src/user/manual/index.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin diff --git a/docs/src/user/manual/login.md b/docs/src/user/manual/login.md index 0750c73..18a403d 100644 --- a/docs/src/user/manual/login.md +++ b/docs/src/user/manual/login.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin diff --git a/docs/src/user/manual/nicfi-imagery.md b/docs/src/user/manual/nicfi-imagery.md index bef7f87..27bc4d4 100644 --- a/docs/src/user/manual/nicfi-imagery.md +++ b/docs/src/user/manual/nicfi-imagery.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -35,11 +35,11 @@ To use the NICFI imagery in QGIS, follow these steps: ![Google imagery](./img/nicfi-imagery-1.png) -* Check the `Recent NICFI Imagery` checkbox and then select the NICFI imagery from the available imageries to view on the map canvas. +* Check the `Recent Nicfi Imagery` checkbox and then select the Nicfi imagery from the available imageries to view on the map canvas. ![Nicfi imagery](./img/nicfi-imagery-2.png) -4. **NICFI imageries** +4. **Nicfi imageries** **PS Tropical Visual Biannaul Archive - December 2015** diff --git a/docs/src/user/manual/sign-up.md b/docs/src/user/manual/sign-up.md index 499966c..a0724f8 100644 --- a/docs/src/user/manual/sign-up.md +++ b/docs/src/user/manual/sign-up.md @@ -1,6 +1,6 @@ --- title: GEA REFORESTATION -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin @@ -35,7 +35,7 @@ Registering on Planet.com allows users to access the latest NICFI imagery. Throu 3. **Can you describe the application of data from NICFI program in brief?:** Provide a brief description of how the user plans to use the data from the NICFI program. This information helps Planet understand the diverse applications of their data. -4. **Please provide a link to your organisation/lab/university that you might be working with:** Enter the URL of the organisation, lab, or university the user is affiliated with. This adds credibility to the user's application and helps Planet verify the user's affiliation. +4. **Please provide a link to your organization/lab/university that you might be working with:** Enter the URL of the organisation, lab, or university the user is affiliated with. This adds credibility to the user's application and helps Planet verify the user's affiliation. 5. **Organisation type:** Select the type of organisation the users are associated with from the provided options. This helps categorise users and tailor communications and services. diff --git a/docs/src/user/quickstart/index.md b/docs/src/user/quickstart/index.md index f6eddf3..e07e8b3 100644 --- a/docs/src/user/quickstart/index.md +++ b/docs/src/user/quickstart/index.md @@ -20,7 +20,7 @@ The GEA Reforestation Tool consists of two main components: To use the tool, a few dependencies are required: 1. QGIS: The tool runs in QGIS geographical software, which needs to be installed on the user's computer. -2. A free account for NICFI data: https://www.planet.com/nicfi +2. A free Account for NICFI data: https://www.planet.com/nicfi 3. Planet_explorer: Some data (e.g., NICFI imagery) is streamed in via the Planet plugin, so this plugin needs to be installed in QGIS. The following Quick Start documentation will guide users on how to set up the tool with its dependencies: @@ -28,12 +28,12 @@ The following Quick Start documentation will guide users on how to set up the to 1. Get QGIS. 2. The project file for an area of interest. 3. Sign in for a Planet NICFI account. -4. Install the Plantet_Explorer Plugin. -5. Install the GEA Reforestation Plugin. +4. get the Plantet_Explorer Plugin. +5. get the GEA Reforestation Plugin. ## 1. How to install QGIS: -* QGIS, short for Quantum Geographic Information System, is a free and open-source software used for working with geospatial data. This data can be easily edited and analysed within QGIS. As a cross-platform application, it is widely used in geographic data applications and runs on different operating systems, including Windows, Mac, and Linux. QGIS is written in Python, C++, and Qt. +*QGIS, short for Quantum Geographic Information System, is a free and open-source software used for working with geospatial data. This data can be easily edited and analysed within QGIS. As a cross-platform application, it is widely used in geographic data applications and runs on different operating systems, including Windows, Mac, and Linux. QGIS is written in Python, C++, and Qt. - **Step 1: Visit the QGIS Website:** Open your web browser and go to the QGIS official website: [QGIS Download Page](https://www.qgis.org/download/). @@ -111,11 +111,11 @@ Open the project folder that contains the following files and folders ### Opening the GEA QGIS Project -To open the QGIS `project` right click on the project file that ends in .qgz and choose to open it with QGIS +To open the QGIS right click on the project file that ends in .qgz and choose to open it with QGIS ![Open with QGIS](./img/quick-start-24.png) -QGIS will then open with the following project and map layers viewable. +QGIS will then open with the folllowing project and map layers viewable. ![QGIS Project](./img/quick-start-25.png) @@ -135,7 +135,7 @@ In the open GEA QGIS project. ![Plugins option](./img/quick-start-1.png) -- **Access the Plugins Menu:** Click on the 1️⃣ `Plugins` in the Menu Bar at the top of the QGIS window. Upon clicking you will see a dropdown menu. +- **Access the Plugins Menu:** Click on the 1️⃣ `Plugins` option available in the navbar section at the top of the QGIS window. Upon clicking you will see a dropdown menu. ![Option](./img/quick-start-2.png) @@ -157,13 +157,13 @@ After the installation, you will see the login option. After installing the plugin you will see the option for login to the `Planet Explorer` site. register to the site and log in to view Norway’s International Climate & Forests Initiative (NICFI), imagery. -Click [sign-up](../manual/sign-up.md) to view the detailed documentation on how to sign up on the `Planet Explorer` site. +Click on the [sign-up](../manual/sign-up.md) to view the detailed documentation on how to sign up on the `Planet Explorer` site. -Click on [login](../manual/login.md) to view the detailed documentation on how to log in on the `Planet Explorer` site. +Click on the [login](../manual/login.md) to view the detailed documentation on how to log in on the `Planet Explorer` site. ### Login -In the Planet Explorer panel, click on the login button and login to the Planet Explorer. Upon logging in you will see options like upload, draw, select or extent. +Click on the login button and login to the planet explorer. Upon logging in you will see options like upload, draw, select or extent layers. ![Planet imagery](./img/quick-start-7.png) @@ -171,12 +171,10 @@ In the Planet Explorer panel, click on the login button and login to the Planet ## 5. How to Install GEA Reforestation Tool -You need to have the plugin URL. To get the plugin URL, visit to the [Plugins GitHub Repository](https://github.com/kartoza/qgis-gea-plugin) +You must have the plugin URL. To get the plugin URL go to the [Plugins GitHub Repository](https://github.com/kartoza/qgis-gea-plugin) ![Plugins GitHub Repository](./img/quick-start-20.png) -* Copy the URL into the clipboard - ### Steps to Install the Plugin - **Open QGIS:** Launch the QGIS application on your computer. @@ -211,4 +209,4 @@ After successful installation, you will see the plugin icon. ## Conclusion -By following the steps outlined in this Quick Start Guide, you will be able to set up your environment for effective use of plugins, access essential project data, and install necessary plugins such as Planet_Explorer. This setup will enable you to view, analyse, and manage geospatial data, including streamed imagery from NICFI and Google, as well as local data like Landsat images and vector data layers. +By following the steps outlined in this Quick Start Guide, you will be able to set up your environment for effective use of plugins, access essential project data, and install necessary plugins like Planet_Explorer. This setup will enable you to view, analyse, and manage geospatial data, including streamed imagery from NICFI and Google, as well as local data like Landsat images and vector data layers. diff --git a/docs/src/user/user-workflow.md b/docs/src/user/user-workflow.md index 19aba8f..c243179 100644 --- a/docs/src/user/user-workflow.md +++ b/docs/src/user/user-workflow.md @@ -1,6 +1,6 @@ --- title: GEA Reforestation -summary: Visualise historical imagery, access different landscape maps and generate reports for potential afforestation sites. +summary: Visualize historical imagery, access different landscape maps and generate reports for potential afforestation sites. - Ketan Bamniya date: 19-06-2024 some_url: https://github.com/kartoza/qgis-gea-plugin