interpretation-models 0.2.0__tar.gz → 0.4.0__tar.gz

{interpretation_models-0.2.0/src/interpretation_models.egg-info → interpretation_models-0.4.0}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: interpretation-models
-Version: 0.2.0
+Version: 0.4.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
+Requires-Dist: pytz>=2026.1.post1
 Dynamic: license-file
 
 # Interpretation models

{interpretation_models-0.2.0 → interpretation_models-0.4.0}/pyproject.toml

@@ -1,12 +1,13 @@
 [project]
 name = "interpretation-models"
-version = "0.2.0"
+version = "0.4.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",
+    "pytz>=2026.1.post1",
 ]
 
 [build-system]
@@ -18,6 +19,7 @@ where = ["src"]
 
 [tool.setuptools.package-data]
 "models" = ["py.typed"]
+"schemas" = ["definitions/**/*.json"]
 
 [dependency-groups]
 dev = [

{interpretation_models-0.2.0 → interpretation_models-0.4.0/src/interpretation_models.egg-info}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: interpretation-models
-Version: 0.2.0
+Version: 0.4.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
+Requires-Dist: pytz>=2026.1.post1
 Dynamic: license-file
 
 # Interpretation models

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

@@ -0,0 +1,41 @@
+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/collection_ow.py
+src/mappers/metadata_ow.py
+src/mappers/surface_helpers.py
+src/mappers/surfacegrid_ow.py
+src/models/__init__.py
+src/models/collection.py
+src/models/enums.py
+src/models/extent.py
+src/models/interpretation.py
+src/models/metadata.py
+src/models/py.typed
+src/models/surfacegrid_eq_api.py
+src/schemas/__init__.py
+src/schemas/registry.py
+src/schemas/definitions/__init__.py
+src/schemas/definitions/v1/Collection.json
+src/schemas/definitions/v1/CollectionActivity.json
+src/schemas/definitions/v1/CollectionItem.json
+src/schemas/definitions/v1/SurfaceGrid.json
+src/tables/__init__.py
+src/tables/generate_schemas.py
+src/tables/model_to_table.py
+src/tables/table_definitions.py
+src/tables/tablespec.py
+tests/test_collection_mapping.py
+tests/test_collection_ow.py
+tests/test_extent.py
+tests/test_metadata_mappers.py
+tests/test_schema_registry.py
+tests/test_surface.py
+tests/test_surfacegrid_json_validation.py
+tests/test_surfacegrid_mapping.py

{interpretation_models-0.2.0 → interpretation_models-0.4.0}/src/interpretation_models.egg-info/requires.txt

@@ -1,2 +1,3 @@
 dsis-schemas>=0.0.6
 pydantic<3,>=2
+pytz>=2026.1.post1

{interpretation_models-0.2.0 → interpretation_models-0.4.0}/src/interpretation_models.egg-info/top_level.txt

@@ -1,2 +1,4 @@
 mappers
 models
+schemas
+tables

interpretation_models-0.4.0/src/mappers/collection_ow.py

@@ -0,0 +1,172 @@
+import json
+import re
+
+from models.metadata import SourceContext
+from models.enums import SourceSystem, OWDataType, InterpretationDataType
+from models.metadata import SourceMetadata, ProcessingMetadata, OWCollectionMetadata, OWCollectionItemMetadata, InterpretationProcessingMetadata
+from models.collection import Collection, CollectionItem
+from mappers.metadata_ow import convert_date_to_utc, id_generate
+from dsis_model_sdk.models.native import InterpretationSet, ISetDataObject
+
+
+def map_collection(
+    ow_iset: InterpretationSet,
+    source_context: SourceContext,
+    processing_metadata: InterpretationProcessingMetadata | None = None,
+) -> Collection:
+    """Map an OW InterpretationSet to a Collection.
+
+    Args:
+        ow_iset: DSIS CommonModel interpretation set object to convert
+        source_context: SourceContext with database/project info
+        processing_metadata: optional processing metadata (UUIDs, timestamps, etc.)
+
+    Returns:
+        Collection instance
+    """
+    if ow_iset.update_date is None:
+        ow_iset.update_date = ow_iset.create_date
+        ow_iset.update_user_id = ow_iset.create_user_id
+
+    source_metadata = SourceMetadata(
+        id=id_generate(source_context, ow_iset.interpretation_set_id),
+        system=SourceSystem.OPENWORKS,
+        database=source_context.database,
+        project=source_context.project,
+        name=ow_iset.interpret_set_name,
+        remark=ow_iset.remark,
+
+        create_user=ow_iset.create_user_id,
+        update_user=ow_iset.update_user_id,
+        create_date=ow_iset.create_date,
+        create_date_utc=convert_date_to_utc(
+            ow_iset.create_date, source_context.timezone
+        ) if ow_iset.create_date is not None else None,
+        update_date=ow_iset.update_date,
+        update_date_utc=convert_date_to_utc(
+            ow_iset.update_date, source_context.timezone
+        ) if ow_iset.update_date is not None else None,
+    )
+
+    source_ow_metadata = OWCollectionMetadata(
+        field_prospect_name=ow_iset.field_prospect_name,
+    )
+
+    return Collection(
+        id=id_generate(source_context, ow_iset.interpretation_set_id),
+        source=source_metadata,
+        source_ow=source_ow_metadata,
+        processing=processing_metadata
+    )
+
+
+def map_dataobject_datatype(ow_datatype: OWDataType) -> InterpretationDataType:
+    mapping = {
+        OWDataType.MAP2D: InterpretationDataType.SURFACE_GRID,
+        OWDataType.RGRID: InterpretationDataType.SURFACE_GRID,
+        OWDataType.HORIZON3D: InterpretationDataType.HORIZON,
+        OWDataType.POLYGON_SET: InterpretationDataType.POLYGON,
+        OWDataType.POINT_SET: InterpretationDataType.POINT_SET,
+    }
+    return mapping.get(ow_datatype, InterpretationDataType.OTHERS)
+
+
+def _resolve_map2d_grid_id(native_uid: str | None) -> str:
+    if native_uid is None:
+        return ""
+
+    try:
+        native_uid_data = json.loads(native_uid)
+    except (TypeError, json.JSONDecodeError):
+        return ""
+
+    data_key = native_uid_data.get("data_key") if isinstance(native_uid_data, dict) else None
+    if not isinstance(data_key, str):
+        return ""
+
+    match = re.search(r"(?:^|;)gridId=([^;]+)", data_key)
+    return match.group(1).strip() if match and match.group(1).strip() else ""
+
+
+def resolve_id(ow_data_object: ISetDataObject) -> str:
+    """
+    SurfaceGrids in ISetDataObjects can be of type Map2D or RGrid.
+    Rgrids are the simpler original grid type, which correponds to a simple grid, with the id set to the data object id.
+    Map2D objects are created when the user drags a "Grid & Contour" object into the ISet.
+    The Map2D is a container and contains a reference to the Rgrid object plus a polygon with its contour.
+    Therefore, the data object id associated with it, is not the id of the grid, but of the container.
+    For the Map2D objects, the grid_id of the internal surface is extracted from the native_uid, which is a json-like string.
+    We thus have to first get the value of the key "data_key", which is itself a list of property=value pairs
+    encoded in a colon-separated string.  We then extract the gridId property value from that list using a regexp.
+    In the future, other dtataypes may need to be parsed for exceptions in their ids as well.
+    """
+    if ow_data_object.data_type == OWDataType.MAP2D.value:
+        return _resolve_map2d_grid_id(ow_data_object.native_uid)
+
+    # for objects other than Map2D, we assume the data object id is the direct id of the intended object
+    if not ow_data_object.data_object_id:
+        return ""
+    return str(ow_data_object.data_object_id) 
+
+
+def map_collection_item(
+    ow_data_object: ISetDataObject,
+    source_context: SourceContext,
+    processing_metadata: ProcessingMetadata | None = None,
+) -> CollectionItem:
+    """Map an OW ISetDataObject to a CollectionItem.
+
+    Args:
+        ow_data_object: DSIS native ISetDataObject to convert
+        collection_id: processing_id of the parent Collection
+        source_context: SourceContext with database/project info
+        processing_metadata: optional processing metadata (UUIDs, timestamps, etc.)
+
+    Returns:
+        CollectionItem instance
+    """
+    if ow_data_object.update_date is None:
+        ow_data_object.update_date = ow_data_object.create_date
+        ow_data_object.update_user_id = ow_data_object.create_user_id
+
+    ow_id: str = str(ow_data_object.data_object_id) if ow_data_object.data_object_id else ow_data_object.data_key
+    source_metadata = SourceMetadata(
+        system=SourceSystem.OPENWORKS,
+        database=source_context.database,
+        project=source_context.project,
+        id=ow_id,
+        name=ow_data_object.data_object_name,
+        remark=ow_data_object.remark,
+        create_user=ow_data_object.create_user_id,
+        update_user=ow_data_object.update_user_id,
+        create_date=ow_data_object.create_date,
+        create_date_utc=convert_date_to_utc(
+            ow_data_object.create_date, source_context.timezone
+        ) if ow_data_object.create_date is not None else None,
+        update_date=ow_data_object.update_date,
+        update_date_utc=convert_date_to_utc(
+            ow_data_object.update_date, source_context.timezone
+        ) if ow_data_object.update_date is not None else None,
+    )
+
+    source_ow_metadata = OWCollectionItemMetadata(
+        data_type=ow_data_object.data_type,
+        data_key=ow_data_object.data_key,
+        interpretation_set_id=ow_data_object.interpretation_set_id,
+        iset_folder_id=ow_data_object.iset_folder_id,
+    )
+
+    ow_datatype: OWDataType = OWDataType(ow_data_object.data_type) if ow_data_object.data_type in OWDataType._value2member_map_ else OWDataType.OTHERS
+    resolved_datatype: InterpretationDataType = map_dataobject_datatype(ow_datatype)
+    resolved_id = resolve_id(ow_data_object)
+    collection_id = ow_data_object.interpretation_set_id
+
+    return CollectionItem(
+        id = id_generate(source_context, f"Collection:{collection_id}:{resolved_datatype.value}:{resolved_id}"),
+        collection_id=id_generate(source_context, collection_id),
+        object_id=id_generate(source_context, resolved_id),
+        datatype=resolved_datatype,
+        source=source_metadata,
+        source_ow=source_ow_metadata,
+        processing=processing_metadata,
+    )

interpretation_models-0.4.0/src/mappers/metadata_ow.py

@@ -0,0 +1,18 @@
+import datetime
+from models.metadata import SourceContext
+import pytz
+
+
+def id_generate(
+    context: SourceContext, native_id: str
+) -> str:
+    return f"{context.database}:{context.project}:{native_id}"
+
+def convert_date_to_utc(
+    date: datetime.datetime, timezone: str | None = None
+) -> datetime.datetime | None:
+    if timezone is None:
+        return date
+    local_tz = pytz.timezone(timezone)
+    local_dt = local_tz.localize(date) if date.tzinfo is None else date.astimezone(local_tz)
+    return local_dt.astimezone(pytz.utc)

{interpretation_models-0.2.0 → interpretation_models-0.4.0}/src/mappers/surfacegrid_ow.py

@@ -1,17 +1,18 @@
 import math
 
 from models.metadata import SourceContext
-from models.metadata import SourceMetadata, SourceSystem, OWMetadata, ProcessingMetadata
+from models.enums import SourceSystem
+from models.metadata import SourceMetadata, OWSurfaceGridMetadata, InterpretationProcessingMetadata
 from models.interpretation import GridGeometry
 from models.interpretation import SurfaceGridRecord
-from mappers.metadata_ow import convert_date_to_utc
+from mappers.metadata_ow import convert_date_to_utc, id_generate
 from dsis_model_sdk.models.common import SurfaceGrid, SurfaceGridProperties
 
 
 def map_surfacegrid(
     ow_surface: SurfaceGrid | SurfaceGridProperties,
     source_context: SourceContext,
-    processing_metadata: ProcessingMetadata | None = None,
+    processing_metadata: InterpretationProcessingMetadata | None = None,
 ) -> SurfaceGridRecord:
     """Map an OW SurfaceGrid to a SurfaceGridRecord.
 
@@ -26,6 +27,7 @@ def map_surfacegrid(
     if ow_surface.update_date is None:
         ow_surface.update_date = ow_surface.create_date
         ow_surface.update_user_id = ow_surface.create_user_id
+
     source_metadata = SourceMetadata(
         system=SourceSystem.OPENWORKS,
         database=source_context.database,
@@ -40,17 +42,17 @@ def map_surfacegrid(
         create_date=ow_surface.create_date,
         create_date_utc=convert_date_to_utc(
             ow_surface.create_date, source_context.timezone
-        ),
+        ) if ow_surface.create_date is not None else None,
         update_date=ow_surface.update_date,
         update_date_utc=convert_date_to_utc(
             ow_surface.update_date, source_context.timezone
-        ),
+        ) if ow_surface.update_date is not None else None,
+    )
 
-        ow=OWMetadata(
-            geo_name=ow_surface.geo_name,
-            geo_type=ow_surface.geo_type,
-            attribute=ow_surface.attribute,
-        ),
+    source_ow_metadata = OWSurfaceGridMetadata(
+        geo_name=ow_surface.geo_name,
+        geo_type=ow_surface.geo_type,
+        attribute=ow_surface.attribute,
     )
 
     geometry = GridGeometry(
@@ -66,12 +68,18 @@ def map_surfacegrid(
         left_handed=True,
     )
 
+    # id is nullable, so we try to iterate through other unique attributes in case it is null
+    native_id: str = ow_surface.native_uid or ow_surface.alternate_uid or ow_surface.map_data_set_name
+    parent_id = ow_surface.parent_surface_grid_id if isinstance(ow_surface, SurfaceGridProperties) else None
     return SurfaceGridRecord(
+        id=id_generate(source_context, native_id),
         source=source_metadata,
+        source_ow=source_ow_metadata,
         processing=processing_metadata,
         geometry=geometry,
         crs=ow_surface.crs or source_context.crs,
         z_domain=ow_surface.data_domain,
         z_unit=ow_surface.z_unit,
         extent=None,  # TODO: calculate from grid geometry
+        parent_surface_id=parent_id
     )

interpretation_models-0.4.0/src/models/collection.py

@@ -0,0 +1,20 @@
+from pydantic import BaseModel
+from models.enums import InterpretationDataType
+from models.metadata import SourceMetadata, ProcessingMetadata, OWCollectionMetadata, OWCollectionItemMetadata
+
+
+class CollectionItem(BaseModel):
+    id:str
+    collection_id: str
+    object_id: str
+    datatype: InterpretationDataType
+    source: SourceMetadata | None = None
+    source_ow: OWCollectionItemMetadata | None = None
+    processing: ProcessingMetadata | None = None
+
+
+class Collection(BaseModel):
+    id: str
+    source: SourceMetadata | None = None
+    source_ow: OWCollectionMetadata | None = None
+    processing: ProcessingMetadata | None = None

interpretation_models-0.4.0/src/models/enums.py

@@ -0,0 +1,32 @@
+from enum import Enum
+
+
+class SourceSystem(str, Enum):
+    OPENWORKS = "OpenWorks R5000"
+    PETREL = "Petrel Studio"
+
+
+class InterpretationDataType(str, Enum):
+    SURFACE_GRID = "SurfaceGrid"
+    HORIZON = "Horizon"
+    POLYGON = "Polygon"
+    FAULT = "Fault"
+    POINT_SET = "PointSet"
+    OTHERS = "Others"
+
+
+class UpdateType(str, Enum):
+    OBJECT_CREATE = "ObjectCreate"
+    OBJECT_UPDATE = "ObjectUpdate"
+    OBJECT_DELETE = "ObjectDelete"
+    COLLECTION_INSERT = "CollectionInsert"
+    COLLECTION_REMOVE = "CollectionRemove"
+
+
+class OWDataType(str, Enum):
+    MAP2D = "Map2D"
+    RGRID = "Rgrid"
+    HORIZON3D = "HorizonAttributeCatalog"
+    POLYGON_SET = "MappingPolySet"
+    POINT_SET = "PointSet"
+    OTHERS = "Others"

interpretation_models-0.4.0/src/models/interpretation.py

@@ -0,0 +1,55 @@
+from pydantic import BaseModel
+from models.extent import Extent
+from models.metadata import SourceMetadata, InterpretationProcessingMetadata, OWMetadata, OWSurfaceGridMetadata, PetrelMetadata
+
+
+class InterpretationRecord(BaseModel):
+    id: str
+    source: SourceMetadata | None = None
+    source_ow: OWMetadata | None = None
+    source_petrel: PetrelMetadata | None = None
+    processing: InterpretationProcessingMetadata | None = None
+    extent: Extent | None = None
+    crs: str | None = None
+    z_domain: str | None = None
+    z_unit: str | None = None
+
+
+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 GriddedInterpretationRecord(InterpretationRecord):
+    geometry: GridGeometry | None = None
+    grid_null_value: float | None = None
+    grid_ntotal: int | None = None
+    grid_nnan: int | None = None
+
+
+class VectorInterpretationRecord(InterpretationRecord):
+    num_points: int | None = None
+    num_properties: int | None = None
+
+
+class SurfaceGridRecord(GriddedInterpretationRecord):
+    """
+    A surface defined in a regular 2D grid containing values for each of the points in the grid.
+    The grid geometry is defined by the ``geometry`` parameters, which are sufficient to locate each point in space.
+    SurfaceGrids are typically (but not necessarily) originated from a horizon, replacing its seismic bin grid by a
+    locally defined grid (potentially after regridding)
+    The values are stored separately as a flattened 2D array, the format of which is explained in
+    http://github.com/equinor/interpretation-models/docs/bulk_data_models.md
+    The values can represent a structural surface (depth or time) or a property defined on a surface
+    (e.g. attribute, uncertainty, …).
+    In the case the values represent a property, there's optionally included a parent structural surface that the
+    property is defined on.
+    """
+    source_ow: OWSurfaceGridMetadata | None = None
+    parent_surface_id: str | None = None

{interpretation_models-0.2.0 → interpretation_models-0.4.0}/src/models/metadata.py

@@ -1,23 +1,35 @@
 from pydantic import BaseModel
 from datetime import datetime
-from enum import Enum
+from models.enums import SourceSystem
 
 
-class SourceSystem(str, Enum):
-    OPENWORKS = "OpenWorks R5000"
-    PETREL = "Petrel Studio"
+class ProcessingMetadata(BaseModel):
+    create_date: datetime | None = None
+    update_date: datetime | None = None
 
 
-class OWMetadata(BaseModel):
-    geo_name: str | None = None
-    geo_type: str | None = None
-    attribute: str | None = None
+class InterpretationProcessingMetadata(ProcessingMetadata):
+    """
+    Metadata related to the processing of the data, such as timestamps, UUIDs, etc.
+    This is included only so these attributes can be included in the table schemas derived from the interpretation models,
+    Callers can send the information to include directly in the output object without transformation.
+    It is optional - if not storing intermediate processing information, this can be skipped.
+    """
+    file_available: bool | None = None
+    file_error_message: str | None = None
+    file_path: str | None = None
 
 
-class PetrelMetadata(BaseModel):
-    business_project: str | None = None
-    data_status: str | None = None
-    confidence_factor: str | None = None
+class SourceContext(BaseModel):
+    """
+    Meant as input only so callers can represent project metadata which is not present in typed source objects.
+    In the output models, the information derived from this is included as part of SourceMetadata.
+    See docs/design_interpretations#source-context for more details.
+    """
+    database: str
+    project: str
+    timezone: str | None = None
+    crs: str | None = None
 
 
 class SourceMetadata(BaseModel):
@@ -33,32 +45,32 @@ class SourceMetadata(BaseModel):
     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 ProcessingMetadata(BaseModel):
-    """
-    Metadata related to the processing of the data, such as timestamps, UUIDs, etc.
-    This is included only so these attributes can be included in the table schemas derived from the interpretation models,
-    Callers can send the information to include directly in the output object without transformation.
-    It is optional - if not storing intermediate processing information, this can be skipped.
-    """
-    id: str
-    create_date: datetime | None = None
-    update_date: datetime | None = None
-    file_availability: str | None = None
-    deleted: bool | None = None
-    delete_date: datetime | None = None
+class OWMetadata(BaseModel):
+    """Base class for OpenWorks source metadata. Subclassed for each interpretation type."""
+    pass
 
 
-class SourceContext(BaseModel):
-    """
-    Meant as input only so callers can represent project metadata which is not present in typed source objects.
-    In the output models, the information derived from this is included as part of SourceMetadata.
-    See docs/design_interpretations#source-context for more details.
-    """
-    database: str
-    project: str
-    timezone: str | None = None
-    crs: str | None = None
+class OWSurfaceGridMetadata(OWMetadata):
+    """OpenWorks metadata specific to surface grids."""
+    geo_name: str | None = None
+    geo_type: str | None = None
+    attribute: str | None = None
+
+
+class OWCollectionMetadata(OWMetadata):
+    field_prospect_name: str | None = None
+
+
+class OWCollectionItemMetadata(OWMetadata):
+    data_type: str | None = None
+    data_key: str | None = None
+    interpretation_set_id: str | None = None
+    iset_folder_id: int | None = None
+
+
+class PetrelMetadata(BaseModel):
+    business_project: str | None = None
+    data_status: str | None = None
+    confidence_factor: str | None = None

interpretation_models-0.4.0/src/schemas/__init__.py

@@ -0,0 +1,6 @@
+from schemas.registry import SchemaName, SchemaRegistry
+
+__all__ = [
+    "SchemaName",
+    "SchemaRegistry",
+]