Output unit for supply chains comparison

app/layout_elements.py

@@ -8,7 +8,11 @@
 
 
 def display_costs(
-    df_costs: pd.DataFrame, key: str, titlestring: str, key_suffix: str = ""
+    df_costs: pd.DataFrame,
+    key: str,
+    titlestring: str,
+    key_suffix: str = "",
+    output_unit: str | None = None,
 ):
     """Display costs as table and bar chart."""
     key_suffix = key_suffix.lower().replace(" ", "_")
@@ -49,6 +53,7 @@ def display_costs(
         fig = create_bar_chart_costs(
             df_res,
             current_selection=st.session_state[key],
+            output_unit=output_unit,
         )
         st.plotly_chart(fig, use_container_width=True)
 

app/plot_functions.py

@@ -348,7 +348,11 @@ def _make_costs_hoverdata(res_costs: pd.DataFrame) -> list[pd.Series]:
     return [custom_hover_data]
 
 
-def create_bar_chart_costs(res_costs: pd.DataFrame, current_selection: str = None):
+def create_bar_chart_costs(
+    res_costs: pd.DataFrame,
+    current_selection: str = None,
+    output_unit: str | None = None,
+):
     """Create bar plot for costs by components, and dots for total costs.
 
     Parameters
@@ -404,9 +408,11 @@ def create_bar_chart_costs(res_costs: pd.DataFrame, current_selection: str = Non
             ax=0,
             ay=-50,
         )
-    fig.update_layout(
-        yaxis_title=st.session_state["output_unit"],
-    )
+
+    if output_unit is None:
+        output_unit = st.session_state["output_unit"]
+
+    fig.update_layout(yaxis_title=output_unit)
     return fig
 
 

app/ptxboa_functions.py

@@ -38,35 +38,33 @@ def calculate_results_list(
     api: PtxboaAPI,
     parameter_to_change: str,
     parameter_list: list = None,
+    override_session_state: dict | None = None,
 ) -> pd.DataFrame:
     """Calculate results for source regions and one selected target country.
 
     Parameters
     ----------
-    _api : :class:`~ptxboa.api.PtxboaAPI`
+    api : :class:`~ptxboa.api.PtxboaAPI`
         an instance of the api class
-    settings : dict
-        settings from the streamlit app. An example can be obtained with the
-        return value from :func:`ptxboa_functions.create_sidebar`.
     parameter_to_change : str
         element of settings for which a list of values is to be used.
     parameter_list : list or None
         The values of ``parameter_to_change`` for which the results are calculated.
         If None, all values available in the API will be used.
+    override_session_state : dict or None
+        pass a dict with custom values in order to change the calculation parameters
+        obtained from st.session_state. I None, all parameters are taken from the
+        session state. Keys of the dictionary must in "chain", "country",
+        "output_unit", "region", "res_gen", "scenario", "secproc_co2",
+        "secproc_water", "ship_own_fuel", "transport".
 
     Returns
     -------
     pd.DataFrame
-        same format as for :meth:`~ptxboa.api.PtxboaAPI.calculate()`
+        wide format dataframe with index values from `parameter_to_change` and columns
+        containing the different cost components and a column for total costs "Total".
     """
-    res_list = []
-
-    if parameter_list is None:
-        parameter_list = api.get_dimension(parameter_to_change).index
-
-    # copy settings from session_state:
-    settings = {}
-    for key in [
+    setting_keys = [
         "chain",
         "country",
         "output_unit",
@@ -77,15 +75,30 @@ def calculate_results_list(
         "secproc_water",
         "ship_own_fuel",
         "transport",
-    ]:
-        settings[key] = st.session_state[key]
+    ]
+
+    # copy settings from session_state:
+    settings = {key: st.session_state[key] for key in setting_keys}
+
+    # update settings from session state with custom values
+    if override_session_state is not None:
+        if not set(override_session_state.keys()).issubset(set(setting_keys)):
+            msg = (
+                f"keys in 'override_session_state' must be in dict_keys({setting_keys})"
+                f" but are currently {override_session_state.keys()}"
+            )
+            raise ValueError(msg)
+        settings.update(override_session_state)
 
+    if parameter_list is None:
+        parameter_list = api.get_dimension(parameter_to_change).index
+
+    res_list = []
     for parameter in parameter_list:
-        settings2 = settings.copy()
-        settings2[parameter_to_change] = parameter
+        settings.update({parameter_to_change: parameter})
         res_single = calculate_results_single(
             api,
-            settings2,
+            settings,
             user_data=st.session_state["user_changes_df"],
         )
         res_list.append(res_single)

app/tab_dashboard.py

@@ -98,4 +98,6 @@ def content_dashboard(
         costs_per_res_gen, "res_gen", "Costs by renewable electricity source:"
     )
 
-    display_costs(costs_per_chain, "chain", "Costs by supply chain:")
+    display_costs(
+        costs_per_chain, "chain", "Costs by supply chain:", output_unit="USD/MWh"
+    )

ptxboa_streamlit.py

@@ -116,6 +116,7 @@
     api,
     parameter_to_change="chain",
     parameter_list=None,
+    override_session_state={"output_unit": "USD/MWh"},
 )
 
 # import context data: