clean up/isolate CSV-specific disambiguation

Author: iboyd-ansys

src/ansys/systemcoupling/core/adaptor/impl/injected_commands.py

@@ -228,14 +228,12 @@ def _create_plot_spec(
             continue
         intf_spec = InterfaceSpec(interface_name, interface_disp_name)
         spec.interfaces.append(intf_spec)
-        transfer_disp_names = [
-            interface_object.data_transfer[trans_name].display_name
-            for trans_name in transfer_names
-        ]
-        for transfer in transfer_disp_names:
+        for trans_name in transfer_names:
+            disp_name = interface_object.data_transfer[trans_name].display_name
             intf_spec.transfers.append(
                 DataTransferSpec(
-                    display_name=transfer,
+                    name=trans_name,
+                    display_name=disp_name,
                     show_convergence=show_convergence,
                     show_transfer_values=show_transfer_values,
                 )

src/ansys/systemcoupling/core/charts/chart_datatypes.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2023 - 2026 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -22,7 +22,6 @@
 
 from dataclasses import dataclass, field
 from enum import Enum
-from typing import Optional
 
 """Common data types for the storage of metadata and data for chart series.
 
@@ -51,10 +50,10 @@ class TransferSeriesInfo:
         The display name of the data transfer. This is a primary identifier for data
         transfers because CSV data sources do not currently include information about
         the underlying data model names of data transfers.
-    disambiguation_index: int
-        This should be set to 0, unless there is more than one data transfer with the
-        same display name. A contiguous range of indexes starting at 0 should be assigned
-        to the list of data transfers with the same display name.
+    transfer_id : str
+        The internal unique identifier of the data transfer. This could be the internal
+        datamodel name. In the CSV case, the internal name cannot be determined from the
+        data, so an ID based on the display name and an integer suffix is used.
     participant_display_name : str, optional
         The display name of the participant. This is required for transfer value series
         but not for convergence series.
@@ -68,10 +67,10 @@ class TransferSeriesInfo:
 
     series_type: SeriesType
     transfer_display_name: str
-    disambiguation_index: int
+    transfer_id: str
     # Remainder for non-CONVERGENCE series only
-    participant_display_name: Optional[str] = None
-    component_suffix: Optional[str] = None
+    participant_display_name: str | None = None
+    component_suffix: str | None = None
 
 
 @dataclass

src/ansys/systemcoupling/core/charts/csv_chartdata.py

@@ -56,7 +56,7 @@ def read_data(self) -> bool:
             return True  # File exists - haven't necessarily read anything yet
         except FileNotFoundError:
             # It is expected that the file is not necessarily immediately available
-            print(f"Failed to open {self._file_or_filename}")
+            # print(f"Failed to open {self._file_or_filename}")
             return False
         except Exception as e:
             # Temporary - see if anything else goes wrong
@@ -234,7 +234,6 @@ def parse_csv_metadata(interface_name: str, headers: list[str]) -> InterfaceInfo
     intf_info.is_transient = headers[2] == "Time"
 
     start_index = 3 if intf_info.is_transient else 2
-    prev_part_name = ""
 
     transfer_disambig: dict[str, int] = {}
     for i in range(start_index, len(headers)):
@@ -265,8 +264,7 @@ def parse_csv_metadata(interface_name: str, headers: list[str]) -> InterfaceInfo
             series_info = TransferSeriesInfo(
                 series_type=series_type,
                 transfer_display_name=trans_disp_name,
-                # get(..., 0) for case where transfer_disambig empty (see note above)
-                disambiguation_index=transfer_disambig.get(trans_disp_name, 0),
+                transfer_id=f"{trans_disp_name}:{transfer_disambig.get(trans_disp_name, 0)}",
             )
             intf_info.transfer_info.append(series_info)
         else:
@@ -275,7 +273,7 @@ def parse_csv_metadata(interface_name: str, headers: list[str]) -> InterfaceInfo
                 TransferSeriesInfo(
                     series_type=series_type,
                     transfer_display_name=trans_disp_name,
-                    disambiguation_index=transfer_disambig.get(trans_disp_name, 0),
+                    transfer_id=f"{trans_disp_name}:{transfer_disambig.get(trans_disp_name, 0)}",
                     participant_display_name=part_disp_name,
                     component_suffix=_parse_suffix(header, part_disp_name) or None,
                 )

src/ansys/systemcoupling/core/charts/plot_functions.py

@@ -54,8 +54,10 @@ def cancel(self) -> None: ...
     def read_data(self) -> None: ...
 
 
-def _create_and_show_impl(spec: PlotSpec, readers: list[ChartDataReader]) -> Plotter:
-    manager = PlotDefinitionManager(spec)
+def _create_and_show_impl(
+    spec: PlotSpec, readers: list[ChartDataReader], is_csv_source: bool = False
+) -> Plotter:
+    manager = PlotDefinitionManager(spec, is_csv_source=is_csv_source)
     plotter = Plotter(manager)
 
     for ireader, reader in enumerate(readers):
@@ -89,15 +91,16 @@ def create_and_show_plot_csv(spec: PlotSpec, csv_list: list[str]) -> Plotter:
         CsvChartDataReader(intf.name, csvfile)
         for intf, csvfile in zip(spec.interfaces, csv_list)
     ]
-    return _create_and_show_impl(spec, readers)
+    return _create_and_show_impl(spec, readers, is_csv_source=True)
 
 
 def _solve_with_live_plot_impl(
     spec,
     make_live_data_source: Callable[[str, Callable], LiveDataSource],
     solve_func: Callable[[], None],
+    is_csv_source: bool = False,
 ):
-    manager = PlotDefinitionManager(spec)
+    manager = PlotDefinitionManager(spec, is_csv_source=is_csv_source)
     dispatcher = MessageDispatcher()
     plotter = Plotter(manager, request_update=dispatcher.dispatch_messages)
     dispatcher.set_plotter(plotter)
@@ -138,6 +141,7 @@ def solve_with_live_plot_csv(
             interface_names, csv_list, put_msg
         ),
         solve_func,
+        is_csv_source=True,
     )
 
     # Show a non-blocking static plot

src/ansys/systemcoupling/core/charts/plotdefinition_manager.py

@@ -21,7 +21,6 @@
 # SOFTWARE.
 
 from dataclasses import dataclass, field
-from typing import Optional
 
 from ansys.systemcoupling.core.charts.chart_datatypes import InterfaceInfo, SeriesType
 
@@ -31,6 +30,7 @@ class DataTransferSpec:
     # It's not ideal, but we have to work in terms of display names for transfers,
     # as that is all we have in the data (the CSV data, at least).
     # TODO: add optional internal name field which we will use if provided.
+    name: str
     display_name: str
     show_convergence: bool = True
     show_transfer_values: bool = True
@@ -100,12 +100,15 @@ class SubplotDefinition:
 
 
 class SubplotManager:
-    def __init__(self, is_transient: bool, intf_spec: InterfaceSpec):
+    def __init__(
+        self, is_transient: bool, intf_spec: InterfaceSpec, is_csv_source: bool = False
+    ):
         self._is_time: bool = is_transient
         self._intf_spec = intf_spec
+        self._is_csv_source = is_csv_source
 
         self._conv_subplot: SubplotDefinition | None = None
-        self._transfer_subplots: dict[tuple[str, int], SubplotDefinition] = {}
+        self._transfer_subplots: dict[str, SubplotDefinition] = {}
         self._subplots: list[SubplotDefinition] = []
         self._data_index_map: dict[int, tuple[SubplotDefinition, int]] = {}
         self._allocate_subplots()
@@ -116,7 +119,7 @@ def subplots(self) -> list[SubplotDefinition]:
 
     def subplot_for_data_index(
         self, data_index: int
-    ) -> tuple[Optional[SubplotDefinition], int]:
+    ) -> tuple[SubplotDefinition | None, int]:
         """Return the subplot definition, and the line index within the
         subplot, corresponding to a given ``data_index``.
 
@@ -166,10 +169,16 @@ def _allocate_subplots(self):
         keep_conv = False
         transfer_disambig: dict[str, int] = {}
         for transfer in self._intf_spec.transfers:
-            if transfer.display_name in transfer_disambig:
-                transfer_disambig[transfer.display_name] += 1
-            else:
-                transfer_disambig[transfer.display_name] = 0
+            if self._is_csv_source:
+                # In the CSV case, we have to create a unique ID for each transfer
+                # based on display name and an integer suffix, because we don't
+                # have internal names in the data. 'transfer_disambig' keeps track of
+                # how many times we've seen a given display name so far and we use that
+                # to create the unique ID.
+                if transfer.display_name in transfer_disambig:
+                    transfer_disambig[transfer.display_name] += 1
+                else:
+                    transfer_disambig[transfer.display_name] = 0
             if transfer.show_convergence:
                 keep_conv = True
             if transfer.show_transfer_values:
@@ -180,12 +189,12 @@ def _allocate_subplots(self):
                     x_axis_label="Time" if self._is_time else "Iteration",
                     y_axis_label="",
                 )
-                transfer_subplots[
-                    (
-                        transfer.display_name,
-                        transfer_disambig[transfer.display_name],
-                    )
-                ] = transfer_value
+                if self._is_csv_source:
+                    disambig = transfer_disambig.get(transfer.display_name, 0)
+                    transfer_id = f"{transfer.display_name}:{disambig}"
+                else:
+                    transfer_id = transfer.name
+                transfer_subplots[transfer_id] = transfer_value
                 subplots.append(transfer_value)
         if keep_conv:
             self._conv_subplot = conv
@@ -194,9 +203,7 @@ def _allocate_subplots(self):
         self._subplots = [subplot for subplot in subplots if subplot is not None]
         for i, subplot in enumerate(self._subplots):
             subplot.index = i
-        self._transfer_subplots: dict[tuple[str, int], SubplotDefinition] = (
-            transfer_subplots
-        )
+        self._transfer_subplots: dict[str, SubplotDefinition] = transfer_subplots
 
     def set_metadata(self, metadata: InterfaceInfo):
         """Reconcile the metadata for a single interface with the pre-allocated
@@ -231,10 +238,7 @@ def set_metadata(self, metadata: InterfaceInfo):
         transfer_value_line_count: dict[tuple[str, int], int] = {}
 
         for data_index, transfer in enumerate(metadata.transfer_info):
-            transfer_key = (
-                transfer.transfer_display_name,
-                transfer.disambiguation_index,
-            )
+            transfer_key = transfer.transfer_id
             if transfer.series_type == SeriesType.CONVERGENCE:
                 if transfer.transfer_display_name not in active_transfers:
                     # We don't want this transfer on the convergence plot
@@ -252,9 +256,7 @@ def set_metadata(self, metadata: InterfaceInfo):
                 self._conv_subplot.series_labels.append(transfer.transfer_display_name)
                 iconv += 1
             else:
-                transfer_value_subplot = self._transfer_subplots.get(
-                    (transfer_key[0], transfer_key[1])
-                )
+                transfer_value_subplot = self._transfer_subplots.get(transfer_key)
                 if transfer_value_subplot:
                     value_type = (
                         "Sum"
@@ -282,14 +284,16 @@ def set_metadata(self, metadata: InterfaceInfo):
 
 
 class PlotDefinitionManager:
-    def __init__(self, spec: PlotSpec):
+    def __init__(self, spec: PlotSpec, is_csv_source: bool = False):
         self._subplot_mgrs: dict[str, SubplotManager] = {}
-        self._init(spec)
+        self._init(spec, is_csv_source)
 
-    def _init(self, spec: PlotSpec):
+    def _init(self, spec: PlotSpec, is_csv_source: bool):
         is_time = spec.plot_time
         for interface in spec.interfaces:
-            self._subplot_mgrs[interface.name] = SubplotManager(is_time, interface)
+            self._subplot_mgrs[interface.name] = SubplotManager(
+                is_time, interface, is_csv_source
+            )
 
     @property
     def interface_names(self) -> list[str]:

src/ansys/systemcoupling/core/charts/plotter.py

@@ -39,7 +39,8 @@
     SubplotManager,
 )
 from ansys.systemcoupling.core.util.assertion import assert_
-from ansys.systemcoupling.core.util.logging import LOG
+
+# from ansys.systemcoupling.core.util.logging import LOG
 
 
 def _process_timestep_data(
@@ -290,18 +291,14 @@ def show_animated(self):
         self._animation = FuncAnimation(
             self._fig,
             self._update_animation,
-            # frames=x_axis_pts,
             save_count=sys.maxsize,
-            # init_func=self._init_plots,
             blit=False,
             interval=200,
             repeat=False,
         )
-        # plt.show()
 
     def _update_animation(self, frame: int):
-        # print("calling update animation")
-        LOG.debug("FigurePlotter updating animation frame: %s", frame)
+        # LOG.debug("FigurePlotter updating animation frame: %s", frame)
         return self._request_update()
 
     def _init_plots(self):