interpretation-models 0.1.0__tar.gz

interpretation_models-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Equinor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

interpretation_models-0.1.0/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: interpretation-models
+Version: 0.1.0
+Summary: Interpretation models maintained by the SID team
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dsis-schemas>=0.0.6
+Requires-Dist: pydantic<3,>=2
+Dynamic: license-file
+
+# Interpretation models
+
+This repo is meant to contain the core models for interpretations - horizons, faults, surface grids, polygons, pointsets - 
+handled by the SID team in SUB/EXD/DI/SDD
+
+Models are contained in the src folder, and are meant to be used as a basis for the interpretations ingested into OSDU and
+the Surfaces API im APIM.

interpretation_models-0.1.0/README.md

@@ -0,0 +1,7 @@
+# Interpretation models
+
+This repo is meant to contain the core models for interpretations - horizons, faults, surface grids, polygons, pointsets - 
+handled by the SID team in SUB/EXD/DI/SDD
+
+Models are contained in the src folder, and are meant to be used as a basis for the interpretations ingested into OSDU and
+the Surfaces API im APIM.

interpretation_models-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "interpretation-models"
+version = "0.1.0"
+description = "Interpretation models maintained by the SID team"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "dsis-schemas>=0.0.6",
+    "pydantic>=2, <3",
+]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"models" = ["py.typed"]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+    "mypy>=1.19.1",
+    "ruff>=0.15.0",
+    "ipykernel>=7.2.0",
+]

interpretation_models-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

interpretation_models-0.1.0/src/interpretation_models.egg-info/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: interpretation-models
+Version: 0.1.0
+Summary: Interpretation models maintained by the SID team
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dsis-schemas>=0.0.6
+Requires-Dist: pydantic<3,>=2
+Dynamic: license-file
+
+# Interpretation models
+
+This repo is meant to contain the core models for interpretations - horizons, faults, surface grids, polygons, pointsets - 
+handled by the SID team in SUB/EXD/DI/SDD
+
+Models are contained in the src folder, and are meant to be used as a basis for the interpretations ingested into OSDU and
+the Surfaces API im APIM.

interpretation_models-0.1.0/src/interpretation_models.egg-info/SOURCES.txt

@@ -0,0 +1,21 @@
+LICENSE
+README.md
+pyproject.toml
+src/interpretation_models.egg-info/PKG-INFO
+src/interpretation_models.egg-info/SOURCES.txt
+src/interpretation_models.egg-info/dependency_links.txt
+src/interpretation_models.egg-info/requires.txt
+src/interpretation_models.egg-info/top_level.txt
+src/mappers/__init__.py
+src/mappers/mappers_dsis.py
+src/mappers/surface_helpers.py
+src/models/__init__.py
+src/models/extent.py
+src/models/interpretation.py
+src/models/origin.py
+src/models/py.typed
+src/models/surface.py
+src/models/surfacegrid_sidv2.py
+tests/test_extent.py
+tests/test_surface.py
+tests/test_surfacegrid_json_validation.py

interpretation_models-0.1.0/src/interpretation_models.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

interpretation_models-0.1.0/src/interpretation_models.egg-info/requires.txt

@@ -0,0 +1,2 @@
+dsis-schemas>=0.0.6
+pydantic<3,>=2

interpretation_models-0.1.0/src/interpretation_models.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+mappers
+models

interpretation_models-0.1.0/src/mappers/__init__.py

@@ -0,0 +1 @@
+"""Mappers for converting between internal models and external schemas."""

interpretation_models-0.1.0/src/mappers/mappers_dsis.py

@@ -0,0 +1,93 @@
+import datetime
+import math
+
+from models.origin import Project
+from models.interpretation import SourceMetadata, OWMetadata, PipelineMetadata
+from models.surface import GridGeometry, Surface
+from dsis_model_sdk.models.common import SurfaceGrid, SurfaceGridProperties
+
+
+def normalize_surfacegrid_payload(payload: dict) -> dict:
+    normalized = dict(payload)
+
+    rotation_i = normalized.get("rotation_i")
+    if rotation_i is not None:
+        normalized["rotation_i"] = round(float(rotation_i), 4)
+
+    rotation_j = normalized.get("rotation_j")
+    if rotation_j is not None:
+        normalized["rotation_j"] = round(float(rotation_j), 4)
+
+    data_min = normalized.get("data_min")
+    if data_min is not None:
+        normalized["data_min"] = round(float(data_min), 3)
+
+    data_max = normalized.get("data_max")
+    if data_max is not None:
+        normalized["data_max"] = round(float(data_max), 3)
+
+    return normalized
+
+
+def ow_to_sid(
+    project: Project,
+    ow_surface: SurfaceGrid | SurfaceGridProperties,
+    pipeline_metadata: PipelineMetadata | None = None,
+) -> Surface:
+    """Map OW surface schema to the internal Surface model.
+
+    Args:
+        ow_surface: DSIS CommonModel surface object to convert
+        pipeline_metadata: metadata calculated within or related to the run of the pipeline
+
+    Returns:
+        Surface instance
+    """
+
+    def convert_date_to_utc(
+        date: datetime.datetime | None = None, timezone: str | None = None
+    ) -> datetime.datetime | None:
+        pass  # TODO: implement time conversion to UTC based on the timezone from Project table
+
+    if ow_surface.crs is None:
+        raise ValueError("SurfaceGrid.crs is required to map to SourceMetadata")
+
+    source_metadata = SourceMetadata(
+        project=project,
+        native_uid=ow_surface.native_uid,
+        name=ow_surface.map_data_set_name,
+        crs=ow_surface.crs,
+        z_domain=ow_surface.data_domain,
+        z_unit=ow_surface.z_unit,
+        create_user=ow_surface.create_user_id,
+        update_user=ow_surface.update_user_id,
+        remark=ow_surface.remark,
+        create_date=ow_surface.create_date,
+        create_date_utc=convert_date_to_utc(ow_surface.create_date, project.timezone),
+        update_date=ow_surface.update_date,
+        update_date_utc=convert_date_to_utc(ow_surface.update_date, project.timezone),
+        ow=OWMetadata(
+            geo_name=ow_surface.geo_name,
+            geo_type=ow_surface.geo_type,
+            attribute=ow_surface.attribute,
+        ),
+    )
+    geometry = GridGeometry(
+        ncol=ow_surface.num_cols,
+        nrow=ow_surface.num_rows,
+        xori=ow_surface.rotation_origin_x,
+        yori=ow_surface.rotation_origin_y,
+        xinc=ow_surface.grid_interval_x,
+        yinc=ow_surface.grid_interval_y,
+        rotation=math.degrees(ow_surface.rotation_i)
+        if ow_surface.rotation_i is not None
+        else None,
+        left_handed=True,  # TODO: should this be default for surfaces from OW?
+    )
+    return Surface(
+        source=source_metadata,
+        pipeline=pipeline_metadata,
+        geometry=geometry,
+        extent=None,  # TODO: calculate from grid geometry
+        collection=[],  # TODO
+    )

interpretation_models-0.1.0/src/mappers/surface_helpers.py

@@ -0,0 +1,12 @@
+from collections.abc import Mapping
+
+
+def flatten_dict(obj: Mapping, prefix: str = "", sep: str = ".") -> dict[str, object]:
+    flat: dict[str, object] = {}
+    for key, value in obj.items():
+        full_key = f"{prefix}{sep}{key}" if prefix else str(key)
+        if isinstance(value, Mapping):
+            flat.update(flatten_dict(value, prefix=full_key, sep=sep))
+        else:
+            flat[full_key] = value
+    return flat

interpretation_models-0.1.0/src/models/extent.py

@@ -0,0 +1,33 @@
+from pydantic import BaseModel, field_validator
+
+
+class Point(BaseModel):
+    """A 2D coordinate point."""
+
+    x: float
+    y: float
+
+
+class Extent(BaseModel):
+    """A polygon extent defined by corner points."""
+
+    points: list[Point]
+
+    @field_validator("points")
+    @classmethod
+    def validate_minimum_points(cls, v):
+        if len(v) < 3:
+            raise ValueError("Extent must have at least 3 points to form a polygon")
+        return v
+
+    @property
+    def is_closed(self) -> bool:
+        """Check if the polygon is closed (first and last points are the same)."""
+        if len(self.points) < 2:
+            return False
+        return self.points[0] == self.points[-1]
+
+    def close(self) -> None:
+        """Close the polygon by appending the first point at the end if not already closed."""
+        if not self.is_closed and len(self.points) > 0:
+            self.points.append(self.points[0])

interpretation_models-0.1.0/src/models/interpretation.py

@@ -0,0 +1,50 @@
+from pydantic import BaseModel
+from datetime import datetime
+from models.extent import Extent
+from models.origin import Collection, Project
+
+
+class OWMetadata(BaseModel):
+    geo_name: str | None = None
+    geo_type: str | None = None
+    attribute: str | None = None
+
+
+class PetrelMetadata(BaseModel):
+    business_project: str | None = None
+    data_status: str | None = None
+    confidence_factor: str | None = None
+
+
+class SourceMetadata(BaseModel):
+    project: Project
+    native_uid: str | None = None
+    name: str
+    crs: str
+    z_domain: str | None = None
+    z_unit: str | None = None
+    create_user: str | None = None
+    update_user: str | None = None
+    remark: str | None = None
+    create_date: datetime | None = None
+    create_date_utc: datetime | None = None
+    update_date: datetime | None = None
+    update_date_utc: datetime | None = None
+    ow: OWMetadata | None = None
+    petrel: PetrelMetadata | None = None
+
+
+class PipelineMetadata(BaseModel):
+    id: str  # SID UUID
+    create_date: datetime | None = None
+    update_date: datetime | None = None
+    file_availability: str | None = None
+    deleted: bool | None = None
+    deleted_date: datetime | None = None
+
+
+class Interpretation(BaseModel):
+    source: SourceMetadata | None = None
+    pipeline: PipelineMetadata | None = None
+    extent: Extent | None = None
+    collection: list[Collection]

interpretation_models-0.1.0/src/models/origin.py

@@ -0,0 +1,19 @@
+from pydantic import BaseModel
+from enum import Enum
+
+
+class SourceSystem(str, Enum):
+    OPENWORKS = "OpenWorks R5000"  # or 'OpenWorks'?
+    PETREL = "Petrel Studio"
+
+
+class Project(BaseModel):
+    source_system: SourceSystem
+    database: str
+    name: str
+    timezone: str
+    last_pipeline_run_date: str | None = None
+
+
+class Collection(BaseModel):
+    id: str  # SID UUID

interpretation_models-0.1.0/src/models/surface.py

@@ -0,0 +1,25 @@
+from pydantic import BaseModel
+from models.interpretation import Interpretation
+
+
+class GridGeometry(BaseModel):
+    ncol: int | None = None
+    nrow: int | None = None
+    xori: float | None = None
+    yori: float | None = None
+    xinc: float | None = None
+    yinc: float | None = None
+    rotation: float | None = None
+    left_handed: bool | None = True  # yflip
+
+
+class Surface(Interpretation):
+    geometry: GridGeometry | None = None
+    parent_surface_id: str | None = (
+        None  # for SurfaceGridProperties objects? source or SID id?
+    )
+
+    # Redundant?
+    z_non: float | None = None
+    ntotal: int | None = None
+    nnan: int | None = None

interpretation_models-0.1.0/src/models/surfacegrid_sidv2.py

@@ -0,0 +1,67 @@
+from datetime import datetime
+from pydantic import BaseModel
+
+# this class is just here for development purposes, to compare the v2 and v3 models; can be removed later
+
+
+class SurfaceGrid_SIDv2(BaseModel):
+    ssdf_uuid: str | None = None
+
+    # Source
+    source: str | None = None
+    source_database: str | None = None
+    source_project: str | None = None
+    source_grid_id: str | None = None
+
+    # Surface properties
+    surface_name: str | None = None
+    geo_name: str | None = None
+    geo_type: str | None = None
+    z_unit: str | None = None
+    z_non: float | None = None
+    z_domain: str | None = None
+    attribute_source: str | None = None
+    interpreter_source: str | None = None
+    create_user_source: str | None = None
+    update_user_source: str | None = None
+    remark_source: str | None = None
+    business_project_source: str | None = None
+    data_status_source: str | None = None
+    confidence_factor_source: str | None = None
+
+    # Coordinate systems
+    object_coordinate_system_name_source: str | None = None  # OpenWorks R5000
+    object_coordinate_system_unit_source: str | None = None  # OpenWorks R5000
+    object_coordinate_system_id_source: str | None = None  # OpenWorks R5000
+    projected_coordinate_system: str | None = None  # Petrel Studio
+    projected_coordinate_unit: str | None = None  # Petrel Studio
+    projected_coordinate_uuid: str | None = None  # Petrel Studio
+
+    # Grid geometry and properties
+    xinc: float | None = None
+    yinc: float | None = None
+    xori: float | None = None
+    yori: float | None = None
+    rotation: float | None = None
+    yflip: int | None = None
+    ncol: int | None = None
+    nrow: int | None = None
+    ntotal: int | None = None
+    nnan: int | None = None
+
+    # Timestamps
+    create_date: datetime | None = None
+    create_date_source: datetime | None = None
+    create_date_source_utc: datetime | None = None
+    update_date: datetime | None = None
+    update_date_source: datetime | None = None
+    update_date_source_utc: datetime | None = None
+
+    # SMDA
+    smda_project_uuid: str | None = None
+    cs_smda_project_uuid: int | None = None
+
+    # Bulk file and deletion status
+    file_availability: str | None = None
+    deleted: bool | None = None
+    deleted_date: datetime | None = None

interpretation_models-0.1.0/tests/test_extent.py

@@ -0,0 +1,34 @@
+import pytest
+from pydantic import ValidationError
+from models.extent import Extent, Point
+
+
+def test_extent_validate_minimum_points_valid():
+    """Test that Extent accepts 3 or more points."""
+    # Test with exactly 3 points (minimum valid)
+    extent = Extent(points=[Point(x=0, y=0), Point(x=1, y=0), Point(x=0, y=1)])
+    assert len(extent.points) == 3
+
+    # Test with 4 points
+    extent = Extent(
+        points=[Point(x=0, y=0), Point(x=1, y=0), Point(x=1, y=1), Point(x=0, y=1)]
+    )
+    assert len(extent.points) == 4
+
+
+def test_extent_validate_minimum_points_invalid():
+    """Test that Extent rejects less than 3 points."""
+    # Test with 2 points (invalid)
+    with pytest.raises(ValidationError) as exc_info:
+        Extent(points=[Point(x=0, y=0), Point(x=1, y=0)])
+    assert "at least 3 points" in str(exc_info.value)
+
+    # Test with 1 point (invalid)
+    with pytest.raises(ValidationError) as exc_info:
+        Extent(points=[Point(x=0, y=0)])
+    assert "at least 3 points" in str(exc_info.value)
+
+    # Test with 0 points (invalid)
+    with pytest.raises(ValidationError) as exc_info:
+        Extent(points=[])
+    assert "at least 3 points" in str(exc_info.value)

interpretation_models-0.1.0/tests/test_surface.py

@@ -0,0 +1,13 @@
+import pytest
+from pydantic import ValidationError
+from models.surface import Surface
+
+
+def test_surface_grid_missing_required_field():
+    with pytest.raises(ValidationError):
+        Surface(
+            id="11111111-1111-1111-1111-111111111111",
+            crs="ST_ED50_UTM31N_P23031_T1133",
+            rotation=0.0,
+            # name omitted on purpose
+        )

interpretation_models-0.1.0/tests/test_surfacegrid_json_validation.py

@@ -0,0 +1,15 @@
+import pytest
+from dsis_model_sdk.models.common import SurfaceGrid
+from pydantic import ValidationError
+
+
+def test_surfacegrid_raw_json_fails_strict_validation(surfacegrid_payload: dict):
+    with pytest.raises(ValidationError):
+        SurfaceGrid.model_validate(surfacegrid_payload)
+
+
+def test_surfacegrid_normalized_json_validates(
+    surfacegrid_payload_normalized: dict,
+):
+    obj = SurfaceGrid.model_validate(surfacegrid_payload_normalized)
+    assert isinstance(obj, SurfaceGrid)