fix: Fix and refactor Timeline component in trame (#157)

* start including start date logic

* solution to small extend tasks

* more frequency and only available Categories

* task deletion

* output time in seconds

* fix freq

* fix input conversion problem

* add new widget version

Author: jafranc

.github/workflows/typing-check.yml

@@ -30,7 +30,7 @@ jobs:
       # working-directory: ./${{ matrix.package-name }}
       run: |
         python -m pip install --upgrade pip
-        python -m pip install mypy ruff types-PyYAML
+        python -m pip install mypy ruff types-PyYAML types-pytz
 
     - name: Typing check with mypy
       #  working-directory: ./${{ matrix.package-name }}

geos-trame/pyproject.toml

@@ -8,7 +8,8 @@ version = "1.0.0"
 description = "Geos Simulation Modeler"
 authors = [{name = "GEOS Contributors" }]
 maintainers = [{name = "Alexandre Benedicto", email = "alexandre.benedicto@external.totalenergies.com" },
-               {name = "Paloma Martinez", email = "paloma.martinez@external.totalenergies.com" }]
+               {name = "Paloma Martinez", email = "paloma.martinez@external.totalenergies.com" },
+               {name = "Jacques Franc", email= "jacques.franc@external.totalenergies.com" }]
 license = {text = "Apache-2.0"}
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -40,14 +41,14 @@ dependencies = [
     "matplotlib==3.9.4",
     "trame-matplotlib==2.0.3",
     "trame-components==2.4.2",
-    "trame-gantt==0.1.5",
     "mpld3<0.5.11",
     "xsdata==24.5",
     "xsdata-pydantic[lxml]==24.5",
     "pyvista==0.45.2",
     "dpath==2.2.0",
     "colorcet==3.1.0",
     "funcy==2.0",
+    "pytz==2025.2",
     "typing_inspect==0.9.0",
     "typing_extensions>=4.12",
     "PyYAML",

geos-trame/src/geos/trame/app/core.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: Apache-2.0
 # SPDX-FileCopyrightText: Copyright 2023-2024 TotalEnergies.
-# SPDX-FileContributor: Lionel Untereiner
+# SPDX-FileContributor: Lionel Untereiner, Jacques Franc
 
 from trame.ui.vuetify3 import VAppLayout
 from trame.decorators import TrameApp
@@ -111,7 +111,7 @@ def deck_ui( self ) -> None:
                     cols=10,
                     order=2,
             ):
-                self.timelineEditor = TimelineEditor( source=self.tree, classes="ma-2", style="height: 40%" )
+                self.timelineEditor = TimelineEditor( source=self.tree, classes="ma-2", style="height: 60%" )
                 with vuetify.VRow( classes="mb-6 fill-height", ):
 
                     with vuetify.VCol(
@@ -121,7 +121,7 @@ def deck_ui( self ) -> None:
                         self.deckEditor = DeckEditor(
                             source=self.tree,
                             classes="ma-2",
-                            style="flex: 1; height: 100%;",
+                            style="height: 100%;",
                         )
 
                     with vuetify.VCol(
@@ -133,13 +133,13 @@ def deck_ui( self ) -> None:
                             region_viewer=self.region_viewer,
                             well_viewer=self.well_viewer,
                             classes="ma-2",
-                            style="flex: 1; height: 60%; width: 100%;",
+                            style="height: 60%; width: 100%;",
                         )
 
                         self.deckPlotting = DeckPlotting(
                             source=self.tree,
                             classes="ma-2",
-                            style="flex: 1; height: 40%; width: 100%;",
+                            style="height: 40%; width: 100%;",
                         )
 
     def build_ui( self ) -> None:

geos-trame/src/geos/trame/app/deck/tree.py

@@ -4,14 +4,16 @@
 import os
 from collections import defaultdict
 from typing import Any
+from datetime import timedelta, datetime
+
 import dpath
 import funcy
 from pydantic import BaseModel
 
 from xsdata.formats.dataclass.parsers.config import ParserConfig
 from xsdata.formats.dataclass.serializers.config import SerializerConfig
 from xsdata.utils import text
-from xsdata_pydantic.bindings import DictDecoder, XmlContext, XmlSerializer
+from xsdata_pydantic.bindings import DictDecoder, XmlContext, XmlSerializer, DictEncoder
 
 from trame_server.controller import Controller
 from trame_simput import get_simput_manager
@@ -21,6 +23,12 @@
 from geos.trame.schema_generated.schema_mod import Problem, Included, File, Functions
 from geos.trame.app.utils.file_utils import normalize_path, format_xml
 
+import logging
+
+date_fmt = "%Y-%m-%d"
+logger = logging.getLogger( "tree" )
+logger.setLevel( logging.ERROR )
+
 
 class DeckTree( object ):
     """A tree that represents a deck file along with all the available blocks and parameters."""
@@ -36,6 +44,8 @@ def __init__( self, sm_id: str | None = None, ctrl: Controller = None, **kwargs:
         self.input_has_errors = False
         self._sm_id = sm_id
         self._ctrl = ctrl
+        self.world_origin_time = datetime( 1924, 3, 28 ).strftime( date_fmt )  # Total start date !!
+        self.registered_targets: dict = {}
 
     def set_input_file( self, input_filename: str ) -> None:
         """Set a new input file.
@@ -79,6 +89,12 @@ def update( self, path: str, key: str, value: Any ) -> None:
         assert self.input_file is not None and self.input_file.pb_dict is not None
         self.input_file.pb_dict = funcy.set_in( self.input_file.pb_dict, new_path, value )
 
+    def drop( self, path: str ) -> None:
+        """Remove in the tree."""
+        new_path = [ int( x ) if x.isdigit() else x for x in path.split( "/" ) ]
+        assert self.input_file is not None and self.input_file.pb_dict is not None
+        self.input_file.pb_dict = funcy.del_in( self.input_file.pb_dict, new_path )
+
     def _search( self, path: str ) -> list | None:
         new_path = path.split( "/" )
         if self.input_file is None:
@@ -99,6 +115,17 @@ def decode( self, path: str ) -> BaseModel | None:
         decoder = DictDecoder( context=context, config=ParserConfig() )
         return decoder.decode( data[ 0 ] )
 
+    @staticmethod
+    def encode_data( data: BaseModel ) -> dict:
+        """Convert a data to a xml serializable file."""
+        context = XmlContext(
+            element_name_generator=text.pascal_case,
+            attribute_name_generator=text.camel_case,
+        )
+        encoder = DictEncoder( context=context, config=SerializerConfig( indent="  " ) )
+        nodeDict: dict = encoder.encode( data )
+        return nodeDict
+
     @staticmethod
     def decode_data( data: dict ) -> Problem:
         """Convert a data to a xml serializable file."""
@@ -133,12 +160,28 @@ def timeline( self ) -> list[ dict ] | None:
         timeline = []
         # list root events
         global_id = 0
-        for e in self.input_file.problem.events[ 0 ].periodic_event:
+        all_periodic_events = self.input_file.problem.events[ 0 ].periodic_event
+        max_time = self.input_file.problem.events[ 0 ].max_time
+        for e in all_periodic_events:
+            self.registered_targets[ e.target.split( '/' )[ -1 ] ] = e.target
+            e.end_time = max_time if float( e.end_time ) > float( max_time ) else e.end_time
+            #note here float conversion is used to correctly interpret scientific format
             item: dict[ str, str | int ] = {
-                "id": global_id,
-                "summary": e.name,
-                "start_date": e.begin_time,
+                "id":
+                global_id,
+                "name":
+                e.name,
+                "start": ( datetime.strptime( self.world_origin_time, date_fmt ) +
+                           timedelta( seconds=float( e.begin_time ) ) ).strftime( date_fmt ),
+                "end": ( datetime.strptime( self.world_origin_time, date_fmt ) +
+                         timedelta( seconds=float( e.end_time ) ) ).strftime( date_fmt ),
+                "duration":
+                str( timedelta( seconds=( float( e.end_time ) - float( e.begin_time ) ) ).days ),
+                "category":
+                e.target.split( '/' )[ -1 ],
             }
+            if ( int( float( e.time_frequency ) ) > 0 ):
+                item[ "freq" ] = timedelta( seconds=float( e.time_frequency ) ).days
             timeline.append( item )
             global_id = global_id + 1
 

geos-trame/src/geos/trame/app/gantt_chart/__init__.py

@@ -0,0 +1,7 @@
+from trame_client.utils.version import get_version
+
+__version__ = get_version( "gantt-chart" )
+
+__all__ = [
+    "__version__",
+]

geos-trame/src/geos/trame/app/gantt_chart/module/__init__.py

@@ -0,0 +1,25 @@
+from pathlib import Path
+
+# Compute local path to serve
+serve_path = str( Path( __file__ ).with_name( "serve" ).resolve() )
+
+# Serve directory for JS/CSS files
+serve = { "__gantt_chart": serve_path }
+
+# List of JS files to load (usually from the serve path above)
+scripts = [ "__gantt_chart/gantt-chart.umd.js" ]
+
+# List of CSS files to load (usually from the serve path above)
+# styles = ["__geos_trame/style.css"]
+
+# List of Vue plugins to install/load
+vue_use = [ "GanttLib" ]
+
+# Uncomment to add entries to the shared state
+# state = {}
+
+
+# Optional if you want to execute custom initialization at module load
+def setup( app, **kwargs ):  # noqa
+    """Method called at initialization with possibly some custom keyword arguments."""
+    pass

geos-trame/src/geos/trame/app/gantt_chart/module/serve/gantt-chart.umd.js

@@ -0,0 +1,35 @@
+from trame_client.widgets.core import AbstractElement
+from .. import module
+
+__all__ = [
+    "Gantt",
+]
+
+
+#will eventually be a dependency, so we'll skip some type checks
+class HtmlElement( AbstractElement ):
+
+    def __init__( self, _elem_name, children=None, **kwargs ) -> None:  # noqa
+        super().__init__( _elem_name, children, **kwargs )  # noqa
+        if self.server:
+            self.server.enable_module( module )
+
+
+class Gantt( HtmlElement ):
+    """Gantt Editor component.
+
+    Properties:
+        tasks
+        availableCategoriesList
+
+    Emit:
+        taskUpdated.
+    """
+
+    def __init__( self, **kwargs ) -> None:  #noqa
+        super().__init__(
+            "GanttChart",
+            **kwargs,
+        )
+        self._attr_names += [ "tasks", "availableCategoriesList" ]
+        self._event_names += [ "taskUpdated" ]

geos-trame/src/geos/trame/app/gantt_chart/module/serve/style.css

@@ -63,7 +63,6 @@ def _on_change( topic: str, ids: list | None = None ) -> None:
             if ids is not None and topic == "changed":
                 for obj_id in ids:
                     proxy = self.simput_manager.proxymanager.get( obj_id )
-                    #self.tree.decode( obj_id ) # if const function and return not used why ?? to decode context ??
                     for prop in proxy.edited_property_names:
                         self.tree.update( obj_id, text.camel_case( prop ), proxy.get_property( prop ) )