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

osdu_models/masterdata/perforation_job/v1_1_0.py

@@ -0,0 +1,259 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/perforation_job/v1_1_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 PerforationJob 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore')
+    """
+    Business natural key or code of the parent Wellbore to which this record belongs
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='Depth Reference Elevation'
+    )
+    """
+    ID to the Zero Depth Point elevation for depths contained in the perf job incl intervals, depth correction used to correlate MDs to original drilling rig MD. References an entry in the Vertical Measurement array for the Well parented by the wellbore via WellboreID.
+    """
+    WellboreTubularID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-TubularAssembly:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Perforated Tubular Assembly')
+    """
+    Casing/Liner/Tubing assembly through which guns are fired.
+    """
+    ContractorID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--Organisation:Halliburton:'],
+        title='Contractor',
+    )
+    """
+    Name of company performing the perf job
+    """
+    ContractorSupervisor: str | None = Field(
+        None, examples=['Joe Bloggs'], title='Contractor Supervisor'
+    )
+    """
+    Name of contractor supervisor overseeing the job
+    """
+    MethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationIntervalType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Perforation Method')
+    """
+    Perforation job method, often the brand name of the service offered by the contractor
+    """
+    ConveyedMethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationConveyedMethod:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--PerforationConveyedMethod:ElecLine:'],
+        title='Conveyed Method',
+    )
+    """
+    How guns are conveyed
+    """
+    IsTractorUsed: bool | None = Field(None, title='Tractor Used')
+    """
+    Is a tractor used during the job to help convey guns
+    """
+    JobStartDateTime: str | None = Field(
+        None, examples=['2022-04-18'], title='Job Start Date/Time'
+    )
+    """
+    Job Start Date/time
+    """
+    JobEndDateTime: str | None = Field(
+        None, examples=['2022-04-19'], title='Job End Date/Time'
+    )
+    """
+    Job End Date/time
+    """
+    BottomHoleTemperature: float | None = Field(
+        None, examples=[218], title='Bottom Hole Temperature'
+    )
+    """
+    Downhole temperature at mid-point of perforation intervals
+    """
+    SurfacePressureInitial: float | None = Field(
+        None, examples=[14.5], title='Initial Surface Pressure'
+    )
+    """
+    Pressure at Surface at start of Job
+    """
+    ReservoirTVD: float | None = Field(
+        None, examples=[4500], title='Reservoir True Vertical Depth'
+    )
+    """
+    TVD at top of Reservoir/perforated intervals used to calculate pressure using annular fluid density.
+    """
+    ReservoirPressureEstimated: float | None = Field(
+        None, examples=[2300], title='Estimated Reservoir Pressure'
+    )
+    """
+    Estimated Pressure at top of Reservoir/perforated intervals
+    """
+    AnticipatedReservoirPressure: float | None = Field(
+        None, title='Hydrostatic Pressure at Reservoir'
+    )
+    """
+    Hydrostatic pressure at Reservoir / perforated intervals top
+    """
+    AnnulusFluidTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-AnnularFluidType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--AnnularFluidType:Mud:'],
+        title='Annulus Fluid Type',
+    )
+    """
+    Annulus Fluid Type
+    """
+    AnnulusFluidDensity: float | None = Field(
+        None, examples=[9.8], title='Annulus Fluid Density'
+    )
+    """
+    Annulus Fluid Density used to calculate hydrostatic pressure
+    """
+    AnnulusFluidTopTVD: float | None = Field(
+        None, examples=[200], title='Annulus Fluid Top TVD'
+    )
+    """
+    TVD of annulus fluid top used to calculate Hydrostatic pressure prior to first gun run
+    """
+    Underbalanced: bool | None = Field(
+        None, examples=[False], title='Is Underbalanced?'
+    )
+    """
+    Underbalance indicator
+    """
+    HydrostaticReservoirPressureDifference: float | None = Field(
+        None, examples=[200], title='Hydrostatic Reservoir Pressure Difference'
+    )
+    """
+    Difference between Reservoir Pressure and Hydrostatic pressure. Negative number indicates underbalanced
+    """
+    FinalSurfacePressure: float | None = Field(None, title='Final Surface Pressure')
+    """
+    Pressure at Surface at end of Job
+    """
+    SurfacePressureFinalDateTime: str | None = Field(
+        None, title='Final Surface Pressure Date/Time'
+    )
+    """
+    Date/time when final surface pressure measured
+    """
+    AfterPillFluidLossRate: float | None = Field(
+        None, title='Fluid Loss Rate After Pills'
+    )
+    """
+    Post pill fluid loss rate
+    """
+    PostJobFluidLossRate: float | None = Field(
+        None, title='Fluid Loss Rate After Perf Job'
+    )
+    """
+    Post job fluid loss rate
+    """
+    PillVolume: float | None = Field(None, examples=[10], title='Pill Volume')
+    """
+    Pill volume
+    """
+    PillTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationPillType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Pill Type')
+    """
+    Pill type
+    """
+    ReferenceLogDate: str | None = Field(None, title='Reference Log Date')
+    """
+    Date when Reference Log run
+    """
+    ReferenceLogID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reference Log Identifier')
+    """
+    SRN to Wireline log run
+    """
+    ReferenceLogDescription: str | None = Field(None, title='Reference Log Description')
+    """
+    Reference Log description/name
+    """
+    PerfJobMDTop: float | None = Field(None, title='Job Top MD')
+    """
+    Top Measured Depth of all perfed intervals
+    """
+    PerfJobMDBase: float | None = Field(None, title='Job Base MD')
+    """
+    Base Measured Depth of all perfed intervals
+    """
+    PerfGrossIntervalLength: float | None = Field(
+        None, title='Gross Perf Length Interval'
+    )
+    """
+    Gross perforated interval length (Job Top - Job Base)
+    """
+    PerfNetIntervalLength: float | None = Field(None, title='Net Perf Length Interval')
+    """
+    Net perforated interval length (calculated from sum of individual intervals)
+    """
+    NoIntervals: int | None = Field(None, title='Number of Intervals')
+    """
+    Number of intervals (calculated from intervals)
+    """
+    TotalShots: int | None = Field(None, title='Total Shots')
+    """
+    Total number of shots fired (calculated from intervals) - Total Shots = {SP/ (shot/ft) x [Interval length]} + Additional Shot - Misfires
+    """
+    ShotDensityAverage: float | None = Field(None, title='Average Shot Density')
+    """
+    Average shot density (Average Shot Density = Total Shots / Net Perforation Interval)
+    """
+    CentralizationMethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationCentralizationMethodType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Centralization Method')
+    """
+    Centralization Method
+    """
+    Comment: str | None = Field(None, title='Job Comments')
+    """
+    Perforation job comments
+    """
+    Name: str | None = Field(None, title='Name')
+    """
+    The name under which this perforation job is known.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/perforation_job/v1_2_0.py

@@ -0,0 +1,263 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/perforation_job/v1_2_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 PerforationJob 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore')
+    """
+    Business natural key or code of the parent Wellbore to which this record belongs
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='Depth Reference Elevation'
+    )
+    """
+    ID to the Zero Depth Point elevation for depths contained in the perf job incl intervals, depth correction used to correlate MDs to original drilling rig MD. References an entry in the Vertical Measurement array for the Well parented by the wellbore via WellboreID.
+    """
+    WellboreTubularID: constr(
+        pattern=r'^[\w\-\.]+:(master-data\-\-TubularAssembly|work-product-component\-\-TubularAssembly):[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['namespace:master-data--TubularAssembly:9_58ProdCasing:'],
+        title='Perforated Tubular Assembly',
+    )
+    """
+    Casing/Liner/Tubing assembly through which guns are fired.
+    """
+    ContractorID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--Organisation:Halliburton:'],
+        title='Contractor',
+    )
+    """
+    Name of company performing the perf job
+    """
+    ContractorSupervisor: str | None = Field(
+        None, examples=['Joe Bloggs'], title='Contractor Supervisor'
+    )
+    """
+    Name of contractor supervisor overseeing the job
+    """
+    MethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationIntervalType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Perforation Method')
+    """
+    Perforation job method, often the brand name of the service offered by the contractor
+    """
+    ConveyedMethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationConveyedMethod:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--PerforationConveyedMethod:ElecLine:'],
+        title='Conveyed Method',
+    )
+    """
+    How guns are conveyed
+    """
+    IsTractorUsed: bool | None = Field(None, title='Tractor Used')
+    """
+    Is a tractor used during the job to help convey guns
+    """
+    JobStartDateTime: str | None = Field(
+        None, examples=['2022-04-18'], title='Job Start Date/Time'
+    )
+    """
+    Job Start Date/time
+    """
+    JobEndDateTime: str | None = Field(
+        None, examples=['2022-04-19'], title='Job End Date/Time'
+    )
+    """
+    Job End Date/time
+    """
+    BottomHoleTemperature: float | None = Field(
+        None, examples=[218], title='Bottom Hole Temperature'
+    )
+    """
+    Downhole temperature at mid-point of perforation intervals
+    """
+    SurfacePressureInitial: float | None = Field(
+        None, examples=[14.5], title='Initial Surface Pressure'
+    )
+    """
+    Pressure at Surface at start of Job
+    """
+    ReservoirTVD: float | None = Field(
+        None, examples=[4500], title='Reservoir True Vertical Depth'
+    )
+    """
+    TVD at top of Reservoir/perforated intervals used to calculate pressure using annular fluid density.
+    """
+    ReservoirPressureEstimated: float | None = Field(
+        None, examples=[2300], title='Estimated Reservoir Pressure'
+    )
+    """
+    Estimated Pressure at top of Reservoir/perforated intervals
+    """
+    AnticipatedReservoirPressure: float | None = Field(
+        None, title='Hydrostatic Pressure at Reservoir'
+    )
+    """
+    Hydrostatic pressure at Reservoir / perforated intervals top
+    """
+    AnnulusFluidTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-AnnularFluidType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--AnnularFluidType:Mud:'],
+        title='Annulus Fluid Type',
+    )
+    """
+    Annulus Fluid Type
+    """
+    AnnulusFluidDensity: float | None = Field(
+        None, examples=[9.8], title='Annulus Fluid Density'
+    )
+    """
+    Annulus Fluid Density used to calculate hydrostatic pressure
+    """
+    AnnulusFluidTopTVD: float | None = Field(
+        None, examples=[200], title='Annulus Fluid Top TVD'
+    )
+    """
+    TVD of annulus fluid top used to calculate Hydrostatic pressure prior to first gun run
+    """
+    Underbalanced: bool | None = Field(
+        None, examples=[False], title='Is Underbalanced?'
+    )
+    """
+    Underbalance indicator
+    """
+    HydrostaticReservoirPressureDifference: float | None = Field(
+        None, examples=[200], title='Hydrostatic Reservoir Pressure Difference'
+    )
+    """
+    Difference between Reservoir Pressure and Hydrostatic pressure. Negative number indicates underbalanced
+    """
+    FinalSurfacePressure: float | None = Field(None, title='Final Surface Pressure')
+    """
+    Pressure at Surface at end of Job
+    """
+    SurfacePressureFinalDateTime: str | None = Field(
+        None, title='Final Surface Pressure Date/Time'
+    )
+    """
+    Date/time when final surface pressure measured
+    """
+    AfterPillFluidLossRate: float | None = Field(
+        None, title='Fluid Loss Rate After Pills'
+    )
+    """
+    Post pill fluid loss rate
+    """
+    PostJobFluidLossRate: float | None = Field(
+        None, title='Fluid Loss Rate After Perf Job'
+    )
+    """
+    Post job fluid loss rate
+    """
+    PillVolume: float | None = Field(None, examples=[10], title='Pill Volume')
+    """
+    Pill volume
+    """
+    PillTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationPillType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Pill Type')
+    """
+    Pill type
+    """
+    ReferenceLogDate: str | None = Field(None, title='Reference Log Date')
+    """
+    Date when Reference Log run
+    """
+    ReferenceLogID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reference Log Identifier')
+    """
+    SRN to Wireline log run
+    """
+    ReferenceLogDescription: str | None = Field(None, title='Reference Log Description')
+    """
+    Reference Log description/name
+    """
+    PerfJobMDTop: float | None = Field(None, title='Job Top MD')
+    """
+    Top Measured Depth of all perfed intervals
+    """
+    PerfJobMDBase: float | None = Field(None, title='Job Base MD')
+    """
+    Base Measured Depth of all perfed intervals
+    """
+    PerfGrossIntervalLength: float | None = Field(
+        None, title='Gross Perf Length Interval'
+    )
+    """
+    Gross perforated interval length (Job Top - Job Base)
+    """
+    PerfNetIntervalLength: float | None = Field(None, title='Net Perf Length Interval')
+    """
+    Net perforated interval length (calculated from sum of individual intervals)
+    """
+    NoIntervals: int | None = Field(None, title='Number of Intervals')
+    """
+    Number of intervals (calculated from intervals)
+    """
+    TotalShots: int | None = Field(None, title='Total Shots')
+    """
+    Total number of shots fired (calculated from intervals) - Total Shots = {SP/ (shot/ft) x [Interval length]} + Additional Shot - Misfires
+    """
+    ShotDensityAverage: float | None = Field(None, title='Average Shot Density')
+    """
+    Average shot density (Average Shot Density = Total Shots / Net Perforation Interval)
+    """
+    CentralizationMethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationCentralizationMethodType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Centralization Method')
+    """
+    Centralization Method
+    """
+    Comment: str | None = Field(None, title='Job Comments')
+    """
+    Perforation job comments
+    """
+    Name: str | None = Field(None, title='Name')
+    """
+    The name under which this perforation job is known.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/planned_cement_job/__init__.py

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