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

osdu_models/masterdata/perforation_interval/v1_2_0.py

@@ -0,0 +1,444 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/perforation_interval/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 PerforationInterval 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ..., examples=['osdu:master-data--Wellbore:11000091148902:'], title='Wellbore'
+    )
+    """
+    Business natural key or code of the parent Wellbore to which this record belongs
+    """
+    PerforationJobID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-PerforationJob:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['osdu:master-data--PerforationJob:11000091148902.lhq5d:'],
+        title='Perforation Job ID',
+    )
+    """
+    SRN to Job performed to construct the Perf Intervals
+    """
+    SequenceNumber: int = Field(..., examples=[1], title='Sequence Number')
+    """
+    Sequence Number (guns fired sequence)
+    """
+    ClusterRefNo: float | None = Field(None, examples=[1], title='Cluster Reference #')
+    """
+    Cluster reference number
+    """
+    IntervalDateTime: str = Field(
+        ...,
+        examples=['2024-03-03T00:00:00.00Z'],
+        title='Perforation Interval Date/Time',
+    )
+    """
+    Perforation interval date/time
+    """
+    IntervalTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-PerforationIntervalType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['osdu:reference-data--PerforationIntervalType:JetPerforate:'],
+        title='Perforation Interval Type',
+    )
+    """
+    Perforated interval type
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None,
+        examples=[
+            {
+                'VerticalReferenceEntityID': 'osdu:master-data--Well:110000911489:',
+                'VerticalReferenceID': '5iePi',
+            }
+        ],
+        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.
+    """
+    IntervalTopMD: float = Field(
+        ..., examples=['18938 ft'], title='Perforation Interval Top MD'
+    )
+    """
+    MD at top of perfed interval
+    """
+    IntervalBaseMD: float | None = Field(
+        None, examples=['19050 ft'], title='Perforation Interval Base MD'
+    )
+    """
+    MD at base of perfed interval
+    """
+    IntervalLength: float | None = Field(
+        None, examples=['112 ft'], title='Interval Length'
+    )
+    """
+    Distance between MD top and base of interval (net distance) aka 'Top Shot to Bottom Shot' Interval.
+    """
+    WirelineDiameterTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationIntervalWLSize:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['osdu:reference-data--PerforationIntervalWLSize:0.082-in:'],
+        title='Wireline Diameter',
+    )
+    """
+    Wireline diameter
+    """
+    IntervalReasonTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationIntervalReason:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['osdu:reference-data--PerforationIntervalReason:Production:'],
+        title='Reason',
+    )
+    """
+    Interval Reason
+    """
+    GunDiameter: float | None = Field(None, examples=['5 in'], title='Gun Diameter')
+    """
+    Gun diameter
+    """
+    GunCarrierManufacturerID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['osdu:master-data--Organisation:SLB:'],
+        title='Gun Carrier Manufacturer',
+    )
+    """
+    Gun Carrier Manufacturer
+    """
+    GunCarrierTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunCarrierType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['osdu:reference-data--PerforationGunCarrierType:HollowCarrier:'],
+        title='Gun Carrier Type',
+    )
+    """
+    Gun Carrier Type
+    """
+    GunCarrierModelID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunCarrierModel:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'osdu:reference-data--PerforationGunCarrierModel:PowerjetOmega2906-HMX-HSD:'
+        ],
+        title='Gun Carrier Model',
+    )
+    """
+    Gun Carrier Model
+    """
+    GunCarrierCategoryTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunCarrierCategory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['osdu:reference-data--PerforationGunCarrierCategory:Retrievable:'],
+        title='Gun Carrier Category',
+    )
+    """
+    Gun Carrier Category
+    """
+    GunCarrierPhasing: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunPhasingType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['osdu:reference-data--PerforationGunPhasingType:60-deg:'],
+        title='Gun Carrier Phasing',
+    )
+    """
+    Gun Carrier Phasing (angle between perfs). Implemented via a reference list in order to standardize the values.
+    """
+    GunCarrierDescription: str | None = Field(
+        None, examples=['SLB PowerJet 2906 Omega'], title='Gun Carrier Description'
+    )
+    """
+    Gun Carrier Description
+    """
+    GunFiringHeadTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunFiringHeadType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['osdu:reference-data--PerforationGunFiringHeadType:Electronic:'],
+        title='Gun Firing Head Type',
+    )
+    """
+    Gun Firing Head Type
+    """
+    GunMetallurgyTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunMetallurgyType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['osdu:reference-data--PerforationGunMetallurgyType:30CrMo:'],
+        title='Gun Metallurgy Type',
+    )
+    """
+    Metallurgy of the gun
+    """
+    ChargeManufacturerID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['osdu:master-data--Organisation:SLB:'],
+        title='Charge Manufacturer',
+    )
+    """
+    Charge Make/Manufacturer
+    """
+    ChargeTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunChargeType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'osdu:reference-data--PerforationGunChargeType:ResearchDepartmentCompositionX:'
+        ],
+        title='Charge Type',
+    )
+    """
+    Charge Type
+    """
+    ChargeShapeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunChargeShape:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['osdu:reference-data--PerforationGunChargeShape:BigHole:'],
+        title='Charge Shape',
+    )
+    """
+    Charge Shape
+    """
+    ChargeSize: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunChargeSize:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['osdu:reference-data--PerforationGunChargeSize:28-gm:'],
+        title='Charge Size',
+    )
+    """
+    Charge Size
+    """
+    ChargeDescription: str | None = Field(
+        None,
+        examples=['Power Jet Omega 2906 RDX 28.0g with 0.35" entrance hole.'],
+        title='Charge Description',
+    )
+    """
+    Charge Description
+    """
+    GunSwellDiameter: float | None = Field(
+        None, examples=['0.1 in'], title='Gun Swell Diameter'
+    )
+    """
+    Gun Swell Diameter
+    """
+    ShotDensity: float | None = Field(None, examples=[18], title='Shot Density')
+    """
+    Gun Shot Density (shots per foot)
+    """
+    EntranceHoleDiameter: float | None = Field(
+        None, examples=['0.35 in'], title='Perforation Entrance Hole Diameter'
+    )
+    """
+    Perforation Entrance Hole Diameter
+    """
+    PenetrationDepth: float | None = Field(
+        None, examples=['7.5 ft'], title='Perforation Penetration Depth'
+    )
+    """
+    Estimated perforation penetration distance
+    """
+    IsAdditionalShot: bool | None = Field(
+        None, examples=[False], title='Additional Shot'
+    )
+    """
+    Additional shot Y/N (+1 to Tot Shots calc)
+    """
+    Misfires: int | None = Field(None, examples=[0], title='Misfires')
+    """
+    Total number of gun / charge misfires
+    """
+    ReservoirTemperature: float | None = Field(
+        None, examples=['168 degC'], title='Reservoir Temperature'
+    )
+    """
+    Reservoir Temperature
+    """
+    CasingCollarLocatorMD: float | None = Field(
+        None, examples=['18750 ft'], title='Casing Collar Locator MD'
+    )
+    """
+    Measured Depth of the Casing Collar Locator used to align perforating guns on depth
+    """
+    CCLTopShotDistance: float | None = Field(
+        None, examples=['188 ft'], title='CCL Top Shot Distance'
+    )
+    """
+    Distance from CCL to Interval Top
+    """
+    FluidBeforeMD: float | None = Field(
+        None, examples=['16500 ft'], title='Fluid Depth Before Shot'
+    )
+    """
+    Static fluid level before perforating
+    """
+    FluidAfterMD: float | None = Field(
+        None, examples=['16000 ft'], title='Fluid Depth After Shot'
+    )
+    """
+    Static fluid level after perforating
+    """
+    GaugeMD: float | None = Field(
+        None, examples=['18678 ft'], title='Gauge Measured Depth'
+    )
+    """
+    Depth of gauge(s) run while perforating.
+    """
+    BHPressureTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BottomHolePressureType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['osdu:reference-data--BottomHolePressureType:Gauge:'],
+        title='BH Pressure Type',
+    )
+    """
+    How was the bottom hole pressure determined?  Measured, estimated, etc.
+    """
+    DuringPerfGaugePressure: float | None = Field(
+        None, examples=['1355 psi'], title='Gauge Pressure During Perforation'
+    )
+    """
+    Pressure during perforation
+    """
+    InitialSurfPressure: float | None = Field(
+        None, examples=['14.5 psi'], title='Initial Surface Pressure'
+    )
+    """
+    Initial surface pressure
+    """
+    FinalSurfPressure: float | None = Field(
+        None, examples=['245 psi'], title='Final Surface Pressure'
+    )
+    """
+    Final surface pressure
+    """
+    MPPPressure: float | None = Field(
+        None, examples=['14400 psi'], title='MPP Pressure'
+    )
+    """
+    Mid point perf pressure
+    """
+    FluidLossBeforeRate: float | None = Field(
+        None, examples=['0 bbl/min'], title='Fluid Rate Before Shot'
+    )
+    """
+    Fluid loss rate  before perforating
+    """
+    FluidLossAfterRate: float | None = Field(
+        None, examples=['0 bbl/min'], title='Fluid Rate After Shot'
+    )
+    """
+    Fluid lossrate after perforating
+    """
+    FrictionFactor: float | None = Field(None, title='Friction Factor')
+    """
+    Friction Factor
+    """
+    FrictionPressure: float | None = Field(None, title='Friction Pressure')
+    """
+    Friction Pressure
+    """
+    DischargeCoefficient: float | None = Field(
+        None, title='Initial Discharge Coefficient'
+    )
+    """
+    Initial discharge coefficient after perforating but prior to hydraulic fracturing.  A coefficient used in the equation for calculation of pressure drop
+    across a perforation set.
+    """
+    CrushZoneDiameter: float | None = Field(
+        None, examples=['3.5 in'], title='Crush Zone Diameter'
+    )
+    """
+    Crush Zone Diameter
+    """
+    CrushDamageRatio: float | None = Field(None, title='Crush Damage Ratio')
+    """
+    Crush Damage Ratio
+    """
+    TechnicalResult: str | None = Field(None, examples=['OK'], title='Technical Result')
+    """
+    Technical Result
+    """
+    IntervalComments: str | None = Field(
+        None,
+        examples=[
+            'Production 5\\" 18 SPF 28gr RDX Steel Charges Phasing at 60/120\\u00b0'
+        ],
+        title='Interval Comments',
+    )
+    """
+    Interval Comments
+    """
+    Name: str | None = Field(
+        None, examples=['1: 18938ft - 19050ft PERFORATED'], title='Name'
+    )
+    """
+    The name under which this perforation interval is known.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/perforation_job/__init__.py

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

osdu_models/masterdata/perforation_job/v1_0_0.py

@@ -0,0 +1,259 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/perforation_job/v1_0_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_1_0 import AbstractMaster
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for PerforationJob 1.0.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