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

osdu_models/masterdata/coring/v1_1_1.py

@@ -0,0 +1,332 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/coring/v1_1_1.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, RootModel, 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_project_activity.v1_0_0 import AbstractProjectActivity
+
+
+class CoreRemark(BaseModel):
+    """
+    An array contains narrative remarks pertaining to a core.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RemarkID: str | None = Field(None, title='Remark ID')
+    """
+    A unique identifier for each remark record.
+    """
+    Remark: str | None = Field(None, title='Remark')
+    """
+    A descriptive comment for this remark.
+    """
+    RemarkSource: str | None = Field(None, title='Remark Source')
+    """
+    The person, vendor, interpreter or other provider of information.
+    """
+
+
+class CoreSection(BaseModel):
+    """
+    An array of core sections.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    CoreSectionID: str | None = Field(None, examples=['2B'], title='Core Section ID')
+    """
+    A unique core section identifier, typically for human consumption.
+    """
+    RecoveredLength: float | None = Field(None, title='Recovered Length')
+    """
+    The length of core section recovered.
+    """
+    TopDepth: float | None = Field(None, title='Top Depth')
+    """
+    The measured depth at the top of this section, typically in driller's depth.
+    """
+    BottomDepth: float | None = Field(None, title='Bottom Depth')
+    """
+    The measured depth at the base of this section, typically driller's depth.
+    """
+
+
+class ConventionalCoring(BaseModel):
+    """
+    The Conventional Coring specific sub-structure.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    CoreTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ConventionalCoreType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--ConventionalCoreType:CONV:'],
+        title='Core Type ID',
+    )
+    """
+    The name identifying the type of coring procedure used to extract the core, e.g., Conventional Core,  Drop Cores.
+    """
+    CoreSections: list[CoreSection] | None = Field(None, title='Core Sections')
+    """
+    An array of core sections.
+    """
+    RecoveredLength: float | None = Field(None, title='Recovered Length')
+    """
+    The length of core recovered in this run.
+    """
+
+
+class Data11(BaseModel):
+    """
+    Properties relevant to conventional coring.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ConventionalCoring_1: ConventionalCoring = Field(
+        ..., alias='ConventionalCoring', title='Conventional Coring'
+    )
+    """
+    The Conventional Coring specific sub-structure.
+    """
+
+
+class SidewallCore(BaseModel):
+    """
+    A core taken during sidewall coring.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SampleID: str | None = Field(None, examples=[3], title='Sample ID')
+    """
+    Typically a sequential number identifying the sidewall core sample.
+    """
+    Depth: float | None = Field(None, examples=[2958.3], title='Depth')
+    """
+    The measured depth at position the sidewall core was taken, typically in logger's depth.
+    """
+    Description: str | None = Field(
+        None,
+        examples=[
+            'SANDSTONE:\xa0 (100%)\xa0 light olive grey, minor light grey to medium light grey, very soft to friable, fine to medium grained, predominantly fine grained, sub-angular, rare sub-rounded, sub-spherical, well to very well sorted, trace weak siliceous cement, trace argillaceous matrix, trace pinkish grey quartz grains, trace micro micas, trace carbonaceous (?) specks, good intergranular visual porosity.'
+        ],
+        title='Description',
+    )
+    """
+    The sidewall core sample description, if available.
+    """
+    RecoveredLength: float | None = Field(None, title='Recovered Length')
+    """
+    The recovered length of the sidewall core.
+    """
+
+
+class SidewallCoring(BaseModel):
+    """
+    The Sidewall Coring specific sub-structure.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    CoreTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SidewallCoreType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--SidewallCoreType:RSWC:'],
+        title='Core Type ID',
+    )
+    """
+    The name identifying the type of coring procedure used to extract the sidewall core, e.g., percussion or rotary (mechanical)  sidewall core.
+    """
+    SidewallCores: list[SidewallCore] | None = Field(None, title='Sidewall Cores')
+    """
+    The array of sidewall core samples, their depth and description.
+    """
+    PlannedVersusActual: float | None = Field(None, title='Planned versus Actual')
+    """
+    The ratio between planned sidewall cores versus the actually retrieved sidewall cores.
+    """
+
+
+class Data12(BaseModel):
+    """
+    Properties relevant to sidewall coring.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SidewallCoring_1: SidewallCoring = Field(
+        ..., alias='SidewallCoring', title='Sidewall Coring'
+    )
+    """
+    The Sidewall Coring specific sub-structure.
+    """
+
+
+class Data13(OsduCommonResources, AbstractMaster, AbstractProjectActivity):
+    """
+    `data` payload for Coring 1.1.1.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    CoreIdentifier: str | None = Field(
+        None, examples=['421112222200-Core1'], title='Core Identifier'
+    )
+    """
+    Native identifier from a Master Data Management System or other trusted source external to OSDU - stored here in order to allow for multi-system connection and synchronization. If used, the "Source" property should identify that source system. i.e. this item is optional.
+    """
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--Wellbore:421112222200:'],
+        title='Wellbore ID',
+    )
+    """
+    The relationship to the wellbore.
+    """
+    Name: str | None = Field(None, examples=['ACME 1 Core 1'], title='Name')
+    """
+    The name of the core. For example ACME 1 Core 1
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None,
+        examples=[
+            {
+                'VerticalReferenceID': 'ZDP',
+                'VerticalMeasurement': 0.0,
+                'VerticalMeasurementPathID': 'namespace:reference-data--VerticalMeasurementPath:MD:',
+                'VerticalMeasurementSourceID': 'namespace:reference-data--VerticalMeasurementSource:DRL:',
+                'VerticalMeasurementDescription': 'Same vertical reference as wellbore ZDP, Measured Depth, Drillers Depth.',
+            }
+        ],
+        title='Vertical Measurement',
+    )
+    """
+    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 Coring record.
+    """
+    ServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--Organisation:ACME-Limited-PLC:'],
+        title='Service Company ID',
+    )
+    """
+    The coring company that extracted the well core. For Example: ACME Limited PLC
+    """
+    TopDepth: float | None = Field(None, title='Top Depth')
+    """
+    The depth of the top of the core. The reference and kind of depth (e.g. driller's depth versus logger's depth) is described in data.VerticalMeasurement. For SidewallCores this is the depth of the shallowest core.
+    """
+    BottomDepth: float | None = Field(None, title='Bottom Depth')
+    """
+    The depth of the base of the core. The reference and kind of depth (e.g. driller's depth versus logger's depth) is described in data.VerticalMeasurement. For SidewallCores this is the depth of the deepest core.
+    """
+    RunNumber: int | None = Field(None, title='Run Number')
+    """
+    The coring run number.
+    """
+    CoreDiameter: float | None = Field(None, title='Core Diameter')
+    """
+    The diameter of the core.
+    """
+    CoreNumber: str | None = Field(None, title='Core Number')
+    """
+    The vendor assigned core number.
+    """
+    IsOriented: bool | None = Field(None, title='Core Oriented Indicator')
+    """
+    Indicates if the core was oriented.
+    """
+    CoreRemarks: list[CoreRemark] | None = Field(None, title='Core Remarks')
+    """
+    An array contains narrative remarks pertaining to a core.
+    """
+    PreferredDepthShiftsID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Preferred Depth Shifts ID')
+    """
+    The WellLog representation carrying the preferred core-depth to logging-depth correction or mapping.
+    """
+    HasTrippingSchedule: bool | None = Field(None, examples=[True])
+    """
+    Flag indicating whether a detailed tripping schedule is available. Available tripping schedules are usually a sign of controlled coring sample quality.
+    """
+    CoringOperationDate: str | None = Field(None, title='Recovery Date')
+    """
+    The date of the coring operation.
+    """
+    CoreRecoveredDate: str | None = Field(None, title='Core Recovered Date')
+    """
+    The date the core returned to surface.
+    """
+    PreservationTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CorePreservationType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Preservation Type ID')
+    """
+    The kind of preservation applied to this conventional coring or sidewall core.
+    """
+    ExtensionProperties: dict[str, Any] | None = None
+
+
+class Data14(Data11, Data13):
+    """
+    `data` payload for Coring 1.1.1.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+
+
+class Data15(Data12, Data13):
+    """
+    `data` payload for Coring 1.1.1.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+
+
+class Data(RootModel[Data14 | Data15]):
+    """
+    `data` payload for Coring 1.1.1.
+    """
+
+    root: Data14 | Data15 = Field(..., title='Data')
+    """
+    `data` payload for Coring 1.1.1.
+    """

osdu_models/masterdata/evaluation_plan/__init__.py

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

osdu_models/masterdata/evaluation_plan/v1_0_0.py

@@ -0,0 +1,232 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/evaluation_plan/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_master.v1_0_0 import AbstractMaster
+from ...abstract.abstract_project.v1_0_0 import AbstractProject
+
+
+class FormationIntegrityEvaluation(BaseModel):
+    """
+    A test performed to determine the integrity of a formation
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    PressureTestType: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FormationPressureTestType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Pressure Test Type')
+    """
+    The type of pressure test used in the evaluation of the formation
+    """
+    DesignKickTolerance: float | None = Field(None, title='Design Kick Tolerance')
+    """
+    The designed maximum gas volume for a given degree of underbalance which the circulation can be performed without exceeding the weakest formation in the wellbore
+    """
+    EquivalentMudWeightEstimated: float | None = Field(
+        None, title='Equivalent Mud Weight Estimated'
+    )
+    """
+    The total amount of pressure exerted at a true vertical depth which is denoted in the mud density.
+    """
+    MeasuredDepthCasingShoe: float | None = Field(
+        None, title='Measured Depth Casing Shoe'
+    )
+    """
+    The measured depth of the Casing Shoe during this evaluation. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    TrueVerticalDepthCasingShoe: float | None = Field(
+        None, title='True Vertical Depth Casing Shoe'
+    )
+    """
+    The true vertical depth of the Casing Shoe during this evaluation. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    TestFluidDensity: float | None = Field(None, title='Test Fluid Density')
+    """
+    The density of the fluid measured during the evaluation test
+    """
+    TestPressureAtSurface: float | None = Field(None, title='Test Pressure At Surface')
+    """
+    The pressure observed at the surface during the test.
+    """
+    MaxTestPressureAtSurface: float | None = Field(
+        None, title='Maximum Test Pressure At Surface'
+    )
+    """
+    The maximum pressure observed at the surface during the test.
+    """
+    TestingPumpingRate: float | None = Field(None, title='Testing Pumping Rate')
+    """
+    The pumping rate used during the integrity test.
+    """
+    DrilledIntervalBeforeTest: float | None = Field(
+        None, title='Drilled Interval Before Test'
+    )
+    """
+    The depth of the interval drilled before the integrity test. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    Comments: str | None = Field(None, title='Comments')
+    """
+    Comments associated with the formation integrity test
+    """
+    HasLeakOffOccurred: bool | None = Field(None, title='Has LeakOff Occurred')
+    """
+    Indicates if a leak off has occurred during the test
+    """
+    LeakOffPressure: float | None = Field(None, title='LeakOff Pressure')
+    """
+    The pressure observed from the LeakOff
+    """
+    VolumePumped: float | None = Field(None, title='Volume Pumped')
+    """
+    Amount of fluid pumped during the test
+    """
+    FormationName: str | None = Field(None, title='Formation Name')
+    """
+    The name of the formation on which the integrity test has been run.
+    """
+
+
+class FormationEvaluationCoring(BaseModel):
+    """
+    A rock sample obtained by drilling into the earth with a pipe conveyed hollow bit and core barrel
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FormationName: str | None = Field(None, title='Formation Name')
+    """
+    The name of the formation from which the core was extracted
+    """
+    CoreNumber: str | None = Field(None, title='Core Number')
+    """
+    An identifier, assigned by the well operator, that uniquely identifies the sample.
+    """
+    MeasuredDepthTop: float | None = Field(None, title='Measured Depth Top')
+    """
+    The start depth of the interval to which the coring activity refers. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    Length: float | None = Field(None, title='Length')
+    """
+    A measurement that represents the length of the core that was recovered from the core acquisition activity.
+    """
+    CoreDiameter: float | None = Field(None, title='Core Diameter')
+    """
+    A measurement that represents the diameter of the recovered core.
+    """
+    Comments: str | None = Field(None, title='Comments')
+    """
+    A description of the core
+    """
+    MeasuredDepthBase: float | None = Field(None, title='Measured Depth Base')
+    """
+    The base depth of the interval to which the coring activity refers. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+
+
+class ReservoirEvaluation(BaseModel):
+    """
+    A test performed on a drillstem
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FormationName: str | None = Field(None, title='Formation Name')
+    """
+    The name of the formation in which the test was performed.
+    """
+    MinimumDepthTestStart: float | None = Field(None, title='Minimum Depth Test Start')
+    """
+    The minimum start depth for the drillstem test. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    MaximumDepthTestStart: float | None = Field(None, title='Maximum Depth Test Start')
+    """
+    The maximum start depth for the drillstem test. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    Comments: str | None = Field(None, title='Comments')
+    """
+    Comments made regarding the Drillstem Test
+    """
+    Sequence: float | None = Field(None, title='Sequence')
+    """
+    Sequential number of the DST
+    """
+    HoleType: str | None = Field(None, title='Hole Type')
+    """
+    Free text describing the type of the hole the DST is running through (such as "Cased", "OpenHole",…)
+    """
+    PackerDepth: float | None = Field(None, title='Packer Depth')
+    """
+    Depth of the Packer while running the DST
+    """
+    PerforationNumber: float | None = Field(None, title='Perforation Number')
+    """
+    Sequential number of the perforation that the DST is running through
+    """
+    DepthPerforationTop: float | None = Field(None, title='Depth Perforation Top')
+    """
+    Perforation Top Depth for the DST to run through. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    HoleSectionID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-HoleSection:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Hole Section ID')
+    """
+    Description of the Hole Section in which the evaluation will be performed
+    """
+    DepthPerforationBase: float | None = Field(None, title='Depth Perforation Base')
+    """
+    Perforation Base Depth for the DST to run through. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    TestTimeDuration: float | None = Field(None, title='Test Time Duration')
+    """
+    Planned test duration
+    """
+    TestIntervalLength: float | None = Field(None, title='Test Interval Length')
+    """
+    Planned test length
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractProject):
+    """
+    `data` payload for EvaluationPlan 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FormationIntegrityEvaluations: list[FormationIntegrityEvaluation] | None = Field(
+        None, title='Formation Integrity Evaluation'
+    )
+    """
+    A collection of integrity evaluations made on a formation
+    """
+    FormationEvaluationCorings: list[FormationEvaluationCoring] | None = Field(
+        None, title='Formation Evaluation Corings'
+    )
+    """
+    Information regarding any evaluation made on the formation by analyzing cores
+    """
+    ReservoirEvaluations: list[ReservoirEvaluation] | None = Field(
+        None, title='Reservoir Evaluation'
+    )
+    """
+    Information regarding the evaluation of the reservoir
+    """
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore ID')
+    """
+    Identifier of the planned Wellbore
+    """
+    ExtensionProperties: dict[str, Any] | None = None