osdu-python-models 0.5.0__py3-none-any.whl

osdu_models/masterdata/hole_section/v1_4_0.py

@@ -0,0 +1,122 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/hole_section/v1_4_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_facility_vertical_measurement import v1_0_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for HoleSection 1.4.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['namespace:master-data--Wellbore:11000091175501:'],
+        title='Wellbore ID',
+    )
+    """
+    Parent Wellbore Identifier
+    """
+    WellActivityID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-WellActivity:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--WellActivity:110000911755DRO:'],
+        title='Well Activity ID',
+    )
+    """
+    Identifier of the Well Activity in which the hole section was drilled
+    """
+    Name: str = Field(..., examples=['8.5" Hole Section'], title='Name')
+    """
+    Human recognizable context/name of the hole section.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None,
+        examples=[
+            {
+                'VerticalReferenceEntityID': 'osdu:master-data--Well:110000911755:',
+                'VerticalReferenceID': '5iePi',
+            }
+        ],
+        title='Vertical Measurement Reference',
+    )
+    """
+    References an entry in the VerticalMeasurements array for the Wellbore identified by WellboreID, or a standalone vertical reference which defines the vertical reference datum for all measured depths of the HoleSection record. If this is not populated, the VerticalMeasurement is derived from the Wellbore.
+    """
+    Size: float = Field(..., examples=['8.5 in'], title='Size')
+    """
+    The nominal diameter of the hole section.
+    """
+    MeasuredDepthTop: float = Field(
+        ..., examples=['10500 ft'], title='Measured Depth Start'
+    )
+    """
+    The Measured depth at the top of the hole section. For actual wellbores use data.VerticalMeasurement as wellbore ZDP. For planned wellbores, navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    MeasuredDepthBase: float = Field(
+        ..., examples=['20400 ft'], title='Measured Depth End'
+    )
+    """
+    The Measured depth at the base ('TD') of the hole section. For actual wellbores use data.VerticalMeasurement as wellbore ZDP. For planned wellbores, navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement. This property is required, which is inconvenient under drilling of the HoleSection. In such a case IsBeingDrilled is set to true and, by convention, MeasuredDepthBase is set to MeasuredDepthTop.
+    """
+    StartDateTime: str | None = Field(
+        None, examples=['2023-01-01T11:00:00.000Z'], title='Start Date/time'
+    )
+    """
+    Date/time when drilling commenced on the hole section.
+    """
+    EndDateTime: str | None = Field(
+        None, examples=['2023-03-17T18:30:00.000Z'], title='End Date/time'
+    )
+    """
+    Date/time when drilling completed on the hole section.
+    """
+    IsPilotHole: bool | None = Field(None, examples=[False], title='Is Pilot Hole')
+    """
+    Flag if Hole Section was drilled as a pilot hole
+    """
+    PlannedMeasuredDepthBase: float | None = Field(
+        None, examples=['20000 ft'], title='Planned Measured Depth Base'
+    )
+    """
+    Planned Base measured depth of the Hole Section. Only used for Actual Hole Sections to enable a comparison against plan.
+    """
+    PlannedTrueVerticalDepthBase: float | None = Field(
+        None, examples=['19200 ft'], title='Planned True Vertical Depth Base'
+    )
+    """
+    Planned Base true vertical depth of the Hole Section. Only used for Actual Hole Sections to enable a comparison against plan.
+    """
+    DrillingActivityCode: str | None = Field(
+        None, examples=['PROD'], title='Drilling Activity Code'
+    )
+    """
+    Activity Code relevant for drilling the hole section.
+    """
+    Comment: str | None = Field(
+        None,
+        examples=['8-1/2" hole section drilled 400\' deeper than plan.'],
+        title='Comment',
+    )
+    """
+    A comment or description associated with the hole section
+    """
+    IsBeingDrilled: bool | None = Field(
+        None, examples=[False], title='Is Section under Drilling?'
+    )
+    """
+    Boolean flag to indicate whether the HoleSection is in the process of being drilled (true) or completed (false or absent). During drilling (IsBeingDrilled=true) the MeasuredDepthBase value is set to MeasuredDepthTop.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/isolated_interval/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/masterdata/isolated_interval/v1_0_0.py

@@ -0,0 +1,110 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/isolated_interval/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_facility_vertical_measurement import v1_0_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_1_0 import AbstractMaster
+from ...abstract.abstract_facility.v1_0_0 import AbstractFacility
+
+
+class IsolatedIntervalBase(BaseModel):
+    """
+    The base of the IsolatedInterval.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='WellboreID')
+    """
+    The record id  of the wellbore object, to which this IsolatedIntervalBase element belongs
+    """
+    MeasuredDepthBase: float | None = Field(None, title='Measured Depth Base')
+    """
+    Bottom Measured depth of the interval
+    """
+    TrueVerticalDepthBase: float | None = Field(None, title='True Vertical Depth Base')
+    """
+    Bottom true vertical depth of the interval
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractFacility):
+    """
+    `data` payload for IsolatedInterval 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='WellboreID')
+    """
+    The record id  of the upper most isolation point within the wellbore object, to which this record belongs
+    """
+    Description: str | None = Field(None, title='Description')
+    """
+    A remark, comment or generic description.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='VerticalMeasurement'
+    )
+    """
+    The vertical measurement reference for the interval tops and bases. Either VerticalMeasurement with supplementing type properties or VerticalMeasurementID (an external vertical reference defined in the object VerticalReferenceEntityID) are populated.
+    """
+    IsolatedIntervalID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-IsolatedInterval:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='IsolatedIntervalID')
+    """
+    The 'parent' Isolated Interval ID, if there is a hierarchy of IsolatedIntervals.
+    """
+    SequenceNumber: int | None = Field(None, title='SequenceNumber')
+    """
+    The sequential number assigned to a Isolated Interval in the order it is created in the Wellbore.
+    """
+    IsolatedIntervalTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-IsolatedIntervalType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='IsolatedIntervalTypeID')
+    """
+    Denotes the category or type of the Isolated Interval. Reference Values: "Open hole"  or "Cased Hole"
+    """
+    MeasuredDepthTop: float | None = Field(None, title='Measured Depth Top')
+    """
+    Top measured depth of the interval relative to the VerticalMeasurement vertical reference.
+    """
+    TrueVerticalDepthTop: float | None = Field(None, title='True Vertical Depth Top')
+    """
+    Top true vertical depth of the interval relative to the VerticalMeasurement vertical reference.
+    """
+    IsolatedIntervalBases: list[IsolatedIntervalBase] | None = Field(
+        None, title='Isolated Interval Bases'
+    )
+    """
+    An array of one or more Wellbore(s) that complete the base of the interval. Can be used for Isolated Intervals that span multiple Wellbores within the same Well.
+    """
+    WellboreOpeningIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-WellboreOpening:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='WellboreOpeningIDs')
+    """
+    A list of associated Wellbore Opening IDs.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/isolated_interval/v1_1_0.py

@@ -0,0 +1,110 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/isolated_interval/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_facility_vertical_measurement import v1_0_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+from ...abstract.abstract_facility.v1_1_0 import AbstractFacility
+
+
+class IsolatedIntervalBase(BaseModel):
+    """
+    The base of the IsolatedInterval.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='WellboreID')
+    """
+    The record id  of the wellbore object, to which this IsolatedIntervalBase element belongs
+    """
+    MeasuredDepthBase: float | None = Field(None, title='Measured Depth Base')
+    """
+    Bottom Measured depth of the interval
+    """
+    TrueVerticalDepthBase: float | None = Field(None, title='True Vertical Depth Base')
+    """
+    Bottom true vertical depth of the interval
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractFacility):
+    """
+    `data` payload for IsolatedInterval 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='WellboreID')
+    """
+    The record id  of the upper most isolation point within the wellbore object, to which this record belongs
+    """
+    Description: str | None = Field(None, title='Description')
+    """
+    A remark, comment or generic description.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='VerticalMeasurement'
+    )
+    """
+    The vertical measurement reference for the interval tops and bases. Either VerticalMeasurement with supplementing type properties or VerticalMeasurementID (an external vertical reference defined in the object VerticalReferenceEntityID) are populated.
+    """
+    IsolatedIntervalID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-IsolatedInterval:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='IsolatedIntervalID')
+    """
+    The 'parent' Isolated Interval ID, if there is a hierarchy of IsolatedIntervals.
+    """
+    SequenceNumber: int | None = Field(None, title='SequenceNumber')
+    """
+    The sequential number assigned to a Isolated Interval in the order it is created in the Wellbore.
+    """
+    IsolatedIntervalTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-IsolatedIntervalType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='IsolatedIntervalTypeID')
+    """
+    Denotes the category or type of the Isolated Interval. Reference Values: "Open hole"  or "Cased Hole"
+    """
+    MeasuredDepthTop: float | None = Field(None, title='Measured Depth Top')
+    """
+    Top measured depth of the interval relative to the VerticalMeasurement vertical reference.
+    """
+    TrueVerticalDepthTop: float | None = Field(None, title='True Vertical Depth Top')
+    """
+    Top true vertical depth of the interval relative to the VerticalMeasurement vertical reference.
+    """
+    IsolatedIntervalBases: list[IsolatedIntervalBase] | None = Field(
+        None, title='Isolated Interval Bases'
+    )
+    """
+    An array of one or more Wellbore(s) that complete the base of the interval. Can be used for Isolated Intervals that span multiple Wellbores within the same Well.
+    """
+    WellboreOpeningIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-WellboreOpening:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='WellboreOpeningIDs')
+    """
+    A list of associated Wellbore Opening IDs.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/isolated_interval/v1_2_0.py

@@ -0,0 +1,211 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/isolated_interval/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_facility_vertical_measurement import v1_0_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+from ...abstract.abstract_facility.v1_1_0 import AbstractFacility
+
+
+class IsolatedIntervalBase(BaseModel):
+    """
+    The base of the IsolatedInterval.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['partition-id:master-data--Wellbore:11000091175501:'],
+        title='WellboreID',
+    )
+    """
+    The record id  of the wellbore object, to which this IsolatedIntervalBase element belongs
+    """
+    MeasuredDepthBase: float | None = Field(
+        None, examples=['5545 m'], title='Measured Depth Base'
+    )
+    """
+    Bottom Measured depth of the interval
+    """
+    TrueVerticalDepthBase: float | None = Field(None, title='True Vertical Depth Base')
+    """
+    Bottom true vertical depth of the interval
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractFacility):
+    """
+    `data` payload for IsolatedInterval 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--Wellbore:11000091175501:'],
+        title='WellboreID',
+    )
+    """
+    The record id  of the upper most isolation point within the wellbore object, to which this record belongs
+    """
+    Description: str | None = Field(
+        None, examples=['Original Completion'], title='Description'
+    )
+    """
+    A remark, comment or generic description.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='VerticalMeasurement'
+    )
+    """
+    The vertical measurement reference for the interval tops and bases. Either VerticalMeasurement with supplementing type properties or VerticalMeasurementID (an external vertical reference defined in the object VerticalReferenceEntityID) are populated.
+    """
+    IsolatedIntervalID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-IsolatedInterval:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--IsolatedInterval:11000091175501.1:'],
+        title='IsolatedIntervalID',
+    )
+    """
+    The 'parent' Isolated Interval ID, if there is a hierarchy of IsolatedIntervals.
+    """
+    SequenceNumber: int | None = Field(None, title='SequenceNumber')
+    """
+    The sequential number assigned to a Isolated Interval in the order it is created in the Wellbore.
+    """
+    IsolatedIntervalTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-IsolatedIntervalType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--IsolatedIntervalType:CasedHole.FullString:'
+        ],
+        title='IsolatedIntervalTypeID',
+    )
+    """
+    Denotes the category or type of the Isolated Interval. Reference Values: "Open hole"  or "Cased Hole"
+    """
+    MeasuredDepthTop: float | None = Field(
+        None, examples=['5515 m'], title='Measured Depth Top'
+    )
+    """
+    Top measured depth of the interval relative to the VerticalMeasurement vertical reference.
+    """
+    TrueVerticalDepthTop: float | None = Field(None, title='True Vertical Depth Top')
+    """
+    Top true vertical depth of the interval relative to the VerticalMeasurement vertical reference.
+    """
+    IsolatedIntervalBases: list[IsolatedIntervalBase] | None = Field(
+        None, title='Isolated Interval Bases'
+    )
+    """
+    An array of one or more Wellbore(s) that complete the base of the interval. Can be used for Isolated Intervals that span multiple Wellbores within the same Well.
+    """
+    WellboreOpeningIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-WellboreOpening:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='WellboreOpeningIDs')
+    """
+    A list of associated Wellbore Opening IDs.
+    """
+    IsCommingled: bool | None = Field(None, examples=[False], title='Is Commingled')
+    """
+    Does the Isolated Interval include commingled production?
+    """
+    ClassificationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-IsolatedIntervalClassification:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--IsolatedIntervalClassification:SweetOilProduction:'
+        ],
+        title='Classification',
+    )
+    """
+    Isolated Interval Classification
+    """
+    TubularAssemblyTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularAssemblyType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--TubularAssemblyType:CompletionStringLong:'
+        ],
+        title='Tubular String Type',
+    )
+    """
+    What type of completion assembly is used for the mechanical completion.
+    """
+    CementOptionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-IsolatedIntervalCementOption:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--IsolatedIntervalCementOption:Cemented:'],
+        title='Cement Option',
+    )
+    """
+    What type of cement option used for the isolated interval
+    """
+    ZoneAccessMechanismID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-IsolatedIntervalZoneAccessMechanism:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--IsolatedIntervalZoneAccessMechanism:TubingConveyedPerforation:'
+        ],
+        title='Zone Access Mechanism',
+    )
+    """
+    Zone access mechanism used to create a flow path between the formation/reservoir and the production annulus
+    """
+    IsolationMechanismID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-IsolatedIntervalIsolationMechanism:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--IsolatedIntervalIsolationMechanism:InflatablePackers:'
+        ],
+        title='Isolation Mechanism',
+    )
+    """
+    Mechanism used to achieve pressure/hydraulic isolation within the interval
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/model_feature/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/masterdata/model_feature/v1_0_0.py

@@ -0,0 +1,23 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/model_feature/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_0_0 import AbstractMaster
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for ModelFeature 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str | None = Field(None, title='Name')
+    """
+    The name of the model feature.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/model_feature/v1_1_0.py

@@ -0,0 +1,23 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/model_feature/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for ModelFeature 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str | None = Field(None, title='Name')
+    """
+    The name of the model feature.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/operations_report/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4