Gantt Chart support for Task Class

Author: Yuksel-Rudy

famodel/irma/calwave_task1.py

@@ -8,7 +8,9 @@
 from calwave_irma import Scenario
 import calwave_chart as chart
 # from calwave_task import Task  # calwave_task module (Felipe)
-from task import Task as Task    # generic Task module ( Rudy )
+from task import Task            # generic Task module ( Rudy )
+
+import matplotlib.pyplot as plt
 
 sc = Scenario()  # now sc exists in *this* session
 
@@ -195,11 +197,15 @@ def assign_actions(sc: Scenario, actions: dict):
 
     # 5) Build Task
     task1 = Task(name='calwave_task1', actions=sc.actions)
-    task1.getSequenceGraph()
+
+    task1.updateTaskTime(newStart=10)
+
+    # 6) Build the Gantt chart
+    task1.GanttChart(color_by='asset')
     plt.show()
-    # task1.updateTaskTime(newStart=10)
 
-    # 6) build the chart input directly from the Task and plot  #TODO: Rudy / Improve this later (maybe include it in Task.py/Scenario and let it plot the absolute time instead of relative time)
+    # Old chart building code:
+    # 7) build the chart input directly from the Task and plot  #TODO: Rudy / Improve this later (maybe include it in Task.py/Scenario and let it plot the absolute time instead of relative time)
     chart_view = chart.view_from_task(task1, sc, title='CalWave Task 1 - Anchor installation plan')
     chart.plot_task(chart_view, outpath='calwave_task1_chart.png')
 

famodel/irma/calwave_vessels.yaml

@@ -2,6 +2,7 @@
 
 San_Diego:
   # Crane barge for anchor handling
+  name: San_Diego
   type: crane_barge
   transport:
       homeport: national_city
@@ -40,6 +41,7 @@ San_Diego:
 
 Jag:
   # Pacific Maritime Group tugboat assisting DB San Diego
+  name: Jag
   type: tug
   transport:
       homeport: national_city
@@ -67,6 +69,7 @@ Jag:
 
 Beyster:
   # Primary support vessel
+  name: Beyster
   type: research_vessel
   transport:
       homeport: point_loma

famodel/irma/task.py

@@ -318,7 +318,7 @@ def updateTaskTime(self, newStart=0.0):
 
         # Update action start times
         for action in self.actions_ti:
-            self.actions_ti[action] += time_shift
+            self.actions_ti[action] += self.ti
 
 
 
@@ -358,3 +358,137 @@ def get_row(self, assets):
 
         return np.zeros((len(assets), 2)) # placeholder, replace with actual matrix
 
+
+    def GanttChart(self, start_at_zero=True, color_by=None):
+        '''Generate a Gantt chart for the task showing the schedule of actions.
+        
+        Returns
+        -------
+        fig : matplotlib.figure.Figure
+            The figure object containing the Gantt chart.
+        ax : matplotlib.axes.Axes
+            The axes object containing the Gantt chart.
+        '''
+
+        # --- color palette ---
+        colors = [
+            "lime", "orange", "magenta", "blue",
+            "red", "yellow", "cyan", "purple"
+        ]        
+
+        fig, ax = plt.subplots(figsize=(10, 10))
+
+        # Prepare data for Gantt chart
+        action_names = list(self.actions.keys())
+        start_times = [self.actions_ti[name] for name in action_names]
+        durations = [self.actions[name].duration for name in action_names]
+        
+        # Get asset information from action.assets
+        all_assets = set()
+        all_roles  = set()
+        for action in self.actions.values():
+            for role, asset in action.assets.items():
+                all_assets.add(asset['name'])
+                all_roles.add(role)
+
+        # Assign colors
+        if color_by == 'asset':
+            asset_list = list(all_assets)
+            color_dict = {asset: colors[i] for i, asset in enumerate(asset_list)}
+        elif color_by == 'role':
+            # Flip the colors
+            colors = colors[::-1]
+            role_list = list(all_roles)
+            color_dict = {role: colors[i] for i, role in enumerate(role_list)}
+        
+        # Generate vertical lines to indicate the start and finish of the whole task
+        ax.axvline(x=self.ti, ymin=0, ymax=len(action_names), color='black', linestyle='-', linewidth=2.0)
+        ax.axvline(x=self.tf, ymin=0, ymax=len(action_names), color='black', linestyle='-', linewidth=2.0)
+
+        # Create bars for each action
+        ht = 0.4
+        for i, (name, start, duration) in enumerate(zip(action_names, start_times, durations)):
+            opp_i = len(action_names) - i - 1  # to have first action on top
+            action = self.actions[name]
+            assets = list({asset['name'] for asset in action.assets.values()})
+            roles  = list({role for role in action.assets.keys()})
+            
+            assets = list(set(assets))  # Remove duplicates from assets
+
+            n_assets = len(assets)
+            n_roles  = len(roles)
+   
+            if color_by is None:
+                ax.barh(opp_i, duration, color='cyan', left=start, height=ht, align='center')
+            elif color_by == 'asset':
+                # Compute vertical offsets if multiple assets
+                if n_assets == 0:
+                    # No assets info
+                    ax.barh(i, duration, left=start, height=ht, color='cyan', align='center')
+                else:
+                    sub_ht = ht / n_assets
+                    for j, asset in enumerate(assets):
+                        bottom = opp_i - ht/2 + j * sub_ht
+                        color = color_dict.get(asset, 'gray')
+                        ax.barh(bottom + sub_ht/2, duration, left=start, height=sub_ht * 0.9, 
+                                color=color, edgecolor='k', linewidth=0.3, align='center')                             
+            elif color_by == 'role':
+                # Compute vertical offsets if multiple roles
+                if n_roles == 0:
+                    # No roles info
+                    ax.barh(opp_i, duration, left=start, height=ht, color='cyan', align='center')
+                else:
+                    sub_ht = ht / n_roles
+                    for j, role in enumerate(roles):
+                        bottom = opp_i - ht/2 + j * sub_ht
+                        color = color_dict.get(role, 'gray')
+                        ax.barh(bottom + sub_ht/2, duration, left=start, height=sub_ht * 0.9, 
+                                color=color, edgecolor='k', linewidth=0.3, align='center')       
+            else:
+                color_by = None
+                raise Warning(f"color_by option '{color_by}' not recognized. Use 'asset', 'role'. None will be used")
+
+            ax.text(self.ti, opp_i, f'  {name}', va='center', ha='left', color='black')
+            ax.axhline(y=opp_i - ht/2, xmin=0, xmax=self.tf, color='gray', linestyle='--', linewidth=0.5)
+            ax.axhline(y=opp_i + ht/2, xmin=0, xmax=self.tf, color='gray', linestyle='--', linewidth=0.5)
+            ax.axvline(x=start, ymin=0, ymax=len(action_names), color='gray', linestyle='--', linewidth=0.5)
+        
+        # Set y-ticks and labels
+        ax.set_yticks(range(len(action_names)))
+        ax.set_yticklabels([])
+
+        # Set labels and title
+        ax.set_xlabel('time (hrs.)')
+        ax.set_title(f'Gantt Chart for Task: {self.name}')
+
+        if color_by == 'asset':
+            handles = [plt.Rectangle((0, 0), 1, 1, color=color_dict[a]) for a in all_assets]
+            ax.legend(handles, all_assets, title='Assets', bbox_to_anchor=(1.02, 1), loc='upper right')
+        elif color_by == 'role':
+            handles = [plt.Rectangle((0, 0), 1, 1, color=color_dict[a]) for a in all_roles]
+            ax.legend(handles, all_roles, title='Roles', bbox_to_anchor=(1.02, 1), loc='upper right')            
+
+        if start_at_zero:
+            ax.set_xlim(0, self.tf + 1)
+        # Create a grid and adjust layout
+        # ax.grid(True)
+        plt.tight_layout()
+        return fig, ax
+
+    def chart(self, start_at_zero=True):
+        '''Generate a chart grouped by asset showing when each asset is active across all actions.
+
+        Parameters
+        ----------
+        start_at_zero : bool, optional
+            If True, the x-axis starts at zero. Defaults to True.
+
+        Returns
+        -------
+        fig : matplotlib.figure.Figure
+            The figure object containing the Gantt chart.
+        ax : matplotlib.axes.Axes
+            The axes object containing the Gantt chart.
+        '''
+        pass
+        

famodel/irma/vessels.yaml

@@ -3,7 +3,8 @@
 # --- Anchor Handling Tug / Supply Vessel (AHTS / AHV) ---
 
 AHTS_alpha:
-# Offshore Tug/Anchor Handling Tug Supply (AHTS) – Towing floating structures, handling and laying anchors/mooring lines, tensioning and positioning support.
+    # Offshore Tug/Anchor Handling Tug Supply (AHTS) – Towing floating structures, handling and laying anchors/mooring lines, tensioning and positioning support.
+    name: AHTS_alpha
     type: AHTS
     transport:
         transit_speed_mps: 4.7       
@@ -53,7 +54,8 @@ AHTS_alpha:
 # --- Multipurpose Support Vessel ---
 
 MPSV_01:
-# Multi-Purpose Support Vessel (MSV) – Flexible vessel used for maintenance, diving, construction, or ROV tasks. Combines features of CSV, DSV and ROVSV.
+    # Multi-Purpose Support Vessel (MSV) – Flexible vessel used for maintenance, diving, construction, or ROV tasks. Combines features of CSV, DSV and ROVSV.
+    name: MPSV_01
     type: MSV
     transport:
         transit_speed_mps: 4.7       
@@ -99,7 +101,8 @@ MPSV_01:
 # --- Construction Support Vessel ---
 
 CSV_A:
-# Construction Support Vessel (CSV) – General-purpose vessel supporting subsea construction, cable lay and light installation. Equipped with cranes, moonpools and ROVs.
+    # Construction Support Vessel (CSV) – General-purpose vessel supporting subsea construction, cable lay and light installation. Equipped with cranes, moonpools and ROVs.
+    name: CSV_A
     type: CSV
     transport:
         transit_speed_mps: 4.7       
@@ -151,7 +154,8 @@ CSV_A:
 # --- ROV Support Vessel ---
 
 ROVSV_X:
-# ROV Support Vessel (ROVSV) – Dedicated to operating and supporting Remotely Operated Vehicles (ROVs) for inspection, survey or intervention.
+    # ROV Support Vessel (ROVSV) – Dedicated to operating and supporting Remotely Operated Vehicles (ROVs) for inspection, survey or intervention.
+    name: ROVSV_X
     type: ROVSV
     transport:
         transit_speed_mps: 6.7       
@@ -186,7 +190,8 @@ ROVSV_X:
 # --- Diving Support Vessel ---
 
 DSV_Moon:
-# Diving Support Vessel (DSV) – Specifically equipped to support saturation diving operations. Includes diving bells, decompression chambers and dynamic positioning.
+    # Diving Support Vessel (DSV) – Specifically equipped to support saturation diving operations. Includes diving bells, decompression chambers and dynamic positioning.
+    name: DSV_Moon
     type: DSV
     transport:
         transit_speed_mps: 4.7       
@@ -213,7 +218,8 @@ DSV_Moon:
 # --- Heavy Lift Vessel ---
 
 HL_Giant:
-# Heavy Lift Vessel (HL) – Used for transporting and installing very large components, like jackets, substations, or monopiles. Equipped with high-capacity cranes (>3000 t).
+    # Heavy Lift Vessel (HL) – Used for transporting and installing very large components, like jackets, substations, or monopiles. Equipped with high-capacity cranes (>3000 t).
+    name: HL_Giant
     type: HL
     transport:
         transit_speed_mps: 4.7       
@@ -268,7 +274,8 @@ SURV_Swath:
 # --- Barge ---
 
 Barge_squid:
-# Barge – non-propelled flat-top vessel used for transporting heavy equipment, components and materials. Requires towing or positioning support from tugs or AHTS vessels. 
+    # Barge – non-propelled flat-top vessel used for transporting heavy equipment, components and materials. Requires towing or positioning support from tugs or AHTS vessels. 
+    name: Barge_squid
     type: BARGE
     transport:
         transit_speed_mps: 2           # No self-propulsion