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

osdu_models/workproductcomponent/well_pressure_test_raw_measurement/v1_1_0.py

@@ -0,0 +1,279 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/well_pressure_test_raw_measurement/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ...abstract.abstract_column_based_table import v1_2_1
+from ...abstract.abstract_facility_vertical_measurement import v1_0_0
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_1 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class PreTest(BaseModel):
+    """
+    Describes the pieces of information required to identity individual pretests within the complete record.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    PreTestNumber: int | None = Field(None, title='Pre Test Number')
+    """
+    DEPRECATED: Sequential number identifying the pretest within the record
+    """
+    PreTestStartTime: float | None = Field(None, title='Pre Test Start Time')
+    """
+    DEPRECATED: Time index where the individual pretest starts into the sequence
+    """
+    PreTestEndTime: float | None = Field(None, title='Pre Test End Time')
+    """
+    DEPRECATED: Time index where the individual pretest ends into the sequence
+    """
+
+
+class Curve(BaseModel):
+    """
+    Describing the characteristics of the "Pressure against Time" recorded curves.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    CurveID: str | None = Field(None, title='Curve ID')
+    """
+    The ID of the Well Log Curve
+    """
+    NullValue: bool | None = Field(None, title='Null Value')
+    """
+    Indicates that there is no measurement within the curve
+    """
+    TimeUnitID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Time Unit ID')
+    """
+    Unit of Measure Time Reference
+    """
+    CurveUnitID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Curve Unit ID')
+    """
+    Unit of Measure for the Log Curve
+    """
+    Mnemonic: str | None = Field(None, examples=['PRES_HDRB.BAR'], title='Mnemonic')
+    """
+    The Mnemonic of the Log Curve is the value as received either from Raw Providers or from Internal Processing team
+    """
+    NumberOfColumns: int | None = Field(None, examples=[192], title='Number Of Columns')
+    """
+    The number of columns present in this Curve for a single reference value. For simple logs this is typically 1; for image logs this holds the number of image traces or property series. Further information about the columns can be obtained via the respective log or curve APIs of the Domain Data Management Service.
+    """
+    CurveSampleTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CurveSampleType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--CurveSampleType:float:'],
+        title='Curve Sample Type ID',
+    )
+    """
+    The value type to be expected as curve sample values.
+    """
+    CurveDescription: str | None = Field(
+        None,
+        examples=[
+            'CBL Adjustment Factor, Resistivity Inversion Selection, Detector 1 Barite Constant'
+        ],
+        title='Curve Description',
+    )
+    """
+    Mnemonic-level curve description is used during parsing or reading and ingesting LAS or DLIS files, to explain the type of measurement being looked at, specifically for that moment. Curve description is specific to that single (log) mnemonic and for the entire log (acquisition run) interval. In essence, curve description defines the internal factors such as what the "curve" or measurement ideally is representing, how is it calculated, what are the assumptions and the "constants".
+    """
+
+
+class MeasurementPeriod(BaseModel):
+    """
+    Contains information about the individual, discrete events or periods during a wellbore pressure test
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    PeriodNumber: int | None = Field(None, title='Period Number')
+    """
+    Sequential number identifying the period within the record
+    """
+    PeriodStartTime: float | None = Field(None, title='Period Start Time')
+    """
+    Time index where the individual period starts into the sequence
+    """
+    PeriodEndTime: float | None = Field(None, title='Period End Time')
+    """
+    Time index where the individual period ends into the sequence
+    """
+    MeasurementPeriodKind: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellPressureTestMeasurementPeriodKind:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Measurement Period Kind')
+    """
+    An identifying kind of the MeasurementPeriod e.g. BuildUp, FallOff, PreTest
+    """
+    MeasurementPeriodMeasurements: v1_2_1.AbstractColumnBasedTable | None = Field(
+        None, title='Measurement Period Measurements'
+    )
+    """
+    An embedded ColumnBasedTable containing the Measurements within the period that are required (and only if required) for indexing
+    """
+
+
+class Measurement(BaseModel):
+    """
+    Unitary Measurement Serie Description
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellPressureTestAcquisitionStationIdentifier: int | None = Field(
+        None, title='Well Pressure Test Acquisition Station Identifier'
+    )
+    """
+    Identifier of the Station within the acquisition job captured in the unitary serie
+    """
+    IsStationary: bool | None = Field(None, title='Is Stationary')
+    """
+    Boolean describing if the test serie is run at constant depth (as opposed as at different stations)
+    """
+    PressurePointMeasuredDepth: float | None = Field(
+        None, title='Pressure Point Measured Depth'
+    )
+    """
+    Measured Depth of the station for Stationary Tests - mutually exclusive with (PressureTestTop/bottom measuredDepth
+    """
+    PressureTestTopMeasuredDepth: float | None = Field(
+        None, title='Pressure Point Top Measured Depth'
+    )
+    """
+    Measured Depth of the top station for Non Stationary Tests - mutually exclusive with (Pressure Point Measured Depth
+    """
+    PressureTestBottomMeasuredDepth: float | None = Field(
+        None, title='Pressure Point Bottom Measured Depth'
+    )
+    """
+    Measured Depth of the bottom station for Non Stationary Tests- mutually exclusive with (Pressure Point Measured Depth
+    """
+    TestNumber: int | None = Field(None, title='Test Number')
+    """
+    Sequential number of the test (or pre-test) which identifies it into the record
+    """
+    ActiveProbeTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-WellPressureTestProbeType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Pressure Test Probe Type Identifier')
+    """
+    Describe the active Probe type for this current measurement station
+    """
+    ActiveGaugeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellPressureTestGaugeType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Active Gauge Identifier')
+    """
+    Identifier of the unitary gauge active for this specific curve measurement
+    """
+    PreTests: list[PreTest] | None = Field(None, title='Pre Tests')
+    """
+    DEPRECATED - PLEASE USE "MEASUREMENT PERIOD" INSTEAD: array of information to identify pretests measurements within the complete measurement recording.
+    """
+    IsTubular: bool | None = Field(None, title='Is Tubular')
+    """
+    Boolean that indicates the measurement is tubular (meaning proceeded inside the installed tubular) - or annular otherwise.
+    """
+    DetailedTestTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellPressureDetailedTestCategory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Detailed Test Type ID')
+    """
+    Identifier of the detailed test run at this station (such as miniDST, miniFrac,…)
+    """
+    DepthReference: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='Depth Reference'
+    )
+    """
+    The vertical measurement reference for this well logging acquisition activity. This object defines the vertical reference datum for the measured depths.
+    """
+    TestReliabilityID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellPressureTestValidityStatus:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Test Reliability ID')
+    """
+    Identifier of the reference data record indicating the reliability of the tests. This encapsulates the common "TestSuccess" notion - but allows for more flexibility
+    """
+    MeasurementPeriods: list[MeasurementPeriod] | None = Field(
+        None, title='Measurement Periods'
+    )
+    """
+    array of information to identify interval times within the complete measurement recording, significant in themselves - such as PreTests in Formation Pressure Test - BuildUp/Close-in intervals in Build Ups production pressure tests,….
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for WellPressureTestRawMeasurement 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellPressureTestAcquisitionJobID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-WellPressureTestAcquisitionJob:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Well Pressure Test Acquisition Job ID')
+    """
+    Identifier of the acquisition job master data.
+    """
+    WellPressureTestAcquisitionRunIdentifier: int = Field(
+        ..., title='Well Pressure Test Acquisition Run Identifier'
+    )
+    """
+    Identifier of the Run within the acquisition job
+    """
+    AcquisitionStringToolFace: float | None = Field(
+        None, title='Acquisition String ToolFace'
+    )
+    """
+    Angle of rotation of the Acquisition String while running this test
+    """
+    PressureTestStartDate: str | None = Field(None, title='Pressure Test Start Date')
+    """
+    The date (and time) at which the test started
+    """
+    ClosedInDate: str | None = Field(None, title='Closed In Date')
+    """
+    Date that the production string has been closed in prior to the pressure test.
+    """
+    Measurements: list[Measurement] | None = Field(None, title='Measurements')
+    """
+    Array of comprehensive description of the well test raw measurement (one entry per gauge's depth)
+    """
+    Curves: list[Curve] | None = Field(None, title='Curves')
+    """
+    Array of unitary Curve (Pressure against Time) description
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/wellbore_interval_set/__init__.py

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

osdu_models/workproductcomponent/wellbore_interval_set/v1_0_0.py

@@ -0,0 +1,222 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/wellbore_interval_set/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_column_based_table import v1_0_0 as v1_0_0_1
+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 Interval(BaseModel):
+    """
+    An interval given either by relationships to top/base markers or standalone top/base depths. To avoid confusion about entry and exit depths the naming convention uses Start as the entry point of the well path into the geologic unit and Stop as the exit point. For unfolded geologic units and vertical wellbores Start is Top and Stop is Base.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    IntervalID: str | None = Field(
+        None, examples=['ba829e6d-30e0-4375-906c-4e7c62c9f7ec'], title='Interval ID'
+    )
+    """
+    The unique identifier of the interval array member in the data.Intervals[] array. Ideally a UUID.
+    """
+    GeologicUnitInterpretationIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:(work-product-component\-\-StratigraphicUnitInterpretation|work-product-component\-\-GeobodyInterpretation|work-product-component\-\-RockFluidUnitInterpretation):[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            [
+                'partition-id:work-product-component--StratigraphicUnitInterpretation:Draupne-:'
+            ]
+        ],
+        title='Interpretation Ids',
+    )
+    """
+    An array of StratigraphicUnitInterpretation, GeobodyInterpretation or RockFluidUnitInterpretation record Ids associated to this interval.
+    """
+    StartMeasuredDepth: float | None = Field(
+        None, examples=[4049], title='Start Interval Measured Depth'
+    )
+    """
+    The minimal MeasuredDepth of the interval. In the most common case this is the top.  If this value is associated with a marker then this value is a denormalization of data.Markers[].MarkerMeasuredDepth where the data.Markers[].MarkerID equals to StartMarkerID.
+    """
+    StartSubSeaVerticalDepth: float | None = Field(
+        None, examples=[4030.9], title='Start Sub-Sea Vertical Depth'
+    )
+    """
+    True vertical depth sub-sea of the start of the interval. This is the same as true vertical depth referenced to the vertical CRS "MSL depth". If the start of the interval is associated with a marker then this value is a denormalization of data.Markers[].MarkerSubSeaVerticalDepth where the data.Markers[].MarkerID equals to StartMarkerID.
+    """
+    StartIntervalName: str | None = Field(
+        None, examples=['Top-Draupne'], title='Start Interval Marker Name'
+    )
+    """
+    Name of the interval start (typically the top); when associated with a marker in a WellboreMarkerSet then this name is a denormalization of data.Markers[].MarkerName where the data.Markers[].MarkerID equals to StartMarkerID.
+    """
+    StartMarkerSetID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellboreMarkerSet:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:work-product-component--WellboreMarkerSet:15-3-7-SingleRank-:'
+        ],
+        title='Start Interval WellboreMarkerSet ID',
+    )
+    """
+    Optional reference to the WellboreMarkerSet containing the interval start (typically the top), with MarkerID equals StartMarkerID.
+    """
+    StartMarkerID: str | None = Field(
+        None,
+        examples=['a580a3bb-c2db-4845-bbc1-050b417307c0'],
+        title='Start Interval Marker ID',
+    )
+    """
+    Individual markers are not globally identifiable. TopMarkerID is the unique id (MarkerID) of the top interval marker (typically the interval base) in the data.Markers[] array where the data.Markers[].MarkerID equals to StartMarkerID.
+    """
+    StartBoundaryInterpretationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(work-product-component\-\-HorizonInterpretation|work-product-component\-\-GeobodyBoundaryInterpretation|work-product-component\-\-FaultInterpretation):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:work-product-component--HorizonInterpretation:Top-Draupne-:'
+        ],
+        title='Start Interval Boundary Interpretation ID',
+    )
+    """
+    The optional relationship to a HorizonInterpretation, GeobodyBoundaryInterpretation or FaultInterpretation. If the interval start (typically the top) is associated with a marker, this is considered a denormalization of the data.Markers[].InterpretationID for the data.Markers[].MarkerID equals to StartMarkerID.
+    """
+    StopMeasuredDepth: float | None = Field(
+        None, examples=[4502], title='Stop Interval Measured Depth'
+    )
+    """
+    The maximum MeasuredDepth of the interval (typically the base). If the interval stop is associated with a marker then this value is a denormalization of data.Markers[].MarkerMeasuredDepth where the data.Markers[].MarkerID equals to StopMarkerID.
+    """
+    StopSubSeaVerticalDepth: float | None = Field(
+        None, examples=[4483.8], title='Stop Sub-Sea Vertical Depth'
+    )
+    """
+    True vertical depth sub-sea of the interval stop (typically the base). This is the same as true vertical depth referenced to the vertical CRS "MSL depth". If the interval stop is associated with a marker then this value is a denormalization of data.Markers[].MarkerSubSeaVerticalDepth where the data.Markers[].MarkerID equals to StopMarkerID.
+    """
+    StopIntervalName: str | None = Field(
+        None, examples=['Top-Heather'], title='Stop Interval Marker Name'
+    )
+    """
+    Name of the interval stop (typically the base); when associated with a marker in a WellboreMarkerSet then this name is a denormalization of data.Markers[].MarkerName where the data.Markers[].MarkerID equals to StopMarkerID.
+    """
+    StopMarkerSetID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellboreMarkerSet:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:work-product-component--WellboreMarkerSet:15-3-7-SingleRank-:'
+        ],
+        title='Stop Interval WellboreMarkerSet ID',
+    )
+    """
+    Optional reference to the WellboreMarkerSet containing the top with MarkerID equals StopMarkerID.
+    """
+    StopMarkerID: str | None = Field(
+        None,
+        examples=['7699229b-36e8-4aed-884f-a1e844e5b9d7'],
+        title='Stop Interval Marker ID',
+    )
+    """
+    Individual markers are not globally identifiable. StopMarkerID is the unique id (MarkerID) of the interval stop (typically the interval base) in the data.Markers[] array where the data.Markers[].MarkerID equals to StopMarkerID.
+    """
+    StopBoundaryInterpretationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(work-product-component\-\-HorizonInterpretation|work-product-component\-\-GeobodyBoundaryInterpretation|work-product-component\-\-FaultInterpretation):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:work-product-component--HorizonInterpretation:Top-Heather-:'
+        ],
+        title='Stop Interval Boundary Interpretation ID',
+    )
+    """
+    The optional relationship to a HorizonInterpretation, GeobodyBoundaryInterpretation or FaultInterpretation. If the interval stop (typically the base) is associated with a marker, this is considered a denormalization of the data.Markers[].InterpretationID where the data.Markers[].MarkerID equals to StopMarkerID.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for WellboreIntervalSet 1.0.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:NPD-4055:'],
+        title='Wellbore ID',
+    )
+    """
+    The relationship to a Wellbore, to which this WellboreIntervalSet is associated with.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='Vertical Measurement'
+    )
+    """
+    References an entry in the Vertical Measurement array for the Wellbore identified by WellboreID, which defines the vertical reference datum for all marker measured depths of the WellboreIntervalSet Intervals array. It is strongly recommended specifying the VerticalMeasurement.WellboreTVDTrajectoryID  when SubSeaVerticalDepth are populated for the intervals.
+    """
+    StratigraphicColumnID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-StratigraphicColumn:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Stratigraphic Column ID')
+    """
+    The optional reference to a stratigraphic column (referring to multiple StratigraphicColumnRankInterpretation) providing the stratigraphic framework for the WellboreIntervalSet. It demonstrates the intent to describe complex, potentially overlapping stratigraphic intervals. Only one of the properties StratigraphicColumnID or StratigraphicColumnRankInterpretationID should be populated.
+    """
+    StratigraphicColumnRankInterpretationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-StratigraphicColumnRankInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:work-product-component--StratigraphicColumnRankInterpretation:Gudrun-Rank2-:'
+        ],
+        title='Stratigraphic Column Rank Interpretation ID',
+    )
+    """
+    The optional reference to a StratigraphicColumnRankInterpretation. It expresses the intent of a stratigraphic framework with non-overlapping intervals. Only one of the properties StratigraphicColumnID or StratigraphicColumnRankInterpretationID should be populated.
+    """
+    Intervals: list[Interval] | None = Field(None, title='Intervals')
+    """
+    Array of Intervals, index-aligned with IntervalProperties.
+    """
+    IntervalProperties: v1_0_0_1.AbstractColumnBasedTable | None = Field(
+        None, title='Interval Property Values'
+    )
+    """
+    An embedded ColumnBasedTable with the properties including their values associated to the intervals in data.Intervals[]. The association is done by array index.
+    """
+    ExtensionProperties: dict[str, Any] | None = None