More in-software user guidance

Author: bsteubing

activity_browser/app/ui/tabs/LCA_setup.py

@@ -17,6 +17,7 @@
     CSActivityTable, CSList, CSMethodsTable, PresamplesList, ScenarioImportTable
 )
 from ..widgets import ExcelReadDialog
+from .base import BaseRightTab
 
 """
 Lifecycle of a calculation setup
@@ -281,16 +282,26 @@ def enable_calculations(self):
         self.scenario_calc_btn.setEnabled(valid_cs)
 
 
-class ScenarioImportPanel(QtWidgets.QWidget):
+class ScenarioImportPanel(BaseRightTab):
     MAX_TABLES = 5
 
     """Special kind of QWidget that contains one or more tables side by side."""
     def __init__(self, parent=None):
         super().__init__(parent)
 
+        self.explain_text = """
+        <p>You can import two different scenario types here:</p>
+        <p>1. <b>flow-scenarios</b>: flow scenarios are alternative values for exchanges (flows between processes or between processes and the environment)</p>
+        <p>2. <b>parameter-scenarios</b>: alternative values for parameters you use within a project</p>
+        <p>If you do not know how such files look like, you can go to the Parameters --> Scenarios tab.
+         Then click "Export parameter-scenarios" to obtain a parameter-scenarios file or  
+         "Export as flow-scenarios" to obtain a flow-scenarios file. 
+         Note that you need to have at least one parameterized activity to obtain flow-scenarios</p>
+        """
+
         self.tables = []
         layout = QtWidgets.QVBoxLayout()
-        row = QtWidgets.QHBoxLayout()
+
         self.scenario_tables = QtWidgets.QHBoxLayout()
         self.table_btn = QtWidgets.QPushButton(qicons.add, "Add")
 
@@ -311,11 +322,16 @@ def __init__(self, parent=None):
         input_field_layout.addWidget(self.addition_choice)
         self.group_box.setHidden(True)
 
-        row.addWidget(header("Scenarios"))
+        row = QtWidgets.QToolBar()
+        row.addWidget(header("Scenarios:"))
+        row.addAction(
+            qicons.question, "Scenarios help",
+            self.explanation
+        )
         row.addWidget(self.table_btn)
         row.addWidget(self.group_box)
-        row.addStretch(1)
-        layout.addLayout(row)
+        # row.addStretch(1)
+        layout.addWidget(row)
         layout.addLayout(self.scenario_tables)
         layout.addStretch(1)
         self.setLayout(layout)

activity_browser/app/ui/tabs/parameters.py

@@ -276,13 +276,13 @@ class ParameterScenariosTab(BaseRightTab):
     def __init__(self, parent=None):
         super().__init__(parent)
 
-        self.load_btn = QPushButton(qicons.add, "Import table from excel")
+        self.load_btn = QPushButton(qicons.add, "Import parameter-scenarios")
         self.save_btn = QPushButton(
             self.style().standardIcon(QStyle.SP_DialogSaveButton),
-            "Export table to excel"
+            "Export parameter-scenarios"
         )
         self.calculate_btn = QPushButton(
-            qicons.calculate, "Process table and export"
+            qicons.calculate, "Export as flow-scenarios"
         )
         self.hide_group = QCheckBox("Show group column")
 
@@ -293,18 +293,18 @@ def __init__(self, parent=None):
 
         self.explain_text = """
     <p>This tab has 3 functions:</p>
-    <p>1. <b> Export table to excel </b> : this exports the table as shown below to an Excel file. You can modify it there and use 
+    <p>1. <b> Export parameter-scenarios </b> : this exports the table as shown below to an Excel file. You can modify it there and use 
     it in scenario LCAs (see Calculation Setup tab)</p>
-    <p>2. <b>Import table from excel</b>: imports a table like the one shown below from Excel. If parameters are missing in Excel, 
+    <p>2. <b>Import parameter-scenarios</b>: imports a table like the one shown below from Excel. If parameters are missing in Excel, 
     the default values will be used. IMPORTANT NOTE: the ONLY function this button serves is to display the Excel file. 
     If you want to use the Excel file in scenario LCA, please import it in the Calculation Setup tab.</p>
-    <p>3. <b>Process table and export</b>: This converts a "parameter-scenarios" file (alternative values for parameters) to a 
+    <p>3. <b>Export as flow-scenarios</b>: This converts a "parameter-scenarios" file (alternative values for parameters) to a 
     "flow-scenarios" file (alternative values for the exchanges as used in LCA calculations).</p>
 
-    <p><b>Suggested workflow to create scenarios for your parameters</b>:</p>
-    <p>Export table to excel. Add scenarios (columns). You may want to delete rows that you intend to change or rows that 
-    are for dependent parameters (those that depend on other parameters) as these values will be overwritten by the formulas. 
-    Finally, import the parameter-scenarios in the Calculation Setup to perform scenario calculations.</p>
+    <p><b>Suggested <i>workflow</i> to create scenarios for your parameters</b>:</p>
+    <p>Export parameter-scenarios. This will generate an Excel file for you where you can add scenarios (columns). 
+    You may want to delete rows that you intend to change or rows that are for dependent parameters (those that depend on other parameters) as these values will be overwritten by the formulas. 
+    Finally, import the parameter-scenarios in the <i>Calculation Setup</i> (not here!) to perform scenario calculations (you need to select "Scenario-based LCA").</p>
     
     <p>For more information on this topic see also the 
     <a href="https://2.docs.brightway.dev/intro.html#parameterized-datasets">Brightway2 documentation</a>.</p>