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

osdu_models/masterdata/tubular_assembly/v2_1_0.py

@@ -0,0 +1,398 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/tubular_assembly/v2_1_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_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+
+
+class TubularAssemblyStatus(BaseModel):
+    """
+    Reflects the current status of the Assembly - as 'installed', 'pulled', 'planned',... - Applicable to tubing/completions as opposed to drillstrings. Historical states are recorded in TubularAssemblyStates.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StatusTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularAssemblyStatusType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularAssemblyStatusType:Installed:'],
+        title='Status Type ID',
+    )
+    """
+    The relationship to the  reference value status type.
+    """
+    Description: str | None = Field(
+        None, examples=['7" RIH to 6450m to isolated Zone A.'], title='Description'
+    )
+    """
+    Used to describe the reason of Activity - such as installed, cut/pull, pulling.
+    """
+    Date: str | None = Field(None, examples=['2022-07-29T10:00:00.000Z'], title='Date')
+    """
+    Date the status has been established.
+    """
+
+
+class TubularAssemblyState(BaseModel):
+    """
+    Reflects the current status of the Assembly - as 'installed', 'pulled', 'planned',... - Applicable to tubing/completions as opposed to drillstrings. Historical states are recorded in TubularAssemblyStates.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StatusTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularAssemblyStatusType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularAssemblyStatusType:Installed:'],
+        title='Status Type ID',
+    )
+    """
+    The relationship to the  reference value status type.
+    """
+    Description: str | None = Field(
+        None, examples=['7" RIH to 6450m to isolated Zone A.'], title='Description'
+    )
+    """
+    Used to describe the reason of Activity - such as installed, cut/pull, pulling.
+    """
+    Date: str | None = Field(None, examples=['2022-07-29T10:00:00.000Z'], title='Date')
+    """
+    Date the status has been established.
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for TubularAssembly 2.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str | None = Field(None, examples=['7" Production Casing'], title='Name')
+    """
+    The name of the Tubular Assembly.
+    """
+    ParentWellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--Wellbore:11000091175501:'],
+        title='Parent Wellbore ID',
+    )
+    """
+    Identifier of the Wellbore the Assembly is installed into or run in. Note: it may not be same wellbore that current assembly is installed into.
+    """
+    ParentAssemblyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-TubularAssembly:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--TubularAssembly:11000091175501.9_58Int:'],
+        title='Parent Assembly ID',
+    )
+    """
+    Optional - Identifier of the parent assembly (in case of side-track, multi-nesting,…) - The Concentric Tubular model is used to identify the Assembly that an Assembly sits inside e.g. Surface Casing set inside Conductor, Tubing set inside Production Casing, a Bumper Spring set inside a Production Tubing Profile Nipple, Liner set inside Casing, etc. This is needed to enable a Digital Well Sketch application to understand relationships between Assemblies including those in parent Wellbores.
+    """
+    TubularAssemblyStatus_1: TubularAssemblyStatus | None = Field(
+        None, alias='TubularAssemblyStatus', title='TubularAssemblyStatus'
+    )
+    """
+    Reflects the current status of the Assembly - as 'installed', 'pulled', 'planned',... - Applicable to tubing/completions as opposed to drillstrings. Historical states are recorded in TubularAssemblyStates.
+    """
+    TubularAssemblyStates: list[TubularAssemblyState] | None = Field(
+        None, title='Tubular Assembly States'
+    )
+    """
+    The full record of historical and current states of the Assembly. The current active state is recorded in TubularAssemblyStatus.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='Vertical Measurement'
+    )
+    """
+    Either a self-contained vertical reference for the depths in this TubularAssembly or a reference (VerticalReferenceID) to an element in data.VerticalMeasurements[] in the entity defined by VerticalReferenceEntityID e.g. the parent Well.
+    """
+    SuspensionPointMD: float | None = Field(
+        None, examples=['4950 m'], title='Suspension Point MD'
+    )
+    """
+    The Measured Depth that the assembly is suspended from. This  'point' is typically the Measured Depth of the top of the assembly e.g. Hanger though with PBRs the Suspension Point may not be the top.
+    """
+    TubularAssemblyNumber: int | None = Field(
+        None, examples=[3], title='Tubular Assembly Number'
+    )
+    """
+    Sequence of the TubularAssembly (Typically BHA sequence or simply BHA #)
+    """
+    TubularAssemblyTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularAssemblyType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularAssemblyType:ProductionCasing:'],
+        title='Tubular Assembly Type ID',
+    )
+    """
+    Type of tubular assembly.
+    """
+    StringClassID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-StringClass:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--StringClass:Production:'],
+        title='String Class ID',
+    )
+    """
+    Descriptor for Assembly, e.g. Production, Surface, Conductor, Intermediate, Drilling
+    """
+    ActivityTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularAssemblyActivityType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularAssemblyActivityType:RunTubular:'],
+        title='Activity Type ID',
+    )
+    """
+    Used to describe if it belongs to a RunActivity or to a PullActivity
+    """
+    ActivityTypeReasonDescription: str | None = Field(
+        None,
+        examples=['Isolate 8-1/2" Hole Section'],
+        title='Activity Type Reason Description',
+    )
+    """
+    Used to describe the reason of Activity - such as cut/pull, pulling,…
+    """
+    ArtificialLiftTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ArtificialLiftType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Artificial Lift Type ID')
+    """
+    Type of Artificial Lift supported by the TubularAssembly where applicable E.g. could be "Surface Pump" / "Submersible Pump" / "Gas Lift", etc
+    """
+    LinerTypeID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-LinerType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--LinerType:Standard:'],
+        title='Liner Type ID',
+    )
+    """
+    This reference table describes the type of liner used in the borehole where applicable. For example, slotted, gravel packed or pre-perforated etc.
+    """
+    IsMixedString: bool | None = Field(None, examples=[True], title='Is Mixed String')
+    """
+    True if the assembly is a mixed string, else false. True where the Tubular Assembly is made up of joints with different Diameters, Weights, Grades, Connection, Tensile Strengths, Collapse Resistance or  Yield Strengths.
+    """
+    IsInstalled: bool | None = Field(None, examples=[True], title='Is Installed')
+    """
+    Indicates if the Tubular Assembly is currently downhole.
+    """
+    TubularDirectionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularDirection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularDirection:TopToBottom:'],
+        title='Tubular Direction ID',
+    )
+    """
+    Defines whether the sequence of child tubular components runs either top to bottom, or bottom to top.
+    """
+    TubularAssemblyNominalSize: float | None = Field(
+        None, examples=['7 in'], title='Tubular Assembly Nominal Size'
+    )
+    """
+    Nominal size (diameter) describing the whole assembly, e.g. 9.625", 12.25
+    """
+    TubularAssemblyTotalLength: float | None = Field(
+        None, examples=['9000 ft'], title='Tubular Assembly Total Length'
+    )
+    """
+    Total Length of the whole assembly.
+    """
+    DriftDiameter: float | None = Field(
+        None, examples=['6.2 in'], title='DriftDiameter'
+    )
+    """
+    The drift diameter is the inside diameter (ID) that the pipe manufacturer guarantees per specifications. The drift diameter is used by the well planner to determine what size tools or casing strings can later be run through the casing, whereas the nominal inside diameter is used for fluid volume calculations such as mud circulating times and cement slurry placement calculations. Note that the nominal inside diameter is not the same as the drift diameter but is always slightly larger.
+    """
+    MinimumInnerDiameter: float | None = Field(
+        None, examples=['6.125 in'], title='Minimum Inner Diameter'
+    )
+    """
+    This is the minimum inner diameter of the whole Tubular Assembly.
+    """
+    PilotHoleSize: float | None = Field(None, title='Pilot Hole Size')
+    """
+    Diameter of the Pilot Hole (drillstrings)
+    """
+    SeaFloorPenetrationLength: float | None = Field(
+        None, title='Sea Floor Penetration Length'
+    )
+    """
+    The distance that the Tubular Assembly has penetrated below the surface of the sea floor.
+    """
+    AssemblyTopMD: float | None = Field(
+        None, examples=['46 ft'], title='Assembly Top MD'
+    )
+    """
+    The measured depth at the top of the Tubular Assembly
+    """
+    AssemblyBaseMD: float | None = Field(
+        None, examples=['9089 ft'], title='Assembly Base MD'
+    )
+    """
+    The measured depth at the base (bottom) of the Tubular Assembly
+    """
+    AssemblyTopReportedTVD: float | None = Field(
+        None, examples=['46 ft'], title='Assembly Top Reported TVD'
+    )
+    """
+    True Vertical Depth of the top of the Assembly
+    """
+    AssemblyBaseReportedTVD: float | None = Field(
+        None, examples=['8899 ft'], title='Assembly Base Reported TVD'
+    )
+    """
+    True Vertical Depth of the base of the Assembly
+    """
+    CirculatedHours: float | None = Field(
+        None, examples=['3 hr'], title='CirculatedHours'
+    )
+    """
+    Hours Circulated before running Assembly
+    """
+    ContractorID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Contractor')
+    """
+    Tubular Running Contractor
+    """
+    FluidBehindDensity: float | None = Field(
+        None, examples=['9.9 lb/[US] gal'], title='Fluid Behind Density'
+    )
+    """
+    Density of Fluid Behind Assembly
+    """
+    FluidBehindTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellFluidType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--WellFluidType:WBM%20-%20PAD%20Mud:'],
+        title='Fluid Behind Type',
+    )
+    """
+    Type of fluid behind (outside) assembly
+    """
+    FluidLostVolume: float | None = Field(
+        None, examples=['10 bbl'], title='Fluid Lost Volume'
+    )
+    """
+    Fluid Lost Volume when running assembly in hole
+    """
+    InSlipsWeight: float | None = Field(None, title='Weight in Slips')
+    """
+    Weight of Assembly in Slips
+    """
+    IsFluidLost: bool | None = Field(None, examples=[True], title='Fluid Lost')
+    """
+    Is Fluid Lost
+    """
+    IsParallel: bool | None = Field(None, examples=[False], title='Parallel')
+    """
+    Is Parallel/Dual Assembly
+    """
+    HoleAngleMax: float | None = Field(
+        None, examples=['15 deg'], title='Max Hole Angle'
+    )
+    """
+    Maximum Hole Angle
+    """
+    InHoleDate: str | None = Field(
+        None, examples=['2023-12-12T03:00:00+0000'], title='Date In Hole'
+    )
+    """
+    Date/time Assembly started to be run in hole
+    """
+    LandedDate: str | None = Field(
+        None, examples=['2023-12-13T01:00:00+0000'], title='Date Landed'
+    )
+    """
+    Date/time assembly was set/landed
+    """
+    LandedDepthAdjustment: float | None = Field(
+        None, examples=['0 ft'], title='Landed Depth Adjustment'
+    )
+    """
+    Depth Adjustment for use in Landed Depth calculation. Set MD = Top MD + Assembly Length + Depth Adjustment. Note that Depth Adjustment can be positive or negative length.
+    """
+    LandedWeight: float | None = Field(
+        None, examples=['455 klbf'], title='Landed Weight'
+    )
+    """
+    Weight of Assembly when Landed
+    """
+    TaggedMD: float | None = Field(None, title='Tagged Measured Depth')
+    """
+    Tagged Measured Depth comparison to estimated Landed Depth
+    """
+    OpenHoleDiameter: float | None = Field(
+        None, examples=['8.5 in'], title='Open Hole Diameter'
+    )
+    """
+    Open Hole Size/Diameter behind Assembly
+    """
+    EstimatedWeightBelowJar: float | None = Field(
+        None, examples=['113000 lbf'], title='Estimated Weight Below Jar'
+    )
+    """
+    Estimated Weight Below Jar
+    """
+    MaximumOuterDiameter: float | None = Field(
+        None, examples=['7.3 in'], title='Maximum Outer Diameter'
+    )
+    """
+    Maximum Outer Diameter
+    """
+    MaximumOuterDiameterMD: float | None = Field(
+        None, examples=['8055 ft'], title='Maximum OD Measured Depth'
+    )
+    """
+    Maximum Outer Diameter Measured Depth
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/tubular_component/__init__.py

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

osdu_models/masterdata/tubular_component/v2_0_0.py

@@ -0,0 +1,188 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/tubular_component/v2_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, constr
+from typing import Any
+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 TubularComponent 2.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str | None = None
+    """
+    The name of this tubular component.
+    """
+    ParentWellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    Identifier of the wellbore the Component is standing in.
+    """
+    ParentAssemblyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-TubularAssembly:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Identifier of the Assembly the component is taking part on.
+    """
+    TubularComponentSequence: int | None = None
+    """
+    The sequence within which the components entered the hole. That is, a sequence number of 1 entered first, 2 entered next, etc.
+    """
+    TubularComponentNominalSize: float | None = None
+    """
+    Nominal size (diameter) of the component, e.g. 9.625", 12.25
+    """
+    TubularComponentNominalWeight: float | None = None
+    """
+    Nominal weight of the component.
+    """
+    TubularComponentLength: float | None = None
+    """
+    Total Length of the component
+    """
+    MaximumOuterDiameter: float | None = None
+    """
+    This is the maximum outer diameter of the component.
+    """
+    DriftDiameter: float | None = None
+    """
+    The drift diameter is the inside diameter (ID) that the pipe manufacturer guarantees per specifications. Note that the nominal inside diameter is not the same as the drift diameter but is always slightly larger. The drift diameter is used by the well planner to determine what size tools or casing strings can later be run through the casing, whereas the nominal inside diameter is used for fluid volume calculations such as mud circulating times and cement slurry placement calculations.
+    """
+    InnerDiameter: float | None = None
+    """
+    Nominal inner diameter of the component.
+    """
+    ManufacturerID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    Unique identifier for the manufacturer of this equipment.
+    """
+    SupplierID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    Unique identifier for the supplier of this equipment.
+    """
+    Model: str | None = None
+    """
+    Name of the component Model as defined per the operating company
+    """
+    SerialNumber: str | None = None
+    """
+    Serial Number of the component as provided by the manufacturer and/or the supplier
+    """
+    SectionTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularSectionType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Identifier of the Section Type.
+    """
+    TubularComponentTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Specifies the types of components that can be used in a tubular string. These are used to specify the type of component and multiple components are used to define a tubular string (Tubular).
+    """
+    TubularComponentMaterialTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularMaterialType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Specifies the material type constituting the component.
+    """
+    TubularComponentTubingGradeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentGrade:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Id of tubing grade - eg. the tensile strength of the tubing material. A system of classifying the material specifications for steel alloys used in the manufacture of tubing.
+    """
+    TubularComponentTubingGradeStrength: float | None = None
+    """
+    The tensile strength of the tubing material. A system of classifying the material specifications for steel alloys used in the manufacture of tubing.
+    """
+    TubularComponentTubingStrength: float | None = None
+    """
+    The axial load required to yield the pipe.
+    """
+    PilotHoleSize: float | None = None
+    """
+    Size of the Pilot Hole
+    """
+    TubularComponentBoxPinConfigID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentPinBoxType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    ID of Reference Object for type of collar used to couple the tubular with another tubing string.
+    """
+    TubularComponentTopConnectionTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentConnectionType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Id of the Top Connection Type
+    """
+    TubularComponentBottomConnectionTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentConnectionType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Id of the Bottom Connection Type
+    """
+    TubularComponentTopMD: float | None = None
+    """
+    The measured depth of the top from the specific component
+    """
+    TubularComponentBaseMD: float | None = None
+    """
+    The measured depth of the base from the specific component
+    """
+    TubularComponentTopReportedTVD: float | None = None
+    """
+    Depth of the top of the component measured from the Well-Head
+    """
+    TubularComponentBaseReportedTVD: float | None = None
+    """
+    Depth of the base of the component measured from the Well-Head
+    """
+    PackerSetDepthTVD: float | None = None
+    """
+    The depth the packer equipment was set to seal the casing or tubing.
+    """
+    ShoeDepthTVD: float | None = None
+    """
+    Depth of the tubing shoe measured from the surface.
+    """
+    ExtensionProperties: dict[str, Any] | None = None