Skip to content

Commit

Permalink
Update step 3-4 as per the new plugin version
Browse files Browse the repository at this point in the history
  • Loading branch information
ketankartoza committed Nov 20, 2024
1 parent 4bf808e commit fd48998
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 59 deletions.
Binary file added docs/user/manual/img/step-4-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/manual/img/step3-8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
77 changes: 35 additions & 42 deletions docs/user/manual/step-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +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.

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

Expand All @@ -38,35 +38,6 @@ license: This program is free software; you can redistribute it and/or modify it

- ![remove button](img/symbologyRemove.svg): Remove 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.

## Financial Priority Weighted Layer Editor dialog

The Net Present Value (NPV) Tool is designed to assist users in making informed financial decisions by evaluating and prioritising activities based on their projected cash flows and the time value of money. This manual provides comprehensive instructions on how to utilise the NPV tool effectively.
Expand Down Expand Up @@ -120,27 +91,38 @@ The primary purpose of the NPV Tool is to help users prioritise activities by pr

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

## Priority Weighted Layers Editor dialog
## Add new Priority Weighting Layer (PWL)

![Add New PWL](./img/step3-8.png)

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

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

- **Priority layer**: Select 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.

Expand All @@ -152,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)
Expand Down Expand Up @@ -184,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. -->
36 changes: 19 additions & 17 deletions docs/user/manual/step-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,27 @@ license: This program is free software; you can redistribute it and/or modify it

1. **Step 4:** `Step 4` guides the user to select the outputs to be saved into the file system for report generation. By clicking on the `Step 4` option, the user will navigate to the section dedicated to producing outputs. Here, the user finds a list of available outputs, each representing data that can be included in the report.

When the user selects an output, it signifies that the user wants it to be saved onto their file system, making it accessible beyond the current session. Conversely, leaving an option unselected means that the data will be stored as a memory layer, useful for temporary use within the current session.
When the user selects an output, it signifies that the user wants it to be saved onto their file system, making it accessible beyond the current session. Conversely, leaving an option unselected means that the data will be stored as a memory layer, useful for temporary use within the current session.

This step is crucial for tailoring the outputs to include only the necessary information, thereby optimising memory usage. By choosing specific outputs to be saved, the user can generate fewer output layers which utilises system resources more efficiently.
This step is crucial for tailoring the outputs to include only the necessary information, thereby optimising memory usage. By choosing specific outputs to be saved, the user can generate fewer output layers which utilises system resources more efficiently.

![Step 4](./img/step-4.png)
![Step 4](./img/step-4.png)

2. **Select Outputs**

There are 5 options available in the select outputs.

![Select options](./img/step-4-1.png)

1. **NCS With Carbon:** This output is initially unchecked by default. When selected, it triggers the generation of the NCS pathways output, providing insights into the pathways associated with NCS (Natural climate solution) and carbon sequestration.
**1. NCS With Carbon:** This output is initially unchecked by default. When selected, it triggers the generation of the NCS pathways output, providing insights into the pathways associated with NCS (Natural climate solution) and carbon sequestration.

2. **Landuse Activity:** Initially, this output is checked by default. It generates landuse activity layer outputs, providing valuable insights into various landuse activities. Users have the option to uncheck it if they do not wish to include landuse data in the report.
**2. Landuse Activity:** Initially, this output is checked by default. It generates landuse activity layer outputs, providing valuable insights into various landuse activities. Users have the option to uncheck it if they do not wish to include landuse data in the report.

3. **Landuse Activity Normalised:** By default, this output is checked. It generates landuse project normalised outputs, providing a normalised view of landuse activities for enhanced analysis. Users have the option to uncheck it if they do not wish to include landuse normalised data in the report.
**3. Landuse Activity Normalised:** By default, this output is checked. It generates landuse project normalised outputs, providing a normalised view of landuse activities for enhanced analysis. Users have the option to uncheck it if they do not wish to include landuse normalised data in the report.

4. **Landuse Activity Weighted with PWL (Priority weighted layers):** By default, this output is checked. It generates landuse projects weighted outputs. Unselecting this option will disable report generation this is because the weighted output is the required output for report generation.
**4. Landuse Activity Weighted with PWL (Priority weighted layers):** By default, this output is checked. It generates landuse projects weighted outputs. Unselecting this option will disable report generation this is because the weighted output is the required output for report generation.

5. **Scenario Highest Position analysis:** By default, this output is checked. It generates the final highest position analysis outputs. Unselecting this option will disable report generation this is because the highest position analysis output is the required output for report generation.
**5. Scenario Highest Position analysis:** By default, this output is checked. It generates the final highest position analysis outputs. Unselecting this option will disable report generation this is because the highest position analysis output is the required output for report generation.

3. **Processing Options**

Expand All @@ -44,7 +44,7 @@ This step is crucial for tailoring the outputs to include only the necessary inf

![Processing option](./img/step-4-2.png)

1. **Process the scenario online:** By default, this option is unchecked. When the user selects this option, the scenario is processed online using the API. This means that the system sends the scenario data to a remote server or service via the Internet. The remote server performs the necessary computations or analysis based on the provided scenario data. Processing online allows for real-time analysis and can leverage the computing power and resources available on the remote server. This option might be preferred when the user requires quicker results or when the scenario data is too large or complex to be processed efficiently on the user's local device. However, processing online may require a stable internet connection.
* **Process the scenario online:** By default, this option is unchecked. When the user selects this option, the scenario is processed online using the API. This means that the system sends the scenario data to a remote server or service via the Internet. The remote server performs the necessary computations or analysis based on the provided scenario data. Processing online allows for real-time analysis and can leverage the computing power and resources available on the remote server. This option might be preferred when the user requires quicker results or when the scenario data is too large or complex to be processed efficiently on the user's local device. However, processing online may require a stable internet connection.

*If the user has previously selected `Online defaults`, this option will be selected automatically.*

Expand All @@ -54,21 +54,23 @@ This step is crucial for tailoring the outputs to include only the necessary inf

![Processing option](./img/step-4-3.png)

1. **Progress Bar:** Upon clicking this button, a pop-up window will appear, displaying a progress bar indicating the report generation status.
**1. Progress Bar:** Upon clicking this button, a pop-up window will appear, displaying a progress bar indicating the report generation status.

2. **View Report Dropdown:** Once the report is generated, the user can click on the `View Report` dropdown, to view the options.
**2. View Report Dropdown:** Once the report is generated, the user can click on the `View Report` dropdown, to view the options.

The following options are available there.
The following options are available there.

- **Layout designer:** Opens the report in the QGIS layout designer.
![View Report Dropdown](./img/step-4-6.png)

- **Open PDF:** Opens the created PDF.
- **Layout designer:** Opens the report in the QGIS layout designer.

- **Help:** Takes the user to the User's documentation site.
- **Open PDF:** Opens the created PDF.

- **Help:** Takes the user to the User's documentation site.

3. **Hide:** This option hides the Progress Dialog Box.
**3. Hide:** This option hides the Progress Dialog Box.

4. **Cancel:** Click on the `Cancel` button to terminate the report generation process. Upon clicking this button, it will transform into the `Close` button. Click on the `Close` button to dismiss the pop-up window.
**4. **Cancel:** Click on the `Cancel` button to terminate the report generation process. Upon clicking this button, it will transform into the `Close` button. Click on the `Close` button to dismiss the pop-up window.

### View Task Status Online
After clicking on the `Hide` button this button will be enabled to view the task status.
Expand Down

0 comments on commit fd48998

Please sign in to comment.