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

osdu_models/masterdata/tubular_component/v2_4_0.py

@@ -0,0 +1,587 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/tubular_component/v2_4_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_tubular_component_connection import v1_0_0
+from ...abstract.abstract_tubular_component_bend import v1_0_0 as v1_0_0_1
+from ...abstract.abstract_tubular_component_bit_record import v1_1_0
+from ...abstract.abstract_tubular_component_hole_opener import v1_0_0 as v1_0_0_2
+from ...abstract.abstract_tubular_component_jar import v1_0_0 as v1_0_0_3
+from ...abstract.abstract_tubular_component_motor import v1_0_0 as v1_0_0_4
+from ...abstract.abstract_tubular_component_pressure_loss import v1_0_0 as v1_0_0_5
+from ...abstract.abstract_tubular_component_rss import v1_0_0 as v1_0_0_6
+from ...abstract.abstract_tubular_component_stabiliser import v1_0_0 as v1_0_0_7
+from ...abstract.abstract_common_resources.v1_0_1 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+
+
+class Nozzle(BaseModel):
+    """
+    number and size of nozzles / jets in a Tubular Component
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    NozzleID: str = Field(..., examples=[1], title='Nozzle Identifier')
+    """
+    Unique identifier for this instance of Nozzle
+    """
+    DiameterInside: float = Field(..., examples=['12 1/32 in'], title='Diameter Inside')
+    """
+    Inside Diameter of the nozzle
+    """
+    Length: float = Field(..., examples=['1.25 in'], title='Length')
+    """
+    Total length of the nozzle
+    """
+    NozzleTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentNozzleType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['namespace:reference-data--TubularComponentNozzleType:Normal:'],
+        title='Nozzle Type Identifier',
+    )
+    """
+    Describes the Nozzle Type (such as extended; normal; blank)
+    """
+    Orientation: float = Field(..., examples=['0 dega'], title='Orientation')
+    """
+    Nozzle Orientation
+    """
+    NozzleCount: int = Field(..., examples=[3], title='Nozzle Count')
+    """
+    Number of Nozzles installed in component
+    """
+
+
+class Sensor(BaseModel):
+    """
+    Tubular Sensor Component Schema
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SensorTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentSensorType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['namespace:reference-data--TubularComponentSensorType:GR:'],
+        title='Sensor Type ID',
+    )
+    """
+    Unique identifier for this Instance of Sensor log
+    """
+    ToolClassIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-WellLogToolClass:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(
+        None,
+        examples=[['namespace:reference-data--WellLogToolClass:GammaRay.Array:']],
+        title='Tool Class Identifiers',
+    )
+    """
+    An array of well log generic tool types used in this Log Run.
+    """
+    ToolCodeIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-WellLogToolCode:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(
+        None,
+        examples=[['namespace:reference-data--WellLogToolCode:BakerHughesInteq:GR:']],
+        title='Tool Code Identifiers',
+    )
+    """
+    An array of PWLS tool mnemonics used in this Log Run.
+    """
+    SensorMeasurementType: str | None = Field(
+        None, examples=['GammaRay'], title='Sensor Measurement Type'
+    )
+    """
+    Specifies the type of sensor in a tubular string.
+    """
+    OffsetBottom: float | None = Field(
+        None, examples=['13.5 in'], title='Offset Bottom'
+    )
+    """
+    Sensor offset from the bottom of the component
+    """
+    Comments: str | None = Field(None, examples=['BHI GR'], title='Comments')
+    """
+    Additional comments and remarks
+    """
+    MeasurementOffset: str | None = Field(
+        None, examples=['11.5 in'], title='Measurement Offset'
+    )
+    """
+    Effective offset of measurement of sensor
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for TubularComponent 2.4.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str | None = Field(
+        None, examples=['7" N-80 26# TC-4S Casing Joints'], title='Name'
+    )
+    """
+    The name of this tubular component.
+    """
+    ParentWellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--Wellbore:11000091175501:'],
+        title='Parent Wellbore Identifier',
+    )
+    """
+    Identifier of the wellbore the Component is installed/run into.
+    """
+    ParentAssemblyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-TubularAssembly:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--TubularAssembly:11000091175501.7ProdLnr:'],
+        title='Parent Assembly Identifier',
+    )
+    """
+    Identifier of the Assembly the component is part of.
+    """
+    TubularComponentSequence: int | None = Field(
+        None, examples=[25], title='Sequence Number'
+    )
+    """
+    The sequence within which the components entered the hole. That is, a sequence number of 1 entered first, 2 entered 2nd, etc.
+    """
+    TubularComponentNominalSize: float | None = Field(
+        None, examples=['7 in'], title='Nominal Size'
+    )
+    """
+    Nominal size (outer diameter 'OD') of the component, e.g. 9.625", 12.25"
+    """
+    TubularComponentNominalSizeDescription: str | None = Field(
+        None, examples=['7"'], title='Nominal Size Description'
+    )
+    """
+    Nominal size description e.g. 8-1/2" x 9-5/8"
+    """
+    TubularComponentNominalWeight: float | None = Field(
+        None, examples=['26 lbf'], title='Nominal Weight'
+    )
+    """
+    Nominal weight of the component.
+    """
+    TubularComponentLength: float | None = Field(
+        None, examples=['2.5 ft'], title='Length of Component(s)'
+    )
+    """
+    Total Length of the component(s)
+    """
+    MaximumOuterDiameter: float | None = Field(
+        None, examples=['7.125 in'], title='Outer Diameter Maximum'
+    )
+    """
+    This is the maximum hard outer diameter of the component.
+    """
+    DriftDiameter: float | None = Field(
+        None, examples=['6.151 in'], title='Drift Diameter'
+    )
+    """
+    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 = Field(
+        None, examples=['6.276 in'], title='Inner Diameter'
+    )
+    """
+    Nominal inner diameter 'ID' of the component.
+    """
+    ManufacturerID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--Organisation:USSTUBULAR:'],
+        title='Manufacturer Identifier',
+    )
+    """
+    Unique identifier for the manufacturer of this equipment.
+    """
+    SupplierID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--Organisation:USSTUBULAR:'],
+        title='Supplier Identifier',
+    )
+    """
+    Unique identifier for the supplier of this equipment.
+    """
+    Model: str | None = Field(None, examples=['7inPupJt'], title='Model Name')
+    """
+    Name of the component Model as defined per the operating company
+    """
+    SerialNumber: str | None = Field(
+        None, examples=['7inN80Csg'], title='Serial Number'
+    )
+    """
+    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
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularSectionType:CAS:'],
+        title='Pipe Section Type Identifier',
+    )
+    """
+    Identifier of the Section Type.
+    """
+    TubularComponentTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularComponentType:PJ:'],
+        title='Pipe Component Type Identifier',
+    )
+    """
+    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
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--TubularMaterialType:SteelCasingandTubing:'
+        ],
+        title='Material Type Identifier',
+    )
+    """
+    Specifies the material type constituting the component.
+    """
+    TubularComponentTubingGradeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentGrade:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularComponentGrade:N-80Q:'],
+        title='Tubular Grade Identifier',
+    )
+    """
+    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 = Field(
+        None, examples=['80000 psi'], title='Tubular Grade Strength'
+    )
+    """
+    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 = Field(
+        None, examples=['80000 psi'], title='Yield Strength'
+    )
+    """
+    The axial load required to yield the pipe.
+    """
+    PilotHoleSize: float | None = Field(None, title='Pilot Hole Size')
+    """
+    Size/diameter of the Pilot Hole when assembly is a drillstring
+    """
+    TubularComponentBoxPinConfigID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentPinBoxType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularComponentPinBoxType:BoxPin:'],
+        title='Box/Pin Configuration Identifier',
+    )
+    """
+    Box / Pin configuration Identifier
+    """
+    TubularComponentTopConnectionTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentConnectionType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularComponentConnectionType:ABTC-4S:'],
+        title='Top Connection Type Identifier',
+    )
+    """
+    Identifier of the Top Connection Type
+    """
+    TubularComponentBottomConnectionTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentConnectionType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TubularComponentConnectionType:ABTC-4S:'],
+        title='Bottom Connection Type Identifier',
+    )
+    """
+    Identifier of the Bottom Connection Type
+    """
+    TubularComponentTopMD: float | None = Field(
+        None, examples=['46 ft'], title='Component Top Measured Depth'
+    )
+    """
+    The installed measured depth of the top of the specific component
+    """
+    TubularComponentBaseMD: float | None = Field(
+        None, examples=['9055 ft'], title='Component Base Measured Depth'
+    )
+    """
+    The installed measured depth of the base of the specific component
+    """
+    TubularComponentTopReportedTVD: float | None = Field(
+        None, examples=['46 ft'], title='Component Top True Vertical Depth'
+    )
+    """
+    True Vertical Depth of the top of the component measured from the Wellhead
+    """
+    TubularComponentBaseReportedTVD: float | None = Field(
+        None, examples=['8977 ft'], title='Component Base True Vertical Depth'
+    )
+    """
+    True Vertical Depth of the base of the component measured from the Wellhead
+    """
+    PackerSetDepthTVD: float | None = Field(
+        None, title='Packer Set True Vertical Depth'
+    )
+    """
+    The depth the packer equipment was set to seal the casing or tubing.
+    """
+    ShoeDepthTVD: float | None = Field(None, title='Shoe True Vertical Depth')
+    """
+    True vertical depth of the casing/tubing shoe measured from the surface.
+    """
+    NumJoints: int | None = Field(None, examples=[225], title='#Joints')
+    """
+    Number of Joints per pipe section
+    """
+    JointLengthAverage: float | None = Field(
+        None, examples=['30.3 ft'], title='Average Joint Length'
+    )
+    """
+    Average Joint Length
+    """
+    TopConnOD: float | None = Field(None, examples=['7.656 in'], title='Top Conn OD')
+    """
+    Top Connection Outer Diameter
+    """
+    TopConnLength: float | None = Field(
+        None, examples=['10 in'], title='Top Conn Length'
+    )
+    """
+    Top Connection Outer Length
+    """
+    BotConnOD: float | None = Field(None, examples=[7.656], title='Bottom Conn OD')
+    """
+    Bottom Connection Outer Diameter
+    """
+    BotConnLength: float | None = Field(None, examples=[10], title='Bottom Conn Length')
+    """
+    Bottom Connection Outer Length
+    """
+    OutsideCouplingLength: float | None = Field(
+        None, examples=['1.2 ft'], title='Outside Coupling Length'
+    )
+    """
+    Outside Coupling Length
+    """
+    IsThreadLockUsed: bool | None = Field(
+        None, examples=[True], title='Is Thread Lock Used'
+    )
+    """
+    Is thread lock used when making up the pipe?
+    """
+    LinearCapacity: float | None = Field(
+        None, examples=['0.0302 bbl/ft'], title='Linear Capacity'
+    )
+    """
+    Linear Capacity volume/length inside component
+    """
+    ClosedEndDisplacement: float | None = Field(
+        None, examples=['0.038 bbl/ft'], title='Closed End Displacement'
+    )
+    """
+    Closed End Displacement volume/length
+    """
+    MakeUpTorqueMin: float | None = Field(
+        None, examples=['3890 ft.lbf'], title='Make Up Torque Minimum'
+    )
+    """
+    Minimum Make Up Torque
+    """
+    MakeUpTorqueOpt: float | None = Field(
+        None, examples=['5190 ft.lbf'], title='Make Up Torque Optimum'
+    )
+    """
+    Optimum Make Up Torque
+    """
+    MakeUpTorqueMax: float | None = Field(
+        None, examples=['6490 ft.lbf'], title='Make Up Torque Maximum'
+    )
+    """
+    Maximum Make Up Torque
+    """
+    MakeUpTorqueAct: float | None = Field(
+        None, examples=['5200 ft.lbf'], title='Make Up Torque Actual'
+    )
+    """
+    Actual Make Up Torque
+    """
+    YoungsModulus: float | None = Field(
+        None, examples=['30000000 psi'], title='Youngs Modulus'
+    )
+    """
+    Youngs Modulus of Elasticity
+    """
+    PoissonsRatio: float | None = Field(None, examples=[0.3], title='Poissons Ratio')
+    """
+    Poissons Ratio
+    """
+    Density: float | None = Field(None, examples=['490 lb/ft3'], title='Density')
+    """
+    Density
+    """
+    BurstPressure: float | None = Field(
+        None, examples=['7240 psi'], title='Burst Pressure'
+    )
+    """
+    Burst Pressure
+    """
+    CollapsePressure: float | None = Field(
+        None, examples=['5410 psi'], title='Collapse Pressure'
+    )
+    """
+    Collapse Pressure
+    """
+    InternalReference: str | None = Field(
+        None, examples=['JT #s 2-226'], title='Internal Reference'
+    )
+    """
+    Internal Reference name/description
+    """
+    AxialLoadCapacity: float | None = Field(
+        None, examples=['603929 lbf'], title='Axial Load Capacity'
+    )
+    """
+    Axial Load Capacity of component
+    """
+    IsRadioActive: bool | None = Field(None, examples=[False], title='Is Radioactive')
+    """
+    Is Radioactive
+    """
+    PartNumber: str | None = Field(None, examples=['USST-12345'], title='Part Number')
+    """
+    Vendor part number
+    """
+    VendorNumber: str | None = Field(
+        None, examples=['USST-ABCDEFG'], title='Vendor Number'
+    )
+    """
+    Vendor number or other reference identifier
+    """
+    Nozzles: list[Nozzle] | None = Field(None, title='Nozzles')
+    """
+    Description of the Size (ID) of the Nozzle (Jet) used in the Tubular Component
+    """
+    Sensors: list[Sensor] | None = Field(None, title='Sensors')
+    """
+    Description of the type of Sensor(s) for the Tubular Components e.g. for MWD/LWD tools
+    """
+    Connections: list[v1_0_0.AbstractTubularComponentConnection] | None = Field(
+        None, title='Connections'
+    )
+    """
+    Top and/or Bottom Connection information
+    """
+    TotalFlowArea: float | None = Field(
+        None, examples=['0.3313 in2'], title='Total Flow Area'
+    )
+    """
+    TFA of all Nozzles
+    """
+    Bend: v1_0_0_1.AbstractTubularComponentBend | None = Field(None, title='Bend')
+    """
+    Bend specific information
+    """
+    BitRecord: v1_1_0.AbstractTubularComponentBitRecord | None = Field(
+        None, title='Bit Record'
+    )
+    """
+    Bit Record specific information
+    """
+    HoleOpener: v1_0_0_2.AbstractTubularComponentHoleOpener | None = Field(
+        None, title='Hole Opener'
+    )
+    """
+    Hole Opener specific information
+    """
+    Jar: v1_0_0_3.AbstractTubularComponentJar | None = Field(None, title='Jar')
+    """
+    Drilling Jar specific information
+    """
+    Motor: v1_0_0_4.AbstractTubularComponentMotor | None = Field(None, title='Motor')
+    """
+    Mud Motor specific information
+    """
+    MWDTool: v1_0_0_3.AbstractTubularComponentJar | None = Field(None, title='MWD Tool')
+    """
+    MWD Tool specific information
+    """
+    PressureLoss: v1_0_0_5.AbstractTubularComponentPressureLoss | None = Field(
+        None, title='Pressure Loss'
+    )
+    """
+    Pressure v flow rate curve data for Hydraulics Pressure Loss calculations
+    """
+    RotarySteerableSystem: v1_0_0_6.AbstractTubularComponentRss | None = Field(
+        None, title='Rotary Steerable System'
+    )
+    """
+    Rotary Steerable System (RSS) tool specific information
+    """
+    Stabiliser: v1_0_0_7.AbstractTubularComponentStabiliser | None = Field(
+        None, title='Stabiliser'
+    )
+    """
+    Stabiliser specific information
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/tubular_external_component/__init__.py

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