diff --git a/docs/about/ci.md b/docs/about/ci.md index f7b455985..0a9cd1b6c 100644 --- a/docs/about/ci.md +++ b/docs/about/ci.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Conservation International ![Simplified analysis model](img/ci_logo.svg){style="display: block; margin: 0 auto; border: 1px solid grey" } diff --git a/docs/about/kartoza.md b/docs/about/kartoza.md index 729076b11..152d4b9e1 100644 --- a/docs/about/kartoza.md +++ b/docs/about/kartoza.md @@ -1,3 +1,16 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + + # Kartoza ![Simplified analysis model](img/kartoza_logo.svg){style="display: block; margin: 0 auto; border: 1px solid grey; width: 50%; height: 50%"} diff --git a/docs/administrator/guide/index.md b/docs/administrator/guide/index.md index 77f0f06b7..21a981295 100644 --- a/docs/administrator/guide/index.md +++ b/docs/administrator/guide/index.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Administrators guide ## Pilot area data diff --git a/docs/administrator/index.md b/docs/administrator/index.md index b609c5b21..1514bf28d 100644 --- a/docs/administrator/index.md +++ b/docs/administrator/index.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Administrators This section is for administrators of the plugin: diff --git a/docs/administrator/repository/index.md b/docs/administrator/repository/index.md index a24dad6cc..06e846bd6 100644 --- a/docs/administrator/repository/index.md +++ b/docs/administrator/repository/index.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + diff --git a/docs/developer/api/core/api_conf.md b/docs/developer/api/core/api_conf.md index 0a8d6b589..f8098892e 100644 --- a/docs/developer/api/core/api_conf.md +++ b/docs/developer/api/core/api_conf.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Configuration ::: src.cplus_plugin.conf diff --git a/docs/developer/api/core/api_financials.md b/docs/developer/api/core/api_financials.md index 2ab8eba70..388e3b2dc 100644 --- a/docs/developer/api/core/api_financials.md +++ b/docs/developer/api/core/api_financials.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Financial Helper Functions ::: src.cplus_plugin.lib.financials diff --git a/docs/developer/api/core/api_main.md b/docs/developer/api/core/api_main.md index cd5dba1aa..3f08a4066 100644 --- a/docs/developer/api/core/api_main.md +++ b/docs/developer/api/core/api_main.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Main ::: src.cplus_plugin.main.QgisCplus diff --git a/docs/developer/api/core/api_report_scenario_comparison_table.md b/docs/developer/api/core/api_report_scenario_comparison_table.md index a67239bc6..06dd66184 100644 --- a/docs/developer/api/core/api_report_scenario_comparison_table.md +++ b/docs/developer/api/core/api_report_scenario_comparison_table.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Scenario Comparison Table Generator ::: src.cplus_plugin.lib.reports.comparison_table diff --git a/docs/developer/api/core/api_reports_generator.md b/docs/developer/api/core/api_reports_generator.md index f615818a9..4f6f7720a 100644 --- a/docs/developer/api/core/api_reports_generator.md +++ b/docs/developer/api/core/api_reports_generator.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Report Generator ::: src.cplus_plugin.lib.reports.generator diff --git a/docs/developer/api/core/api_reports_layout_items.md b/docs/developer/api/core/api_reports_layout_items.md index 32e8a4518..305dc53de 100644 --- a/docs/developer/api/core/api_reports_layout_items.md +++ b/docs/developer/api/core/api_reports_layout_items.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Layout Items ::: src.cplus_plugin.lib.reports.layout_items diff --git a/docs/developer/api/core/api_reports_manager.md b/docs/developer/api/core/api_reports_manager.md index 5c35be4e2..311ca7960 100644 --- a/docs/developer/api/core/api_reports_manager.md +++ b/docs/developer/api/core/api_reports_manager.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Report Manager ::: src.cplus_plugin.lib.reports.manager diff --git a/docs/developer/api/core/api_reports_variables.md b/docs/developer/api/core/api_reports_variables.md index 50bf2ec6f..f85224595 100644 --- a/docs/developer/api/core/api_reports_variables.md +++ b/docs/developer/api/core/api_reports_variables.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Variable Register ::: src.cplus_plugin.lib.reports.variables diff --git a/docs/developer/api/core/api_settings.md b/docs/developer/api/core/api_settings.md index 345bfc531..d8384cff4 100644 --- a/docs/developer/api/core/api_settings.md +++ b/docs/developer/api/core/api_settings.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Settings ::: src.cplus_plugin.gui.settings diff --git a/docs/developer/api/core/api_tasks.md b/docs/developer/api/core/api_tasks.md index 05053e037..4671a8c3a 100644 --- a/docs/developer/api/core/api_tasks.md +++ b/docs/developer/api/core/api_tasks.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Processing Tasks ::: src.cplus_plugin.tasks diff --git a/docs/developer/api/core/api_utils.md b/docs/developer/api/core/api_utils.md index 6a11f6312..752bbcbb6 100644 --- a/docs/developer/api/core/api_utils.md +++ b/docs/developer/api/core/api_utils.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Utilities ::: src.cplus_plugin.utils diff --git a/docs/developer/api/core/api_validation_configs.md b/docs/developer/api/core/api_validation_configs.md index 2aa42c5b9..4d751a503 100644 --- a/docs/developer/api/core/api_validation_configs.md +++ b/docs/developer/api/core/api_validation_configs.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Validation Configurations ::: src.cplus_plugin.lib.validation.configs diff --git a/docs/developer/api/core/api_validation_feedback.md b/docs/developer/api/core/api_validation_feedback.md index 709fcbd4f..2f7530f73 100644 --- a/docs/developer/api/core/api_validation_feedback.md +++ b/docs/developer/api/core/api_validation_feedback.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Validation Feedback ::: src.cplus_plugin.lib.validation.feedback diff --git a/docs/developer/api/core/api_validation_manager.md b/docs/developer/api/core/api_validation_manager.md index e0a5d8554..ddbd73c42 100644 --- a/docs/developer/api/core/api_validation_manager.md +++ b/docs/developer/api/core/api_validation_manager.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Validation Manager ::: src.cplus_plugin.lib.validation.manager diff --git a/docs/developer/api/core/api_validation_validators.md b/docs/developer/api/core/api_validation_validators.md index e3c26b2fe..08678962a 100644 --- a/docs/developer/api/core/api_validation_validators.md +++ b/docs/developer/api/core/api_validation_validators.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Data Validators ::: src.cplus_plugin.lib.validation.validators diff --git a/docs/developer/api/gui/api_activity_editor_dialog.md b/docs/developer/api/gui/api_activity_editor_dialog.md index 1acee85ee..e8c567173 100644 --- a/docs/developer/api/gui/api_activity_editor_dialog.md +++ b/docs/developer/api/gui/api_activity_editor_dialog.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Activity editor ::: src.cplus_plugin.gui.activity_editor_dialog diff --git a/docs/developer/api/gui/api_activity_widget.md b/docs/developer/api/gui/api_activity_widget.md index 458b5e81c..97f476e03 100644 --- a/docs/developer/api/gui/api_activity_widget.md +++ b/docs/developer/api/gui/api_activity_widget.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Activity widget ::: src.cplus_plugin.gui.activity_widget diff --git a/docs/developer/api/gui/api_carbon_layer_model.md b/docs/developer/api/gui/api_carbon_layer_model.md index 449edcce9..deef261bc 100644 --- a/docs/developer/api/gui/api_carbon_layer_model.md +++ b/docs/developer/api/gui/api_carbon_layer_model.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Carbon Layer Model ::: src.cplus_plugin.gui.carbon_item_model diff --git a/docs/developer/api/gui/api_component_items.md b/docs/developer/api/gui/api_component_items.md index 8e21ef3ee..1fa9146b5 100644 --- a/docs/developer/api/gui/api_component_items.md +++ b/docs/developer/api/gui/api_component_items.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Component item model ::: src.cplus_plugin.gui.component_item_model diff --git a/docs/developer/api/gui/api_gui_main.md b/docs/developer/api/gui/api_gui_main.md index 446a5e29f..d1bb21bb4 100644 --- a/docs/developer/api/gui/api_gui_main.md +++ b/docs/developer/api/gui/api_gui_main.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # GUI main ::: src.cplus_plugin.gui.qgis_cplus_main diff --git a/docs/developer/api/gui/api_items_selection_dialog.md b/docs/developer/api/gui/api_items_selection_dialog.md index d1d5c5707..a7ce57bdb 100644 --- a/docs/developer/api/gui/api_items_selection_dialog.md +++ b/docs/developer/api/gui/api_items_selection_dialog.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Items selection dialog ::: src.cplus_plugin.gui.items_selection_dialog diff --git a/docs/developer/api/gui/api_map_repeat_item_widget.md b/docs/developer/api/gui/api_map_repeat_item_widget.md index 9e87fd419..a58c72774 100644 --- a/docs/developer/api/gui/api_map_repeat_item_widget.md +++ b/docs/developer/api/gui/api_map_repeat_item_widget.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Map repeat item widget ::: src.cplus_plugin.gui.map_repeat_item_widget diff --git a/docs/developer/api/gui/api_model_component_widget.md b/docs/developer/api/gui/api_model_component_widget.md index d75bcbf77..6619570b5 100644 --- a/docs/developer/api/gui/api_model_component_widget.md +++ b/docs/developer/api/gui/api_model_component_widget.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Model component widget ::: src.cplus_plugin.gui.model_component_widget diff --git a/docs/developer/api/gui/api_ncs_pathway_editor.md b/docs/developer/api/gui/api_ncs_pathway_editor.md index 8b4d6f73b..a10e5efb4 100644 --- a/docs/developer/api/gui/api_ncs_pathway_editor.md +++ b/docs/developer/api/gui/api_ncs_pathway_editor.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # NCS pathway editor ::: src.cplus_plugin.gui.ncs_pathway_editor_dialog diff --git a/docs/developer/api/gui/api_npv_financial_model.md b/docs/developer/api/gui/api_npv_financial_model.md index b1a8e54cd..42d5fa1c2 100644 --- a/docs/developer/api/gui/api_npv_financial_model.md +++ b/docs/developer/api/gui/api_npv_financial_model.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # NPV Parameters View Model ::: src.cplus_plugin.gui.financials.npv_financial_model diff --git a/docs/developer/api/gui/api_npv_manager_dialog.md b/docs/developer/api/gui/api_npv_manager_dialog.md index 9c5b55dac..4c32bf812 100644 --- a/docs/developer/api/gui/api_npv_manager_dialog.md +++ b/docs/developer/api/gui/api_npv_manager_dialog.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # NPV Priority Weighting Layer Manager Dialog ::: src.cplus_plugin.gui.financials.npv_manager_dialog diff --git a/docs/developer/api/gui/api_npv_progress_dialog.md b/docs/developer/api/gui/api_npv_progress_dialog.md index 5e75d670f..4ca450b2a 100644 --- a/docs/developer/api/gui/api_npv_progress_dialog.md +++ b/docs/developer/api/gui/api_npv_progress_dialog.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # NPV Progress Dialog ::: src.cplus_plugin.gui.financials.npv_progress_dialog diff --git a/docs/developer/api/gui/api_pixel_value_editor.md b/docs/developer/api/gui/api_pixel_value_editor.md index 936c8fd51..1850209c4 100644 --- a/docs/developer/api/gui/api_pixel_value_editor.md +++ b/docs/developer/api/gui/api_pixel_value_editor.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Style pixel value editor ::: src.cplus_plugin.gui.pixel_value_editor_dialog diff --git a/docs/developer/api/gui/api_priority_group.md b/docs/developer/api/gui/api_priority_group.md index ecf42e37f..90368c0f6 100644 --- a/docs/developer/api/gui/api_priority_group.md +++ b/docs/developer/api/gui/api_priority_group.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Priority group ::: src.cplus_plugin.gui.priority_group_widget diff --git a/docs/developer/api/gui/api_priority_layer.md b/docs/developer/api/gui/api_priority_layer.md index 9f4af3225..c18bd8ca8 100644 --- a/docs/developer/api/gui/api_priority_layer.md +++ b/docs/developer/api/gui/api_priority_layer.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Priority weighting layer dialog ::: src.cplus_plugin.gui.priority_layer_dialog diff --git a/docs/developer/api/gui/api_progress_dialog.md b/docs/developer/api/gui/api_progress_dialog.md index 9e3239f1a..30bbc95f8 100644 --- a/docs/developer/api/gui/api_progress_dialog.md +++ b/docs/developer/api/gui/api_progress_dialog.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Progress dialog ::: src.cplus_plugin.gui.progress_dialog diff --git a/docs/developer/api/gui/api_validation_inspector_dialog.md b/docs/developer/api/gui/api_validation_inspector_dialog.md index 607fdb3fd..5d0618b13 100644 --- a/docs/developer/api/gui/api_validation_inspector_dialog.md +++ b/docs/developer/api/gui/api_validation_inspector_dialog.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Validation Inspector Dialog ::: src.cplus_plugin.gui.validation.inspector_dialog diff --git a/docs/developer/api/gui/api_validation_progress_dialog.md b/docs/developer/api/gui/api_validation_progress_dialog.md index 7254ef8ea..02b81f22b 100644 --- a/docs/developer/api/gui/api_validation_progress_dialog.md +++ b/docs/developer/api/gui/api_validation_progress_dialog.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Validation Progress Dialog ::: src.cplus_plugin.gui.validation.progress_dialog diff --git a/docs/developer/api/gui/api_validation_result_items.md b/docs/developer/api/gui/api_validation_result_items.md index 614b5a603..551bfcb23 100644 --- a/docs/developer/api/gui/api_validation_result_items.md +++ b/docs/developer/api/gui/api_validation_result_items.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Tree Result Items ::: src.cplus_plugin.gui.validation.result_items diff --git a/docs/developer/api/models/api_base.md b/docs/developer/api/models/api_base.md index 4dfa6b890..5135f316f 100644 --- a/docs/developer/api/models/api_base.md +++ b/docs/developer/api/models/api_base.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Model base ::: src.cplus_plugin.models.base diff --git a/docs/developer/api/models/api_financials.md b/docs/developer/api/models/api_financials.md index c04398a49..ca52ae2b0 100644 --- a/docs/developer/api/models/api_financials.md +++ b/docs/developer/api/models/api_financials.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Financial Data Classes ::: src.cplus_plugin.models.financial diff --git a/docs/developer/api/models/api_helpers.md b/docs/developer/api/models/api_helpers.md index c3d0eb4be..efb228c82 100644 --- a/docs/developer/api/models/api_helpers.md +++ b/docs/developer/api/models/api_helpers.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Helpers ::: src.cplus_plugin.models.helpers diff --git a/docs/developer/api/models/api_report.md b/docs/developer/api/models/api_report.md index 69120ba22..c1725964a 100644 --- a/docs/developer/api/models/api_report.md +++ b/docs/developer/api/models/api_report.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Report ::: src.cplus_plugin.models.report diff --git a/docs/developer/api/models/api_validation.md b/docs/developer/api/models/api_validation.md index 396b4dec3..2f87f20ed 100644 --- a/docs/developer/api/models/api_validation.md +++ b/docs/developer/api/models/api_validation.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Validation Data Classes ::: src.cplus_plugin.models.validation diff --git a/docs/developer/architecture/index.md b/docs/developer/architecture/index.md index d36b2e065..19ba64fdb 100644 --- a/docs/developer/architecture/index.md +++ b/docs/developer/architecture/index.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Architecture ## Frameworks used diff --git a/docs/developer/documentation/index.md b/docs/developer/documentation/index.md index aa762ff2f..45fa2c015 100644 --- a/docs/developer/documentation/index.md +++ b/docs/developer/documentation/index.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Working with documentation Documentation is written using mkdocs. diff --git a/docs/developer/index.md b/docs/developer/index.md index 406522396..12f1b33cd 100644 --- a/docs/developer/index.md +++ b/docs/developer/index.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Developers Section which aims at guiding developers of the plugin: diff --git a/docs/developer/setup/index.md b/docs/developer/setup/index.md index b5132bee2..fd830e789 100644 --- a/docs/developer/setup/index.md +++ b/docs/developer/setup/index.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Setup ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ConservationInternational/cplus-plugin/ci.yml?branch=master) diff --git a/docs/index.md b/docs/index.md index ad3f81307..ff62b18a0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # CPLUS QGIS plugin ![CPLUS add implementation model](img/home-plugin-screenshot.png) diff --git a/docs/user/guide/complete-steps-and-report.md b/docs/user/guide/complete-steps-and-report.md index c8ee4d51e..a5c8bc11c 100644 --- a/docs/user/guide/complete-steps-and-report.md +++ b/docs/user/guide/complete-steps-and-report.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Steps 1 to 3 example The following recording (**Figure 1**) shows an example of how to do steps 1, 2 and 3. This is based on the pilot study area. diff --git a/docs/user/guide/img/logs-1.png b/docs/user/guide/img/logs-1.png index 3497bf470..f555ccd86 100644 Binary files a/docs/user/guide/img/logs-1.png and b/docs/user/guide/img/logs-1.png differ diff --git a/docs/user/guide/img/logs-11.png b/docs/user/guide/img/logs-11.png new file mode 100644 index 000000000..37f1794e2 Binary files /dev/null and b/docs/user/guide/img/logs-11.png differ diff --git a/docs/user/guide/img/logs-12.png b/docs/user/guide/img/logs-12.png new file mode 100644 index 000000000..c29954a84 Binary files /dev/null and b/docs/user/guide/img/logs-12.png differ diff --git a/docs/user/guide/img/logs-13.png b/docs/user/guide/img/logs-13.png new file mode 100644 index 000000000..c82368d25 Binary files /dev/null and b/docs/user/guide/img/logs-13.png differ diff --git a/docs/user/guide/img/logs-2.png b/docs/user/guide/img/logs-2.png index 8a1e8f2f9..ffaf2ccf4 100644 Binary files a/docs/user/guide/img/logs-2.png and b/docs/user/guide/img/logs-2.png differ diff --git a/docs/user/guide/img/manual-priority-layer-dialog-1.png b/docs/user/guide/img/manual-priority-layer-dialog-1.png new file mode 100644 index 000000000..06f43b8c2 Binary files /dev/null and b/docs/user/guide/img/manual-priority-layer-dialog-1.png differ diff --git a/docs/user/guide/img/manual-priority-layer-dialog-2.png b/docs/user/guide/img/manual-priority-layer-dialog-2.png new file mode 100644 index 000000000..3ff01cd96 Binary files /dev/null and b/docs/user/guide/img/manual-priority-layer-dialog-2.png differ diff --git a/docs/user/guide/img/manual-priority-layer-dialog-3.png b/docs/user/guide/img/manual-priority-layer-dialog-3.png new file mode 100644 index 000000000..2dec2a3e7 Binary files /dev/null and b/docs/user/guide/img/manual-priority-layer-dialog-3.png differ diff --git a/docs/user/guide/img/manual-priority-layer-dialog-4.png b/docs/user/guide/img/manual-priority-layer-dialog-4.png new file mode 100644 index 000000000..0ab0e652f Binary files /dev/null and b/docs/user/guide/img/manual-priority-layer-dialog-4.png differ diff --git a/docs/user/guide/img/manual-priority-layer-dialog.png b/docs/user/guide/img/manual-priority-layer-dialog.png deleted file mode 100644 index 8a637c0f0..000000000 Binary files a/docs/user/guide/img/manual-priority-layer-dialog.png and /dev/null differ diff --git a/docs/user/guide/img/scenario-progress-dialog.png b/docs/user/guide/img/scenario-progress-dialog.png new file mode 100644 index 000000000..22f44a770 Binary files /dev/null and b/docs/user/guide/img/scenario-progress-dialog.png differ diff --git a/docs/user/guide/img/step4-1.png b/docs/user/guide/img/step4-1.png index 962d47918..dfaff9b3f 100644 Binary files a/docs/user/guide/img/step4-1.png and b/docs/user/guide/img/step4-1.png differ diff --git a/docs/user/guide/img/step4-3.png b/docs/user/guide/img/step4-3.png index c77fd894f..4514c6883 100644 Binary files a/docs/user/guide/img/step4-3.png and b/docs/user/guide/img/step4-3.png differ diff --git a/docs/user/guide/img/step4-5.png b/docs/user/guide/img/step4-5.png new file mode 100644 index 000000000..163afbfee Binary files /dev/null and b/docs/user/guide/img/step4-5.png differ diff --git a/docs/user/guide/img/step4-6.png b/docs/user/guide/img/step4-6.png new file mode 100644 index 000000000..0531731f2 Binary files /dev/null and b/docs/user/guide/img/step4-6.png differ diff --git a/docs/user/guide/img/step4-7.png b/docs/user/guide/img/step4-7.png new file mode 100644 index 000000000..8701fde65 Binary files /dev/null and b/docs/user/guide/img/step4-7.png differ diff --git a/docs/user/guide/img/step4-8.png b/docs/user/guide/img/step4-8.png new file mode 100644 index 000000000..0f417ded6 Binary files /dev/null and b/docs/user/guide/img/step4-8.png differ diff --git a/docs/user/guide/img/step4-layout-designer.png b/docs/user/guide/img/step4-layout-designer.png new file mode 100644 index 000000000..027efef71 Binary files /dev/null and b/docs/user/guide/img/step4-layout-designer.png differ diff --git a/docs/user/guide/img/step4-report-pdf.png b/docs/user/guide/img/step4-report-pdf.png new file mode 100644 index 000000000..91646cad7 Binary files /dev/null and b/docs/user/guide/img/step4-report-pdf.png differ diff --git a/docs/user/guide/index.md b/docs/user/guide/index.md index 8890f3987..bd49fba29 100644 --- a/docs/user/guide/index.md +++ b/docs/user/guide/index.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Cplus User Guide Welcome to the Cplus user guide. In this section of the documentation, we aim to show users how to utilise the plugin effectively, customise their settings and so forth. Here is a brief overview of the content provided here: diff --git a/docs/user/guide/logs.md b/docs/user/guide/logs.md index 09a6729df..0c7556292 100644 --- a/docs/user/guide/logs.md +++ b/docs/user/guide/logs.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Log Welcome to the `Log Tab!` This section provides comprehensive insights into scenario history and processing logs. Here is a quick guide to navigating this feature. @@ -10,6 +22,26 @@ Click on the 1️⃣ `Log` option to access the log tab. This section displays a record of past scenarios executed within the system. +### Offline Scenarios + +- In this scenario, reports are stored locally and can be accessed even when the system is offline. + +- To view the offline report, the user has to select the report and then click on `refresh` button, this will load the scenario. + +![Scenario History](./img/logs-11.png) + +### Online Scenarios + +- In this scenario, reports are generated and stored on the server. + +- To view the online report, the user has to select the report and then click on the `refresh` button, this will load the scenario. + +![Scenario History](./img/logs-12.png) + +- After the successful completion of report generation via running the scenario online, the user will receive an email confirming the successful completion of the report. + +![Scenario Email](./img/logs-13.png) + ### Buttons Available **Plus Icon:** Click this button to save the scenario to the history section for review and analysis. @@ -18,6 +50,8 @@ This section displays a record of past scenarios executed within the system. **Information Icon:** Click here to access helpful information and tips related to the selected scenario. +**Scenario Comparison Report:** This button allows you to generate comparison report based on the selected scenarios. + **Minus Icon:** Remove specific scenarios from the history section to streamline displayed records. ![Scenario history](./img/logs-2.png) diff --git a/docs/user/guide/preparing-data.md b/docs/user/guide/preparing-data.md index 7bc3849c8..6e492261a 100644 --- a/docs/user/guide/preparing-data.md +++ b/docs/user/guide/preparing-data.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Preparing data Data preparation is an important step before performing data analysis. This is especially true for spatial data (rasters and vector layers), as many factors play a role in the result. Here are some factors that need to be considered: diff --git a/docs/user/guide/settings.md b/docs/user/guide/settings.md index aef01c0d2..a9c222da6 100644 --- a/docs/user/guide/settings.md +++ b/docs/user/guide/settings.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # How to apply CPLUS settings? The CPLUS settings provide users with a customizable interface to configure various aspects of the platform according to their needs and preferences. Users can access the CPLUS settings through either the QGIS options or the CPLUS toolbar. diff --git a/docs/user/guide/step-1.md b/docs/user/guide/step-1.md index 3aa10f27c..573cb55b2 100644 --- a/docs/user/guide/step-1.md +++ b/docs/user/guide/step-1.md @@ -1,3 +1,14 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- # Step 1: Scenario Information diff --git a/docs/user/guide/step-2.md b/docs/user/guide/step-2.md index 88350c742..0b25f04bc 100644 --- a/docs/user/guide/step-2.md +++ b/docs/user/guide/step-2.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Step 2: Pathways and activities This step deals with the **Natural Climate Solution (NCS) pathways** and the **Activities**. An NCS pathway can be defined as a composite spatial layer on specific land use classes and other factors that determine areas ideal for a specific use case (e.g. Animal management). An activity is a combination of NCS pathways represented in an AOI spatial layer. **Figure 1** shows the UI. diff --git a/docs/user/guide/step-3.md b/docs/user/guide/step-3.md index 522c7ecff..91cdf8cbc 100644 --- a/docs/user/guide/step-3.md +++ b/docs/user/guide/step-3.md @@ -1,9 +1,20 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Step 3: Priority weighting The final step deals with the **Weighting priorities** and **Priority groups**. These weights will be applied when the user starts running the scenario. An example is shown in **Figure 1**. - Weight values range from 0 to 5, and affect how important a PWL is compared to other layers. - - A value of 0 indicates that the PWL has a lower importance. - A value of 5 means that the PWL has a higher importance @@ -28,26 +39,45 @@ 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**). + +## 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 (see **Figure 3**) -![Priority layer editing/adding dialog](img/manual-priority-layer-dialog.png) +![Priority layer editing/adding dialog](img/manual-priority-layer-dialog-1.png) *Figure 2: 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* +### Method 2: Create Online + +![Priority layer editing/adding dialog](img/manual-priority-layer-dialog-2.png) + +- After clicking on this option a drop down menu will appear with the available online defaults. + +![Priority layer editing/adding dialog](img/manual-priority-layer-dialog-3.png) + +- Select the desired online default. + +![Priority layer editing/adding dialog](img/manual-priority-layer-dialog-4.png) + +- Then click on the 1️⃣ `OK` button, to add the priority layer to PWL. + - ![remove button](img/symbologyRemove.svg): Remove the selected PWL. ## Create a new financial priority layer Net Present Value (NPV) diff --git a/docs/user/guide/step-4.md b/docs/user/guide/step-4.md index 2740e5197..48dd65ed1 100644 --- a/docs/user/guide/step-4.md +++ b/docs/user/guide/step-4.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Step4: Select outputs and Processing options Click on the 1️⃣ `Step 4` option, to go to Step 4. @@ -18,10 +30,42 @@ Click on the 1️⃣ `Step 4` option, to go to Step 4. ![Processing Options](./img/step4-3.png) -## Run Scenario +If `Online defaults` is choosen previously then this option will be automatically selected. -**Run Scenario:** Click on the `Run Scenario` button to execute the scenario and generate the report. +## Run Scenario +**Run Scenario:** Click on the `Run Scenario` button to execute the scenario and generate the report.A progress bar will appear, showing the status of the processing. ![Run Scenario](./img/step4-4.png) + +**Scenario Progress Dialog:** This dialog box shows the progress of the scenario execution. + +![Scenario-progress-dialog](img/scenario-progress-dialog.png) +- **Hide** - Hide the dialog box. + +After hiding the dialog box, the `View Online Task Status` button will be enabled to check the status of the task. + +![Processing Option](img/step4-5.png) + +Click on the `View Online Task Status` button to check the status of the task. + +![Processing Option](img/step4-6.png) + +## View Report +Once the scenario is processed, you can view the report by clicking on the `View Report` button. + +![View Report](img/step4-7.png) + +Click on the `View Report` button, it will display a dropdown menu to view the report. + +![View Report Dialog](img/step4-8.png) + +1. **Layout designer**: Opens the report in the QGIS layout designer. + +![Layout Designer](img/step4-layout-designer.png) + +2. **Open PDF**: Opens the created PDF. + +![Report Pdf](img/step4-report-pdf.png) + Click [here](logs.md) to explore the log section. diff --git a/docs/user/index.md b/docs/user/index.md index cdcb24989..600c8a698 100644 --- a/docs/user/index.md +++ b/docs/user/index.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Users The following sections aims at guiding and helping a user on how to use the plugin. This is split into three sections: diff --git a/docs/user/manual/calculation-and-formula.md b/docs/user/manual/calculation-and-formula.md index a8bbb2dd0..be6240c5e 100644 --- a/docs/user/manual/calculation-and-formula.md +++ b/docs/user/manual/calculation-and-formula.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Manual The manual covers two sections. Firstly the workflow will be covered. This includes a discussion of the calculations diff --git a/docs/user/manual/img/2024-09-20_15-07.png b/docs/user/manual/img/2024-09-20_15-07.png new file mode 100644 index 000000000..993a00c8c Binary files /dev/null and b/docs/user/manual/img/2024-09-20_15-07.png differ diff --git a/docs/user/manual/img/logs-1.png b/docs/user/manual/img/logs-1.png index 266bad279..8548b932e 100644 Binary files a/docs/user/manual/img/logs-1.png and b/docs/user/manual/img/logs-1.png differ diff --git a/docs/user/manual/img/logs-13.png b/docs/user/manual/img/logs-13.png new file mode 100644 index 000000000..c82368d25 Binary files /dev/null and b/docs/user/manual/img/logs-13.png differ diff --git a/docs/user/manual/img/logs-2.png b/docs/user/manual/img/logs-2.png index 90b93958d..8f9c534f4 100644 Binary files a/docs/user/manual/img/logs-2.png and b/docs/user/manual/img/logs-2.png differ diff --git a/docs/user/manual/img/manual-priority-layer-dialog.png b/docs/user/manual/img/manual-priority-layer-dialog.png index 8a637c0f0..06f43b8c2 100644 Binary files a/docs/user/manual/img/manual-priority-layer-dialog.png and b/docs/user/manual/img/manual-priority-layer-dialog.png differ diff --git a/docs/user/manual/img/manual-processing-dialog.png b/docs/user/manual/img/manual-processing-dialog.png index 76f666516..5b07c96e0 100644 Binary files a/docs/user/manual/img/manual-processing-dialog.png and b/docs/user/manual/img/manual-processing-dialog.png differ diff --git a/docs/user/manual/img/step-4-2.png b/docs/user/manual/img/step-4-2.png index f537d41c5..84719fe26 100644 Binary files a/docs/user/manual/img/step-4-2.png and b/docs/user/manual/img/step-4-2.png differ diff --git a/docs/user/manual/img/step-4-3.png b/docs/user/manual/img/step-4-3.png index 69712eb91..197619694 100644 Binary files a/docs/user/manual/img/step-4-3.png and b/docs/user/manual/img/step-4-3.png differ diff --git a/docs/user/manual/img/step-4-4.png b/docs/user/manual/img/step-4-4.png index e8eddd6eb..3af11d736 100644 Binary files a/docs/user/manual/img/step-4-4.png and b/docs/user/manual/img/step-4-4.png differ diff --git a/docs/user/manual/img/step-4-5.png b/docs/user/manual/img/step-4-5.png new file mode 100644 index 000000000..c5038a0d3 Binary files /dev/null and b/docs/user/manual/img/step-4-5.png differ diff --git a/docs/user/manual/img/step-4.png b/docs/user/manual/img/step-4.png index 2356cb89d..d84f4220c 100644 Binary files a/docs/user/manual/img/step-4.png and b/docs/user/manual/img/step-4.png differ diff --git a/docs/user/manual/img/step3-multiple-item-selection.png b/docs/user/manual/img/step3-multiple-item-selection.png new file mode 100644 index 000000000..b86c28e97 Binary files /dev/null and b/docs/user/manual/img/step3-multiple-item-selection.png differ diff --git a/docs/user/manual/img/step3-priority-layer-dialog-1.png b/docs/user/manual/img/step3-priority-layer-dialog-1.png new file mode 100644 index 000000000..389464900 Binary files /dev/null and b/docs/user/manual/img/step3-priority-layer-dialog-1.png differ diff --git a/docs/user/manual/img/step3-priority-layer-dialog-2.png b/docs/user/manual/img/step3-priority-layer-dialog-2.png new file mode 100644 index 000000000..c5646c5cc Binary files /dev/null and b/docs/user/manual/img/step3-priority-layer-dialog-2.png differ diff --git a/docs/user/manual/index.md b/docs/user/manual/index.md index 5e3e1e45e..bab4f6f97 100644 --- a/docs/user/manual/index.md +++ b/docs/user/manual/index.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # User Manual Welcome to the Cplus-plugins user manual. This section of the documentation describes every step in the plugin and what the various steps of that plugin do. You may prefer to work through our [user guide](../guide/index.md). Here is a brief overview of the content provided here: diff --git a/docs/user/manual/logs.md b/docs/user/manual/logs.md index c20078f30..9deb6e79a 100644 --- a/docs/user/manual/logs.md +++ b/docs/user/manual/logs.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Logs User Manual ![Log](./img/logs-1.png) @@ -6,6 +18,24 @@ 2. **Scenario History:** In this section, users can explore the history of previously executed scenarios. It serves as an archive of past processing scenarios, allowing users to review, analyse, and reference historical data. Users can retrieve valuable information about past activities, outcomes, and trends, facilitating informed decision-making and performance evaluation. The scenario history provides a comprehensive overview of past system activities, offering insights into long-term patterns and performance metrics. +- **Offline Scenarios :** In this scenario, reports are stored locally and can be accessed even when the system is offline. To view the offline scenario, the user has to select the report and then click on `refresh` button, this will load the scenario and display on the map canvas. + +- **Online Scenarios :** The stored online scenarios in the log help users load and analyse scenarios they have run online. To view the online scenario, the user has to select the report and then click on the `refresh` button, this will load the scenario and display on the map canvas. + + Benefits of storing logs of online scenarios: + + - Keep track of executed scenarios. + + - Allow users to review and analyze previously run scenarios. + + - Provide a record for troubleshooting and auditing purposes. + + - Facilitate comparison between different scenarios for better decision-making. + + *After the completion of report generation, the user will receive an email confirming the successful completion of the report.* + + ![Scenario Email](./img/logs-13.png) + ![Scenario history](./img/logs-2.png) Once the scenario is completed that scenario history will be shown in the scenario history section. @@ -21,6 +51,7 @@ - **Scenario Comparison Report:** This feature allows users to run scenario comparisons, and generate comparison reports. These reports are saved in the base data directory specified in the CPLUS plugin settings. **Run the Scenario:** Ensure the scenario runs successfully. + **Save Scenario History:** Click on the plus icon (+) to save the scenario history into the logs. The user can save the scenario after the scenario runs successfully. ![Comparison report](./img/logs-5.png) @@ -63,7 +94,7 @@ - **Minus Icon:** The minus icon serves the purpose of removing the scenario from the scenario history section. Clicking on this icon allows users to delete specific scenarios from the history, streamlining the displayed records to focus on relevant information. -3. **Processing Scenario Logs:** This section provides a detailed record of logs about the ongoing processing scenario. It offers real-time insights into the actions, events, and outcomes within the current scenario. Users can monitor the progress, identify any errors or issues, and troubleshoot accordingly. These logs are essential for tracking the execution flow and diagnosing any anomalies during the processing workflow. +1. **Processing Scenario Logs:** This section provides a detailed record of logs about the ongoing processing scenario. It offers real-time insights into the actions, events, and outcomes within the current scenario. Users can monitor the progress, identify any errors or issues, and troubleshoot accordingly. These logs are essential for tracking the execution flow and diagnosing any anomalies during the processing workflow. ![Processing log](./img/logs-3.png) diff --git a/docs/user/manual/scenario-file.md b/docs/user/manual/scenario-file.md index 366f5917e..07acb0160 100644 --- a/docs/user/manual/scenario-file.md +++ b/docs/user/manual/scenario-file.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Scenario files The scenario files are stored in the base directory of the system. The base directory can be configured from the settings. You can refer to the [Settings Documentation](./settings.md) for detailed instructions on how to set the base directory. diff --git a/docs/user/manual/settings.md b/docs/user/manual/settings.md index 8d28e68fa..538e8502e 100644 --- a/docs/user/manual/settings.md +++ b/docs/user/manual/settings.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Settings To go to the settings the user can click on the plugin toolbar icon to reveal the option. diff --git a/docs/user/manual/step-1.md b/docs/user/manual/step-1.md index c46e73148..f97174cf8 100644 --- a/docs/user/manual/step-1.md +++ b/docs/user/manual/step-1.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Step 1: Scenario information Step 1 of the process involves setting up the scenario details and parameters. Users are provided with several options to define the scenario: diff --git a/docs/user/manual/step-2.md b/docs/user/manual/step-2.md index d3932807e..2ef9e2f38 100644 --- a/docs/user/manual/step-2.md +++ b/docs/user/manual/step-2.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Step 2: NCS Pathways and Activities `Step 2` focuses on the activities and pathways. Step 2 of the process revolves around configuring NCS (Natural Climate Solutions) pathways and activities. This step is crucial for defining the activities to be performed and pathways to be followed during the analysis. diff --git a/docs/user/manual/step-3.md b/docs/user/manual/step-3.md index 0155f2f40..1382573c3 100644 --- a/docs/user/manual/step-3.md +++ b/docs/user/manual/step-3.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Step 3: Weighting priorities `Step 3` focuses on weighting priorities, which involves assigning importance to different priority groups and weighted layers. This step is critical for determining the relative significance of various factors in the analysis. @@ -20,6 +32,35 @@ - ![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. + ## 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. @@ -83,6 +124,8 @@ The primary purpose of the NPV Tool is to help users prioritise activities by pr - **Priority layer**: Select the priority layer. +- **Online Defaults**: Select priority layers from online defaults. + - **Priority layer name**: A unique name for the priority layer. - **Priority layer description**: A detailed description for the priority layer. @@ -111,6 +154,8 @@ The primary purpose of the NPV Tool is to help users prioritise activities by pr - **View Report**: This button will remain disabled until the processing is done. +- **Hide**: This button will hide the progress dialog. + - **Cancel**: Clicking this button will stop the processing. - **Close**: Only visible once the processing stops. Will close the progress dialog. diff --git a/docs/user/manual/step-4.md b/docs/user/manual/step-4.md index 90c45cb36..ef5e1d15a 100644 --- a/docs/user/manual/step-4.md +++ b/docs/user/manual/step-4.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Step4: Select outputs and processing options 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. @@ -33,6 +45,8 @@ 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. + + *If the user has previously selected `Online defaults`, this option will be selected automatically.* 4. **Run Scenario:** @@ -51,9 +65,18 @@ This step is crucial for tailoring the outputs to include only the necessary inf - **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. + + 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. + + ![View Task Online Button](img/step-4-4.png) - 3. **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. + Click on the `View Task Online button` to view the task status. - ![Close action](./img/step-4-4.png) + ![Processing Dialog](img/step-4-5.png) Click [here](logs.md) to explore the log section. diff --git a/docs/user/quickstart/index.md b/docs/user/quickstart/index.md index c32570386..aa2dbdfa1 100644 --- a/docs/user/quickstart/index.md +++ b/docs/user/quickstart/index.md @@ -1,3 +1,15 @@ +--- +title: Conservation International +summary: + - Jeremy Prior + - Ketan Bamniya +date: +some_url: +copyright: +contact: +license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. +--- + # Quick start Instructions for a user on how to get the plugin working. First section deals with QGIS, and what versions