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

osdu_models/workproductcomponent/planned_lithology/v1_0_0.py

@@ -0,0 +1,141 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/planned_lithology/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_0_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_0_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class GeologyInterval(BaseModel):
+    """
+    Geology Interval Component Schema
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    IntervalMeasuredDepthTop: float = Field(..., title='Interval Measured Depth Top')
+    """
+    Measured depth at top of interval.
+    """
+    IntervalMeasuredDepthBase: float = Field(..., title='Interval Measured Depth Base')
+    """
+    Measured depth at base of interval.
+    """
+    IntervalTVDTop: float | None = Field(None, title='Interval True Vertical Depth Top')
+    """
+    True vertical depth at top of the section.
+    """
+    IntervalTVDBase: float | None = Field(
+        None, title='Interval True Vertical Depth Base'
+    )
+    """
+    True vertical depth at base of interval.
+    """
+    LithostratigraphicIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-LithoStratigraphy:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Lithostratigraphic')
+    """
+    Name of lithostratigraphy, regionally dependent.
+    """
+    ChronostratigraphicIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-ChronoStratigraphy:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Chronostratigraphic')
+    """
+    Chronostratigraphic classification.
+    """
+    Description: str | None = Field(None, title='Description')
+    """
+    Description of item and details.
+    """
+    ReferenceWellboreTrajectoryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellboreTrajectory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reference Wellbore Trajectory ID')
+    """
+    Identifier of the reference trajectory for TVD measurements
+    """
+    ReferenceDatum: str | None = Field(None, title='Reference Datum')
+    """
+    Description of the Reference Datum used for Depth Measurement
+    """
+    LithologyTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-LithologyType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Lithology Type IDs')
+    """
+    The geological name for the type of lithology from the enum table listing a 
+    					subset of the OneGeology / CGI defined formation types.
+    """
+    LithologyTypeIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-LithologyType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Lithology Type IDs')
+    """
+    Array of lithological types - allowing for one or more lithological types.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for PlannedLithology 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellName: str | None = Field(None, title='Well Name')
+    """
+    Human recognizable context for the well that contains the wellbore.
+    """
+    WellboreName: str | None = Field(None, title='Wellbore Name')
+    """
+    Human recognizable context for the wellbore that contains the mud log
+    """
+    WellID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-WellPlanningWell:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Well ID')
+    """
+    Reference to the Well
+    """
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-WellPlanningWellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore ID')
+    """
+    Reference to the Wellbore
+    """
+    MeasuredDepthTop: float | None = Field(None, title='Measured Depth Top')
+    """
+    The minimum mdTop value for this object. This is an API "structural-range" query parameter for growing objects. See the relevant API specification for the query behavior related to this element.
+    """
+    MeasuredDepthBase: float | None = Field(None, title='Measured Depth Base')
+    """
+    The maximum mdTop value for this object. This is an API "structural-range" query parameter for growing objects. See the relevant API specification for the query behavior related to this element.
+    """
+    GeologyIntervals: list[GeologyInterval] | None = Field(
+        None, title='Geology Interval'
+    )
+    """
+    Set of geology and drilling information records for the wellbore. This is an API "data-node" query parameter for growing objects. See the relevant API specification for the query behavior related to this element.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/planned_lithology/v1_1_0.py

@@ -0,0 +1,141 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/planned_lithology/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_1_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class GeologyInterval(BaseModel):
+    """
+    Geology Interval Component Schema
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    IntervalMeasuredDepthTop: float = Field(..., title='Interval Measured Depth Top')
+    """
+    Measured depth at top of interval.
+    """
+    IntervalMeasuredDepthBase: float = Field(..., title='Interval Measured Depth Base')
+    """
+    Measured depth at base of interval.
+    """
+    IntervalTVDTop: float | None = Field(None, title='Interval True Vertical Depth Top')
+    """
+    True vertical depth at top of the section.
+    """
+    IntervalTVDBase: float | None = Field(
+        None, title='Interval True Vertical Depth Base'
+    )
+    """
+    True vertical depth at base of interval.
+    """
+    LithostratigraphicIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-LithoStratigraphy:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Lithostratigraphic')
+    """
+    Name of lithostratigraphy, regionally dependent.
+    """
+    ChronostratigraphicIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-ChronoStratigraphy:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Chronostratigraphic')
+    """
+    Chronostratigraphic classification.
+    """
+    Description: str | None = Field(None, title='Description')
+    """
+    Description of item and details.
+    """
+    ReferenceWellboreTrajectoryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellboreTrajectory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reference Wellbore Trajectory ID')
+    """
+    Identifier of the reference trajectory for TVD measurements
+    """
+    ReferenceDatum: str | None = Field(None, title='Reference Datum')
+    """
+    Description of the Reference Datum used for Depth Measurement
+    """
+    LithologyTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-LithologyType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Lithology Type IDs')
+    """
+    The geological name for the type of lithology from the enum table listing a 
+    					subset of the OneGeology / CGI defined formation types.
+    """
+    LithologyTypeIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-LithologyType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Lithology Type IDs')
+    """
+    Array of lithological types - allowing for one or more lithological types.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for PlannedLithology 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellName: str | None = Field(None, title='Well Name')
+    """
+    Human recognizable context for the well that contains the wellbore.
+    """
+    WellboreName: str | None = Field(None, title='Wellbore Name')
+    """
+    Human recognizable context for the wellbore that contains the mud log
+    """
+    WellID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-WellPlanningWell:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Well ID')
+    """
+    Reference to the Well
+    """
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-WellPlanningWellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore ID')
+    """
+    Reference to the Wellbore
+    """
+    MeasuredDepthTop: float | None = Field(None, title='Measured Depth Top')
+    """
+    The minimum mdTop value for this object. This is an API "structural-range" query parameter for growing objects. See the relevant API specification for the query behavior related to this element.
+    """
+    MeasuredDepthBase: float | None = Field(None, title='Measured Depth Base')
+    """
+    The maximum mdTop value for this object. This is an API "structural-range" query parameter for growing objects. See the relevant API specification for the query behavior related to this element.
+    """
+    GeologyIntervals: list[GeologyInterval] | None = Field(
+        None, title='Geology Interval'
+    )
+    """
+    Set of geology and drilling information records for the wellbore. This is an API "data-node" query parameter for growing objects. See the relevant API specification for the query behavior related to this element.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/planned_lithology/v1_2_0.py

@@ -0,0 +1,141 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/planned_lithology/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class GeologyInterval(BaseModel):
+    """
+    Geology Interval Component Schema
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    IntervalMeasuredDepthTop: float = Field(..., title='Interval Measured Depth Top')
+    """
+    Measured depth at top of interval.
+    """
+    IntervalMeasuredDepthBase: float = Field(..., title='Interval Measured Depth Base')
+    """
+    Measured depth at base of interval.
+    """
+    IntervalTVDTop: float | None = Field(None, title='Interval True Vertical Depth Top')
+    """
+    True vertical depth at top of the section.
+    """
+    IntervalTVDBase: float | None = Field(
+        None, title='Interval True Vertical Depth Base'
+    )
+    """
+    True vertical depth at base of interval.
+    """
+    LithostratigraphicIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-LithoStratigraphy:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Lithostratigraphic')
+    """
+    Name of lithostratigraphy, regionally dependent.
+    """
+    ChronostratigraphicIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-ChronoStratigraphy:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Chronostratigraphic')
+    """
+    Chronostratigraphic classification.
+    """
+    Description: str | None = Field(None, title='Description')
+    """
+    Description of item and details.
+    """
+    ReferenceWellboreTrajectoryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellboreTrajectory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reference Wellbore Trajectory ID')
+    """
+    Identifier of the reference trajectory for TVD measurements
+    """
+    ReferenceDatum: str | None = Field(None, title='Reference Datum')
+    """
+    Description of the Reference Datum used for Depth Measurement
+    """
+    LithologyTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-LithologyType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Lithology Type IDs')
+    """
+    The geological name for the type of lithology from the enum table listing a 
+    					subset of the OneGeology / CGI defined formation types.
+    """
+    LithologyTypeIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-LithologyType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Lithology Type IDs')
+    """
+    Array of lithological types - allowing for one or more lithological types.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for PlannedLithology 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellName: str | None = Field(None, title='Well Name')
+    """
+    Human recognizable context for the well that contains the wellbore.
+    """
+    WellboreName: str | None = Field(None, title='Wellbore Name')
+    """
+    Human recognizable context for the wellbore that contains the mud log
+    """
+    WellID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-WellPlanningWell:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Well ID')
+    """
+    Reference to the Well
+    """
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-WellPlanningWellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore ID')
+    """
+    Reference to the Wellbore
+    """
+    MeasuredDepthTop: float | None = Field(None, title='Measured Depth Top')
+    """
+    The minimum mdTop value for this object. This is an API "structural-range" query parameter for growing objects. See the relevant API specification for the query behavior related to this element.
+    """
+    MeasuredDepthBase: float | None = Field(None, title='Measured Depth Base')
+    """
+    The maximum mdTop value for this object. This is an API "structural-range" query parameter for growing objects. See the relevant API specification for the query behavior related to this element.
+    """
+    GeologyIntervals: list[GeologyInterval] | None = Field(
+        None, title='Geology Interval'
+    )
+    """
+    Set of geology and drilling information records for the wellbore. This is an API "data-node" query parameter for growing objects. See the relevant API specification for the query behavior related to this element.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/ppfgdataset/__init__.py

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

osdu_models/workproductcomponent/ppfgdataset/v1_0_0.py

@@ -0,0 +1,199 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/ppfgdataset/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, 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_wpcgroup_type.v1_0_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_0_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Curve(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    CurveID: str | None = None
+    """
+    The ID of the PPFG Curve
+    """
+    CurveName: str | None = None
+    """
+    The original or as supplied PPFG curve name. Intended to hold historical or legacy information
+    """
+    CurveMainFamilyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PPFGCurveMainFamily:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    ID of the Main Family Type of the PPFG quantity measured, for example 'Pore Pressure'. Primarily used for high level curve classification
+    """
+    CurveFamilyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PPFGCurveFamily:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    ID of the PPFG Curve Family of the PPFG quantity measured, for example 'Pore Pressure from Corrected Drilling Exponent'. An individual curve that belongs to a Main Family
+    """
+    CurveFamilyMnemonicID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PPFGCurveMnemonic:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    ID of the mnemonic of the Curve Family which is the value as received either from external providers or from internal processing team, for example 'PP DxC'
+    """
+    CurveProbabilityID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PPFGCurveProbability:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    ID of the PPFG Curve probability, for example 'Most Likely Case' and 'P50'
+    """
+    CurveDataProcessingTypeIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-PPFGCurveProcessingType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = None
+    """
+    IDs of the type and level of processing that has been applied to the curve. An array of curve processing operations that have been applied, for example 'Smoothed', 'Calibrated', etc
+    """
+    CurveLithologyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PPFGCurveLithoType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    ID of the lithological unit represented by the curve
+    """
+    CurveTransformModelTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PPFGCurveTransformModelType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    ID of the empirical calibrated model used for pressure calculations from a petrophysical curve (sonic or resistivity logs), for example 'Eaton' and  'Bowers',... 
+    """
+    CurveUOM: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Unit of Measure of the Physical Quantity Measured by the curve. An ID to relevant unit of measure reference
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for PPFGDataset 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Well:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = None
+    """
+    ID from the Well where the PPFG Work Product Component was recorded
+    """
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    ID from the Wellbore where the PPFG Work Product Component was recorded
+    """
+    RecordDate: str | None = None
+    """
+    The date that the PPFG data set was created by the PPFG practitioner or contractor
+    """
+    ContextTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PPFGContextType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    ID that reflects the context of the PPFG  data set, for example 'Pre-Drill' or 'Post-Drill'
+    """
+    ServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    ID of the service Company that acquired the PPFG
+    """
+    Comment: str | None = None
+    """
+    Open comments from the calculation team
+    """
+    ReferenceWellTrajectoryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellboreTrajectory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Id of the Reference WellTrajectory used for TVD's calculation
+    """
+    OffsetWellboreIDs: (
+        list[
+            constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        ]
+        | None
+    ) = None
+    """
+    IDs of the offset Wellbores included in the context and calculations of this PPFG data set
+    """
+    PrimaryReferenceCurveID: str | None = None
+    """
+    ID of the PPFG curve that is the primary reference or index. Derived from the PPFG curve ID 
+    """
+    PrimaryReferenceType: str | None = None
+    """
+    The type of the primary reference, for example 'TVDSS',  'MD' , 'TWT'
+    """
+    AbsentValueCharacters: str | None = None
+    """
+    The characters that represent absent curve values in this data set, for example  '-999', 'NULL', '0', etc. Typically for legacy data 
+    """
+    TectonicSetting: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TectonicSettingType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Tectonic Scenario Setting for Planning and Pore Pressure Practitioners. Built into interpretive curves. Can be, for example 'Strike Slip'
+    """
+    GaugeType: str | None = None
+    """
+    Free text to describe the type of gauge used for the pressure measurement
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = None
+    """
+    The Vertical Measurement for the Wellbore identified which defines the vertical reference pressure datum for the related PPFG curves in this data set. The pressure datum is used to calculate the average pressure gradient in
+    """
+    Curves: list[Curve] | None = None
+    """
+    Array of curve that constitutes the whole PPFG Dataset
+    """
+    ExtensionProperties: dict[str, Any] | None = None