MAINT: Replace TSurfData with xtgeo.TriangulatedSurface

Author: tnatt

docs/src/custom_exports/usage.md

@@ -79,6 +79,7 @@ documentation](https://xtgeo.readthedocs.io).
 
 - [xtgeo.RegularSurface](https://xtgeo.readthedocs.io/en/stable/datamodels.html#surface-regularsurface).
   Exported as `.gri` files.
+- xtgeo.TriangularSurface. Exported as `.ts` files.
 - [xtgeo.Polygons](https://xtgeo.readthedocs.io/en/stable/datamodels.html#xyz-data-points-and-polygons).
   Exported as `.csv` files by default.
 - [xtgeo.Points](https://xtgeo.readthedocs.io/en/stable/datamodels.html#xyz-data-points-and-polygons)
@@ -123,14 +124,6 @@ have a particular format that is understood by fmu-dataio.
 
 FaultRoom surfaces are exported as JSON files.
 
-#### GOCAD Surface/TSURF Files
-
-These are triangle-based surfaces. Within FMU, TSURF files can be created and
-exported within RMS. The `TSurfData` class is currently stored in fmu-dataio
-but will eventually exist as an xtgeo type.
-
-TSURF files are exported as `.ts` TSURF files.
-
 #### Something Missing?
 
 If you have a particular data type you would like to export with fmu-dataio,

src/fmu/dataio/_export/core.py

@@ -20,7 +20,7 @@
 from .serialize import export_object
 
 if TYPE_CHECKING:
-    from fmu.dataio.types import ExportableData
+    from fmu.dataio._metadata import ObjectData
 
     from ._export_config import ExportConfig
 
@@ -69,7 +69,7 @@ def _update_manifest_if_needed(export_config: ExportConfig, outfile: Path) -> No
     update_export_manifest(outfile, casepath=export_config.runcontext.casepath)
 
 
-def _write_object(file: Path, objdata: ExportableData) -> None:
+def _write_object(file: Path, objdata: ObjectData) -> None:
     """Write an object to a file, creating parent directories as needed."""
     file.parent.mkdir(parents=True, exist_ok=True)
     export_object(objdata, file)

src/fmu/dataio/_export/serialize.py

@@ -19,14 +19,13 @@
 import xtgeo
 
 from fmu.dataio._logging import null_logger
-from fmu.dataio._readers import tsurf as tsurf_reader
+from fmu.dataio._metadata._object._xtgeo import PointsData, PolygonsData
 from fmu.dataio._readers.faultroom import FaultRoomSurface
-from fmu.dataio._readers.tsurf import TSurfData
 from fmu.dataio._utils import md5sum
 from fmu.datamodels.fmu_results.enums import FileFormat
 
 if TYPE_CHECKING:
-    from fmu.dataio._metadata.objectdata._base import ObjectData
+    from fmu.dataio._metadata import ObjectData
 
 logger: Final = null_logger(__name__)
 
@@ -42,6 +41,9 @@ def export_object(objdata: ObjectData, file: Path | BytesIO) -> None:
     if isinstance(obj, xtgeo.RegularSurface):
         obj.to_file(file, fformat="irap_binary")
 
+    elif isinstance(obj, xtgeo.TriangulatedSurface):
+        obj.to_file(file, fformat="tsurf")
+
     elif isinstance(obj, (xtgeo.Polygons, xtgeo.Points)):
         _export_tabular_xtgeo(objdata, file)
 
@@ -64,9 +66,6 @@ def export_object(objdata: ObjectData, file: Path | BytesIO) -> None:
     elif isinstance(obj, FaultRoomSurface):
         _export_json(json.dumps(obj.storage, indent=4), file)
 
-    elif isinstance(obj, TSurfData):
-        tsurf_reader.write_tsurf_to_file(obj, file)
-
     elif isinstance(obj, dict):
         _export_json(json.dumps(obj), file)
 
@@ -78,6 +77,8 @@ def export_object(objdata: ObjectData, file: Path | BytesIO) -> None:
 
 def _export_tabular_xtgeo(objdata: ObjectData, file: Path | BytesIO) -> None:
     """Export xtgeo Polygons or Points, respecting the configured format."""
+    assert isinstance(objdata, (PolygonsData, PointsData))  # for mypy
+
     fmt = objdata.fmt
 
     if fmt == FileFormat.parquet:

src/fmu/dataio/_metadata/_object/_triangulated_surface.py

@@ -23,6 +23,7 @@
     PointSpecification,
     PolygonsSpecification,
     SurfaceSpecification,
+    TriangulatedSurfaceSpecification,
     ZoneDefinition,
 )
 
@@ -171,6 +172,63 @@ def get_spec(self) -> SurfaceSpecification:
         )
 
 
+class TriangulatedSurfaceData(ObjectData):
+    """Provider for triangulated surface data."""
+
+    obj: xtgeo.TriangulatedSurface
+
+    @property
+    def classname(self) -> ObjectMetadataClass:
+        return ObjectMetadataClass.surface
+
+    @property
+    def efolder(self) -> str:
+        return self.export_config.forcefolder or ExportFolder.maps.value
+
+    @property
+    def extension(self) -> str:
+        return FileExtension.tsurf.value
+
+    @property
+    def fmt(self) -> FileFormat:
+        return FileFormat.tsurf
+
+    @property
+    def layout(self) -> Layout:
+        return Layout.triangulated
+
+    @property
+    def table_index(self) -> None:
+        """Return the table index."""
+
+    def get_geometry(self) -> None:
+        """Derive data.geometry for TriangulatedSurface."""
+
+    def get_bbox(self) -> BoundingBox3D:
+        """Derive data.bbox for TriangulatedSurface."""
+        logger.info("Get bounding box for TriangulatedSurface")
+
+        bbox = self.obj.bounding_box
+        return BoundingBox3D(
+            xmin=bbox.min_x,
+            xmax=bbox.max_x,
+            ymin=bbox.min_y,
+            ymax=bbox.max_y,
+            zmin=bbox.min_z,
+            zmax=bbox.max_z,
+        )
+
+    def get_spec(self) -> TriangulatedSurfaceSpecification:
+        """Derive data.spec for TriangulatedSurface"""
+        logger.info("Get spec for TriangulatedSurface")
+
+        required = self.obj.metadata.required
+        return TriangulatedSurfaceSpecification(
+            num_vertices=required["num_vertices"],
+            num_triangles=required["num_triangles"],
+        )
+
+
 class PolygonsData(ObjectData):
     obj: xtgeo.Polygons
 

src/fmu/dataio/_metadata/_object/_xtgeo.py

@@ -16,22 +16,19 @@
 from fmu.dataio._export import ExportConfig
 from fmu.dataio._logging import null_logger
 from fmu.dataio._readers.faultroom import FaultRoomSurface
-from fmu.dataio._readers.tsurf import TSurfData
 from fmu.datamodels.fmu_results.enums import FileFormat, Layout, ObjectMetadataClass
 
-from ._base import (
-    ObjectData,
-)
+from ._base import ObjectData
 from ._faultroom import FaultRoomSurfaceData
 from ._tables import ArrowTableData, DataFrameData
-from ._triangulated_surface import TriangulatedSurfaceData
 from ._xtgeo import (
     CPGridData,
     CPGridPropertyData,
     CubeData,
     PointsData,
     PolygonsData,
     RegularSurfaceData,
+    TriangulatedSurfaceData,
 )
 
 if TYPE_CHECKING:
@@ -54,6 +51,8 @@ def create_object_data(obj: ExportableData, export_config: ExportConfig) -> Obje
     """
     if isinstance(obj, xtgeo.RegularSurface):
         return RegularSurfaceData(obj, export_config)
+    if isinstance(obj, xtgeo.TriangulatedSurface):
+        return TriangulatedSurfaceData(obj, export_config)
     if isinstance(obj, xtgeo.Polygons):
         return PolygonsData(obj, export_config)
     if isinstance(obj, xtgeo.Points):
@@ -68,8 +67,6 @@ def create_object_data(obj: ExportableData, export_config: ExportConfig) -> Obje
         return DataFrameData(obj, export_config)
     if isinstance(obj, FaultRoomSurface):
         return FaultRoomSurfaceData(obj, export_config)
-    if isinstance(obj, TSurfData):
-        return TriangulatedSurfaceData(obj, export_config)
     if isinstance(obj, dict):
         return DictionaryData(obj, export_config)
     if isinstance(obj, pa.Table):