Merge pull request #559 from ketankartoza/Update-doc-step3

Update doc step3
ConservationInternational · Nov 21, 2024 · 0c85a4b · 0c85a4b
2 parents f7d0bcf + fd48998
commit 0c85a4b
Show file tree

Hide file tree

Showing 22 changed files with 135 additions and 91 deletions.
diff --git a/docs/about/ci.md b/docs/about/ci.md
@@ -15,7 +15,7 @@ license: This program is free software; you can redistribute it and/or modify it
 ![Simplified analysis model](img/ci_logo.svg){style="display: block; margin: 0 auto; border: 1px solid grey" }
 
 <p style="text-align: center;">Through the help of community leaders and policymakers, the mission of <a href="https://www.conservation.org/">Conservation International (CI)</a> is to combat climate
-change and preserve carbon stores. CI and the Climate Positive Land Use Strategy (CPLUS) project need the ability to spatially analyze a given area to determine the
+change and preserve carbon stores. CI and the Climate Positive Land Use Strategy (CPLUS) project need the ability to spatially analyse a given area to determine the
 best land use in order to naturally combat climate change and the effects thereof on a global scale.
 Further, reports need to be generated to communicate to stakeholders the importance of conserving
 and maintaining certain areas and the need to restore lost climate-positive environments. Thus,

diff --git a/docs/index.md b/docs/index.md
@@ -18,21 +18,21 @@ license: This program is free software; you can redistribute it and/or modify it
 
 The challenge of mitigating climate change and achieving global and national climate targets requires innovative and
 holistic approaches. In this pursuit, the Climate Positive Land Use Strategy (CPLUS) decision support tool has emerged
-as a crucial resource. CPLUS is a spatially-explicit roadmap designed to guide land-use planning strategies, utilizing
+as a crucial resource. CPLUS is a spatially-explicit roadmap designed to guide land-use planning strategies, utilising
 natural climate solutions to drive meaningful and sustainable change. The CPLUS decision support tool combines
-open-source technology, localized data sets, and modelled products to empower policymakers, land managers,
+open-source technology, localised data sets, and modelled products to empower policymakers, land managers,
 and stakeholders in making informed decisions. By integrating spatial information, such as land cover, carbon stocks,
 and potential for carbon sequestration, CPLUS enables the identification of key areas for intervention and investment.
-By prioritizing these nature-based interventions, CPLUS seeks to harness the power of ecosystems and optimize their
+By prioritising these nature-based interventions, CPLUS seeks to harness the power of ecosystems and optimise their
 climate mitigation potential.
 
 One of the distinguishing features of CPLUS is its ability to address both global and national climate targets.
 While global climate targets provide a broad framework for action, national targets require context-specific strategies
 tailored to the unique characteristics of each country. The CPLUS decision support tool considers these diverse factors
 and assists in designing land-use planning strategies that align with national commitments while contributing to global
-climate goals. Furthermore, CPLUS recognizes that effective land-use planning involves collaboration and engagement
+climate goals. Furthermore, CPLUS recognises that effective land-use planning involves collaboration and engagement
 among various stakeholders. It fosters dialogue and cooperation between governments, local communities, indigenous
-groups, conservation organizations, and private entities, facilitating the development of inclusive and equitable
+groups, conservation organisations, and private entities, facilitating the development of inclusive and equitable
 solutions. By involving diverse perspectives and expertise, CPLUS ensures that the decision-making process is
 participatory and informed by local knowledge.
 

diff --git a/docs/user/guide/img/plugin-step3_11.png b/docs/user/guide/img/plugin-step3_11.png
diff --git a/docs/user/guide/img/plugin-step3_12.png b/docs/user/guide/img/plugin-step3_12.png
diff --git a/docs/user/guide/img/plugin-step3_4.png b/docs/user/guide/img/plugin-step3_4.png
diff --git a/docs/user/guide/img/plugin-step3_5.png b/docs/user/guide/img/plugin-step3_5.png
diff --git a/docs/user/guide/img/plugin-step3_6.png b/docs/user/guide/img/plugin-step3_6.png
diff --git a/docs/user/guide/img/plugin-step3_7.png b/docs/user/guide/img/plugin-step3_7.png
diff --git a/docs/user/guide/img/plugin-step3_8.png b/docs/user/guide/img/plugin-step3_8.png
diff --git a/docs/user/guide/img/plugin-step3_9.png b/docs/user/guide/img/plugin-step3_9.png
diff --git a/docs/user/guide/settings.md b/docs/user/guide/settings.md
@@ -92,7 +92,7 @@ The `Sieve` function is a tool designed to filter raster data based on a specifi
 
 The sieve function is particularly useful in scenarios where a minimum spatial extent is necessary for practical or meaningful activities. For example:
 
--**Land Management:** Ensuring that only parcels of land larger than a hectare are considered for agricultural projects.
+- **Land Management:** Ensuring that only parcels of land larger than a hectare are considered for agricultural projects.
 
 - **Environmental Studies:** Filtering out small, insignificant areas from raster data to focus on larger, more relevant features.
 
@@ -204,7 +204,7 @@ Are you sure you want to delete the user [email protected]? All your tasks will be l
 
 Click on the `Reporting` option for reports-related settings. Under the Reporting settings, users can configure the information to be included in the generated reports. These settings include:
 
-- *Organization*: (optional) Organization or institute name.
+- *Organisation*: (optional) Organisation or institute name.
 
 - *Contact email*: (optional) Contact email of the user.
 

diff --git a/docs/user/guide/step-2.md b/docs/user/guide/step-2.md
@@ -78,7 +78,7 @@ For example, if you are creating an NCS pathway for Agroforestry, you would sele
 
 Once you have entered all the required details, click on the `OK` button to add the NCS pathway.
 
-### Methode 2 add using online default
+### Method 2 add using online default
 
 In this method, you will add a new NCS pathway using online defaults. This option is available if you have an account on the Trends.Earth platform.
 

diff --git a/docs/user/guide/step-3.md b/docs/user/guide/step-3.md
@@ -23,8 +23,50 @@ The final step deals with the **Weighting priorities** and **Priority groups**.
 
 *Figure 1: Step 3 allows the user to set the Weights of each Priority Group*
 
-The priority weighting layers can be selected, added and removed into each priority group by using the 
-arrow buttons. 
+## Priority groups
+
+ The `Priority groups` are used to assign weights to specific activities or layers based on their importance.
+
+## Add priority groups
+
+To add a new priority group, the user must click on the ![add button](img/symbologyAdd.svg) button, as shown  in **Figure 1**.
+
+This will open a `Priority Group Dialog` box, where user required to fill the following information.
+
+* **Group name:** Name of the group.
+* **Group description:** Description of the group.
+* **Group value:** Numeric value that reflect the importance of the priority layer.
+* **Assign priority layers:** Assign Priority Layers allows users to allocate importance values to different geographic layers.
+
+    * To assign a priority layer, click on the `Assign priority layers` and select from the available layers in the list.(see **Figure 3**)
+
+![Priority Dialog](./img/plugin-step3_11.png)
+
+*Figure 2: Priority  Group Dialog*
+
+After filling in the required information, click on the `OK` button to add it to the `Priority groups`.
+
+![Assign Priority Layer](./img/plugin-step3_12.png)
+
+*Figure 3: Assign priority layers*
+
+## Edit group layer
+
+Select the layer and click on the ![edit button](img/mActionToggleEditing.svg) icon. This will open the `Priority Group Dialog`, allowing you to edit the group name, group description, group value, and assign new priority layers. 
+
+![Priority Dialog](./img/plugin-step3_11.png)
+
+*Figure 4: Priority Group Dialog Edit*
+
+Click `OK` to apply the changes.
+
+## Remove group layer
+
+Select the layer and click on the ![remove button](img/symbologyRemove.svg) to remove the layer from the priority group.
+
+## Prority Weighting Layers
+
+The priority weighting layers can be selected, added and removed into each priority group by using the arrow buttons. 
 
 ## Add priority layers
 
@@ -38,7 +80,7 @@ Select the target layer from the priority weighting layers list from its priorit
 
 - Click on ![add button](img/symbologyAdd.svg) to add a new custom priority layer, or ![edit button](img/mActionToggleEditing.svg) to edit an existing priority layer.
 
-- This will open the Priority Layer dialog (see **Figure 2**).
+- This will open the Priority Layer dialog (see **Figure 5**).
 
 ## Methods to create layers
 
@@ -49,20 +91,19 @@ Select the target layer from the priority weighting layers list from its priorit
     - **Priority layer name**: A unique identifier for the priority layer.
     - **Priority layer description**: A detailed description of the priority layer.
 
-- Click the **Assign activities** button to select activities to be associated with the priority layer (see **Figure 3**)
+- Click the **Assign activities** button to select activities to be associated with the priority layer (see **Figure 6**)
 
 ![Priority layer editing/adding dialog](img/manual-priority-layer-dialog-1.png)
 
-*Figure 2: Priority layer dialog*
-
+*Figure 5: Priority layer dialog*
 
 - Select the activities you want to be associated with the priority layer.
 
 - Click **OK**.
 
 ![Priority layer editing/adding dialog](img/manual-pwl-selection.png)
 
-*Figure 3: Activity selection for priority layers*
+*Figure 6: Activity selection for priority layers*
 
 ### Method 2: Create Online
 
@@ -86,11 +127,11 @@ Select the target layer from the priority weighting layers list from its priorit
 
 - This will open the Financial priority layer dialog. By default, on first-time load, the NPV configurations for all activities are disabled.
 
-    ![NPV dialog](./img/plugin-step3_4.png)
+    ![NPV dialog](./img/plugin-step3_5.png)
 
 - To enable the NPV for an activity, check the NPV Priority Weighting Layer group box.
 
-    ![NPV configuration enable](./img/plugin-step3_5.png)
+    ![NPV configuration enable](./img/plugin-step3_4.png)
 
 - Enter the number of years and discount rate. Then, input the revenue and cost values for the respective years. The greyed out cells (i.e., Year and Discount Value) indicate that these values are automatically populated.
 

diff --git a/docs/user/manual/calculation-and-formula.md b/docs/user/manual/calculation-and-formula.md
@@ -61,15 +61,15 @@ where *CarbonCoefficient* is the carbon coefficient value multiplied with the av
 
 &emsp;&emsp;&nbsp;&nbsp;&nbsp; *n* is the number of carbon rasters.
 
-- The results from the above calculation are normalized to create the normalized NCS Weighted Carbon layer
-- A normalized raster's pixel values range from 0 to 1
-- Normalization is done as shown in **Equation 2**
+- The results from the above calculation are normalised to create the normalised NCS Weighted Carbon layer
+- A normalised raster's pixel values range from 0 to 1
+- Normalisation is done as shown in **Equation 2**
 
 $$
-\operatorname{Normalized NCS weighted carbon} =\frac{value - min}{max - min}
+\operatorname{Normalised NCS weighted carbon} =\frac{value - min}{max - min}
 $$
 
-*Equation 2: Normalized NCS weighted carbon*
+*Equation 2: Normalised NCS weighted carbon*
 
 where *value* is the pixel value;
 
@@ -79,7 +79,7 @@ where *value* is the pixel value;
 
 ### Activity
 
-- Because an activity can consist of multiple pathways, the normalized results will be summed
+- Because an activity can consist of multiple pathways, the normalised results will be summed
 - All NCS weighted carbon layers, as created from **Equation 2**, are summed as shown in **Equation 3** to
 create the activity from the pathways
 
@@ -93,8 +93,8 @@ where *NcsWeightedCarbon* is a pathway set up by the user; and
 
 &emsp;&emsp;&nbsp;&nbsp;&nbsp; *n* is the number of pathways.
 
-- Now that the pathways have been summed for the activity, the result needs to be normalized
-- The Suitability index and the Carbon coefficient then needs to be taken into account after the normalized raster
+- Now that the pathways have been summed for the activity, the result needs to be normalised
+- The Suitability index and the Carbon coefficient then needs to be taken into account after the normalised raster
 has been created
 - This calculation is shown in **Equation 4**
 

diff --git a/docs/user/manual/img/step-4-6.png b/docs/user/manual/img/step-4-6.png
diff --git a/docs/user/manual/img/step3-2.png b/docs/user/manual/img/step3-2.png
diff --git a/docs/user/manual/img/step3-3.png b/docs/user/manual/img/step3-3.png
diff --git a/docs/user/manual/img/step3-4.png b/docs/user/manual/img/step3-4.png
diff --git a/docs/user/manual/img/step3-8.png b/docs/user/manual/img/step3-8.png
diff --git a/docs/user/manual/settings.md b/docs/user/manual/settings.md
@@ -235,7 +235,7 @@ To go to the settings the user can click on the plugin toolbar icon to reveal th
 
 ![reporting settings](./img/setting-6.png)
 
-- *Organization*: (optional) Organization or institute name.
+- *Organisation*: (optional) Organisation or institute name.
 
 - *Contact email*: (optional) Contact email of the user.
 

diff --git a/docs/user/manual/step-3.md b/docs/user/manual/step-3.md
@@ -16,9 +16,15 @@ license: This program is free software; you can redistribute it and/or modify it
 
 ![UI Step 3](img/manual-step3.png)
 
-- **Priority groups**: Users can define different priority groups to which Priority Weighted Layers (PWLs) can be assigned. These groups represent different categories or themes that contribute to the overall analysis.
+- **Priority groups**: Users can define different priority groups to which Priority Weighting Layers (PWLs) can be assigned. These groups represent different categories or themes that contribute to the overall analysis.
 
-- **Priority weighted layers (PWL)**: Users can assign importance values to each priority group by associating them with Priority Weighted Layers. These layers represent the spatial data layers or attributes that contribute to the analysis.
+- ![add button](img/symbologyAdd.svg): Add a new Priority group.
+
+- ![edit button](img/mActionToggleEditing.svg): Edit the selected Priority group.
+
+- ![remove button](img/symbologyRemove.svg): Remove the selected Priority group.
+
+- **Priority weighting layers (PWL)**: Users can assign importance values to each priority group by associating them with Priority Weighted Layers. These layers represent the spatial data layers or attributes that contribute to the analysis.
 
 - ![right arrow](img/cplus_right_arrow.svg): Remove the selected PWL from the priority group.
 
@@ -28,38 +34,9 @@ license: This program is free software; you can redistribute it and/or modify it
 
 - ![add button](img/symbologyAdd.svg): Add a new PWL.
 
-- ![remove button](img/symbologyRemove.svg): Remove the selected PWL.
-
 - ![edit button](img/mActionToggleEditing.svg): Edit the selected PWL.
 
-## Methods to create layers
-
-### Method 1: Create manually 
-
-- The following parameters need to be set:
-    - **Priority layer**: The layer that represents the priority layer.
-    - **Priority layer name**: A unique identifier for the priority layer.
-    - **Priority layer description**: A detailed description of the priority layer.
-
-- Click the `Assign activities` button to select activities to be associated with the priority layer.
-
-![Priority Layer Dialog](img/step3-priority-layer-dialog-1.png)
-
-
-- Select the activities you want to be associated with the priority layer.
-
-- Click **OK**.
-
-![Multiple Item Selection](img/step3-multiple-item-selection.png)
-
-
-### Method 2: Create Online
-
-Click on the `Online defaults` to select the default priority layer from the available options.
-
-![Priority Layer Dialog](img/step3-priority-layer-dialog-2.png)
-
-- Then click **OK** to add the priority layer to PWL.
+- ![remove button](img/symbologyRemove.svg): Remove the selected PWL.
 
 ## Financial Priority Weighted Layer Editor dialog
 
@@ -99,40 +76,53 @@ The primary purpose of the NPV Tool is to help users prioritise activities by pr
 
 5. **Copy icon:** The user can copy the NPV by clicking on the copy icon available next to the net present value per hectare box.
 
-6. **Min/Max Normalization Range:** It is recommended to keep the `Use computed NPVs` check box enabled (default option). This ensures that the minimum and maximum normalisation values are synced and automatically updated based on user input. The min/max values will be based on enabled NPV parameters for activities. Disabled NPV parameters will be excluded from the computation.
+6. **User-defined NPV checkbox:** By enabling this checkbox we can manually set the `Net present value per hectare` value.
 
-7. **Remove Existing WPL Checkbox:** When the `Remove existing PWLs for disabled activity NPVs check box` is enabled, any previously created NPV PWLs will be deleted upon updating the NPVs.
+7. **Min/Max Normalisation Range:** It is recommended to keep the `Use computed NPVs` check box enabled (default option). This ensures that the minimum and maximum normalisation values are synced and automatically updated based on user input. The min/max values will be based on enabled NPV parameters for activities. Disabled NPV parameters will be excluded from the computation.
 
-8. **Update Button:** Click the `Update` button to show a dialog displaying the progress of creating/updating the NPVs.
+8. **Remove Existing WPL Checkbox:** When the `Remove existing PWLs for disabled activity NPVs check box` is enabled, any previously created NPV PWLs will be deleted upon updating the NPVs.
+
+9. **Cancel Button:** Click on the cancel button to cancel the adding NPV.
+
+10. **Update Button:** Click the `Update` button to show a dialog displaying the progress of creating/updating the NPVs.
 
     - When creating NPV PWL rasters, the corresponding PWLs will be created or updated in the list of PWLs.
     - The naming convention for these layers is `[activity name] NPV Norm`.
 
     ![Created NPV PWL](./img/step3-6.png)
 
-- An NPV layer, which is a constant raster containing the normalised value, will be created under the `{BASE_DIR}/priority_layers/npv` directory.
+    * An NPV layer, which is a constant raster containing the normalised value, will be created under the `{BASE_DIR}/priority_layers/npv` directory.
 
-- The extents are based on the user-defined extents specified in Step 1.
+    * The extents are based on the user-defined extents specified in Step 1.
 
 ![NPV directory](./img/step3-7.png)
 
-9. **Cancel Button:** Click on the cancel button to cancel the adding NPV.
+## Add new Priority Weighting Layer (PWL)
+
+![Add New PWL](./img/step3-8.png)
 
-## Priority Weighted Layers Editor dialog
+1. ![add button](img/symbologyAdd.svg): Allows users to add a new Priority Weighting Layer.
 
-![UI Priority layer dialog](img/manual-priority-layer-dialog.png)
+### Methods to create layers
 
-- **Priority layer**: Select the priority layer.
+#### Method 1: Create manually 
+
+- The following parameters need to be set:
+    - **Priority layer**: The layer that represents the priority layer.
+    - **Priority layer name**: A unique identifier for the priority layer.
+    - **Priority layer description**: A detailed description of the priority layer.
+
+- Click the `Assign activities` button to select activities to be associated with the priority layer.
+
+![Priority Layer Dialog](img/step3-priority-layer-dialog-1.png)
 
-- **Online Defaults**: Select priority layers from online defaults.
 
-- **Priority layer name**: A unique name for the priority layer.
+- Select the activities you want to be associated with the priority layer.
 
-- **Priority layer description**: A detailed description for the priority layer.
+- Click **OK**.
 
-- **Assign activities**: Selected activities associated with the priority layer.
+![Multiple Item Selection](img/step3-multiple-item-selection.png)
 
-![UI Priority layer dialog](img/manual-pwl-selection.png)
 
 - List of activities a user can select. Multiple activities can be selected.
 
@@ -144,6 +134,17 @@ The primary purpose of the NPV Tool is to help users prioritise activities by pr
 
 - **Toggle Selection**: Switches each option from deselected to selected, or selected to deselected.
 
+#### Method 2: Create Online
+
+Click on the `Online defaults` to select the default priority layer from the available options.
+
+![Priority Layer Dialog](img/step3-priority-layer-dialog-2.png)
+
+- Then click **OK** to add the priority layer to PWL.
+
+
+
+<!-- 
 ## Progress dialog
 
 ![Progress dialog](img/manual-processing-dialog.png)
@@ -176,4 +177,4 @@ Overall, Step 3 provides users with tools to assign priorities and weights to di
 
 Click [here](step-4.md) to explore the step 4 section.
 
-Click [here](logs.md) to explore the log section.
+Click [here](logs.md) to explore the log section. -->