From 1fa09f880bc73d90b97e6a4723148987012e436d Mon Sep 17 00:00:00 2001
From: marc-vdm <m.t.van.der.meide@cml.leidenuniv.nl>
Date: Mon, 2 Dec 2024 09:49:26 +0100
Subject: [PATCH] Flow Scenario wiki + update scenario help-menu

---
 activity_browser/docs/wiki/Flow-Scenarios.md  |  26 ++++++++++++++++--
 .../wiki/assets}/sdf_addition_combination.png | Bin
 .../wiki/assets}/sdf_product_combination.png  | Bin
 activity_browser/layouts/tabs/LCA_setup.py    |   8 ++++--
 4 files changed, 29 insertions(+), 5 deletions(-)
 rename {resources => activity_browser/docs/wiki/assets}/sdf_addition_combination.png (100%)
 rename {resources => activity_browser/docs/wiki/assets}/sdf_product_combination.png (100%)

diff --git a/activity_browser/docs/wiki/Flow-Scenarios.md b/activity_browser/docs/wiki/Flow-Scenarios.md
index 217adf203..64e2e3036 100644
--- a/activity_browser/docs/wiki/Flow-Scenarios.md
+++ b/activity_browser/docs/wiki/Flow-Scenarios.md
@@ -4,10 +4,32 @@
 > Please help us improve the wiki by reading our
 > [contributing guidelines](https://github.com/LCA-ActivityBrowser/activity-browser/blob/main/CONTRIBUTING.md#wiki).
 
-### Video overview of modelling and calculating scenarios
+
+## Combining Scenario Files
+You can work with multiple scenario files for which there are with two options:
+
+### Product combinations
+The option `Combine scenarios` will calculate every combination between scenarios, it adds more scenarios. 
+This yields all possible scenario combinations, e.g. file 1: <i>A, B</i> and file 2: <i>X, Y</i> yields <i>A-X, A-Y, 
+B-X and B-Y</i>, as shown in the figure below. 
+
+![SDF product combination](./assets/sdf_product_combination.png)
+
+### Extend combinations
+The option `Extend scenarios` will combine scenarios with the same name into a larger single scenario, 
+it makes the existing scenarios larger.
+Scenarios from file 2 extend scenarios of file 1, e.g.  file 1: <i>A, B</i> and file 2: <i>A, B</i> yields <i>A-B</i>,
+as shown in the figure below.
+
+> [!IMPORTANT]
+> This is only possible if scenario names are **identical** in all files, e.g. everywhere <i>A, B</i>).
+
+![SDF extend combination](./assets/sdf_addition_combination.png)
+
+## Video overview of modelling and calculating scenarios
 
 [![Projects and Databases](https://img.youtube.com/vi/3LPcpV1G_jg/hqdefault.jpg)](https://www.youtube.com/watch?v=3LPcpV1G_jg)
 
 <sup>
 <b>Note:</b> some content of the video may be outdated. Written content should be more up-to-date.
-</sup>
\ No newline at end of file
+</sup>
diff --git a/resources/sdf_addition_combination.png b/activity_browser/docs/wiki/assets/sdf_addition_combination.png
similarity index 100%
rename from resources/sdf_addition_combination.png
rename to activity_browser/docs/wiki/assets/sdf_addition_combination.png
diff --git a/resources/sdf_product_combination.png b/activity_browser/docs/wiki/assets/sdf_product_combination.png
similarity index 100%
rename from resources/sdf_product_combination.png
rename to activity_browser/docs/wiki/assets/sdf_product_combination.png
diff --git a/activity_browser/layouts/tabs/LCA_setup.py b/activity_browser/layouts/tabs/LCA_setup.py
index 8889e8828..ff10c5678 100644
--- a/activity_browser/layouts/tabs/LCA_setup.py
+++ b/activity_browser/layouts/tabs/LCA_setup.py
@@ -276,7 +276,9 @@ def __init__(self, parent=None):
         (<i>scenario difference files</i>)</p>
         <p>2. <b>Parameter-scenarios</b>: alternative values for parameters <i>(parameter scenarios files)</i></p>
 
-        Further information is provided in this <a href="https://www.youtube.com/watch?v=3LPcpV1G_jg">video</a>. 
+        Further information is provided on this wiki page for  
+        <a href="https://github.com/LCA-ActivityBrowser/activity-browser/wiki/Flow-Scenarios">Flow Scenarios</a> and 
+        <a href="https://github.com/LCA-ActivityBrowser/activity-browser/wiki/Parameters">Parameter Scenarios</a>. 
 
         <p>If you need a template for these files, you can go to the <i>Parameters > Scenarios tab</i>. 
         Then click <i>Export parameter-scenarios</i> to obtain a parameter-scenarios file or   
@@ -286,11 +288,11 @@ def __init__(self, parent=None):
         <br> <p> You can also work with <b>multiple scenario files</b> for which there are with two options:</p>
         <p>1. <b>Combine scenarios</b>: this yields all possible scenario combinations 
         (e.g. file 1: <i>S1, S2</i> and file 2: <i>A, B</i> yields <i>S1-A, S1-B, S2-A, S2-B</i>) 
-        Click <a href="https://github.com/LCA-ActivityBrowser/activity-browser/blob/main/resources/sdf_product_combination.png"> here </a>
+        Click <a href="https://github.com/LCA-ActivityBrowser/activity-browser/wiki/Flow-Scenarios#Product-combinations"> here </a>
         for an example</p>
         <p>2. <b>Extend scenarios</b>: scenarios from file 2 extend scenarios of file 1 
         (only possible if scenario names are identical in all files, e.g. everywhere <i>S1, S2</i>).
-        Click <a href="https://github.com/LCA-ActivityBrowser/activity-browser/blob/main/resources/sdf_addition_combinations.png"> here
+        Click <a href="https://github.com/LCA-ActivityBrowser/activity-browser/wiki/Flow-Scenarios#Extend-combinations"> here
         </a> for an example</p> 
         """