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

osdu_models/abstract/abstract_tubular_component_bit_record/v1_1_0.py

@@ -0,0 +1,307 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_tubular_component_bit_record/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractTubularComponentBitRecord(BaseModel):
+    """
+    Tubular Component Bit Record specific properties. Based on WITSML Tubular  Component 'BitRecord' ComplexType.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    NumBit: str | None = Field(None, examples=[4.1], title='Identifier')
+    """
+    Bit number and rerun number e.g. "4.1" for the first rerun of bit 4.
+    """
+    DiameterBit: float | None = Field(None, examples=['8.5 in'], title='Bit Diameter')
+    """
+    Diameter of drilled hole.
+    """
+    DiameterPassThrough: float | None = Field(None, title='Pass Through Diameter')
+    """
+    Minimum hole or tubing which bit will pass through (for bi-centre bits).
+    """
+    DiameterPilot: float | None = Field(None, title='Pilot Diameter')
+    """
+    Diameter of pilot bit (for bi-centre bits).
+    """
+    TypeBitID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-BitType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitType:PDC:'],
+        title='Bit Type Identifier',
+    )
+    """
+    Type of bit.
+    """
+    Cost: float | None = Field(None, examples=[12500], title='Cost')
+    """
+    Bit cost in local currency.
+    """
+    MfgCode: str | None = Field(None, examples=['QD506HX'], title='Manufacturer Code')
+    """
+    The manufacturer's code for the bit e.g. model number
+    """
+    IADCCode: str | None = Field(None, examples=[837], title='IADC code')
+    """
+    IADC bit code for PDC/Roller Cone Bits
+    """
+    InitialConditionInnerID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullInnerOuter:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullInnerOuter:1:'],
+        title='Initial Inner Condition Identifier',
+    )
+    """
+    As run bit IADC Dull Grade (I) Condition of Inner tooth rows (inner 2/3 of bit) (0-8).
+    """
+    InitialConditionOuterID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullInnerOuter:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullInnerOuter:0:'],
+        title='Initial Outer Condition Identifier',
+    )
+    """
+    As run bit IADC Dull Grade (O) Condition of Outer tooth rows (outer 1/3 of bit) (0-8).
+    """
+    InitialConditionDullID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullCode:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullCode:WT:'],
+        title='Initial Dull Condition Identifier',
+    )
+    """
+    As run bit IADC Dull Grade (D) Overall dull condition from IADC bit wear 2 character codes.
+    """
+    InitialConditionLocationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullLocationCode:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullLocationCode:A:'],
+        title='Initial Condition Location Identifier',
+    )
+    """
+    As run bit IADC Dull Grade (L) Location Row and cone numbers where wear located (e.g. Cracked Cone, Lost Cone etc).
+    """
+    InitialConditionBearingID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullBearingCode:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullBearingCode:0:'],
+        title='Initial Condition Bearing Identifier',
+    )
+    """
+    As run bit IADC Dull Grade (B) Condition of bit Bearings (integer 0-8 or E, F, N or X)).
+    """
+    InitialConditionGaugeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullGaugeCode:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullGaugeCode:I:'],
+        title='Initial Condition Gauge Identifier',
+    )
+    """
+    As run bit IADC Dull Grade (G) Condition of bit Gauge in 1/16 of an inch. I = in gauge, else number of 16ths out of gauge.
+    """
+    InitialConditionOtherID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullCode:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullCode:O:'],
+        title='Initial Condition Other Identifier',
+    )
+    """
+    As run bit IADC Dull Grade (O) Other comments on bit condition from IADC list (BitDullCode in standard list).
+    """
+    InitialConditionReasonID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitReasonPulledCode:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitReasonPulledCode:TD:'],
+        title='Initial Condition Reason Identifier',
+    )
+    """
+    As run bit IADC Dull Grade (R) Reason bit was pulled
+    """
+    FinalConditionInnerID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullInnerOuter:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullInnerOuter:1:'],
+        title='Final Condition Inner Identifier',
+    )
+    """
+    Pulled bit IADC Dull Grade (I) Condition of Inner tooth rows (inner 2/3 of bit) (0-8).
+    """
+    FinalConditionOuterID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullInnerOuter:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullInnerOuter:0:'],
+        title='Final Condition Outer Identifier',
+    )
+    """
+    Pulled bit IADC Dull Grade (O) Condition of Outer tooth rows (outer 1/3 of bit) (0-8).
+    """
+    FinalConditionDullID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullCode:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullCode:WT:'],
+        title='Final Condition Dull Identifier',
+    )
+    """
+    Pulled bit IADC Dull Grade (D) Overall Dull condition from IADC bit wear 2 character codes.
+    """
+    FinalConditionLocationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullLocationCode:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullLocationCode:A:'],
+        title='Final Condition Location Identifier',
+    )
+    """
+    Pulled bit IADC Dull Grade (L) Location Row and cone numbers where wear located (e.g. Cracked Cone, Lost Cone etc).
+    """
+    FinalConditionBearingID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullBearingCode:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullBearingCode:0:'],
+        title='Final Condition Bearing Identifier',
+    )
+    """
+    Pulled bit IADC Dull Grade (B) Condition of bit Bearings (integer 0-8 or E, F, N or X).
+    """
+    FinalConditionGaugeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullGaugeCode:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullGaugeCode:I:'],
+        title='Final Condition Gauge Identifier',
+    )
+    """
+    Pulled bit IADC Dull Grade (G) Condition of bit Gauge in 1/16 of a inch. I = in gauge, else number of 16ths out of gauge.
+    """
+    FinalConditionOtherID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitDullCode:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitDullCode:O:'],
+        title='Final Condition Other Identifier',
+    )
+    """
+    Pulled bit IADC Dull Grade (O) Other comments on bit condition.
+    """
+    FinalConditionReasonID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitReasonPulledCode:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitReasonPulledCode:TD:'],
+        title='Final Condition Reason Identifier',
+    )
+    """
+    Pulled bit  IADC Dull Grade (R) Reason bit was pulled.
+    """
+    BitDullComments: str | None = Field(
+        None, examples=['1-0-WT-A-0-I-O-TD'], title='Bit Dull Comments'
+    )
+    """
+    Any other Bit Dull comments/description, older T-B-G code or full formatted dull grade e.g.  0-2-WT-N/S-X-I-LN-TD
+    """
+    DriveType: str | None = Field(None, examples=['Motor'], title='Drive Type')
+    """
+    Bit drive type (Motor, rotary table etc).
+    """
+    BitClass: str | None = Field(None, examples=['R'], title='Bit Class')
+    """
+    N = new, U = used.
+    """
+    ReRunBitNumber: str | None = Field(None, examples=[1], title='Re-run Bit Number')
+    """
+    Re-run Bit Number to describe bit number when previously run
+    """
+    HardAbrasiveFormationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BitFormationType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--BitFormationType:Hard:'],
+        title='Hard/Abrasive Formation Identifier',
+    )
+    """
+    Hard/Abrasive Formation
+    """
+    HoursOnBit: float | None = Field(None, examples=[266], title='Hours On Bit')
+    """
+    Cumulative Hours on Bit
+    """
+    Remarks: str | None = Field(
+        None,
+        examples=[
+            'Bit 4.1 pulled at 8-1/2 section TD. Bit was clean at surface graded by tool hand.'
+        ],
+        title='Remarks',
+    )
+    """
+    Remarks
+    """

osdu_models/abstract/abstract_tubular_component_connection/__init__.py

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

osdu_models/abstract/abstract_tubular_component_connection/v1_0_0.py

@@ -0,0 +1,81 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_tubular_component_connection/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractTubularComponentConnection(BaseModel):
+    """
+    Tubular Connection specific properties. Based on WITSML Tubular  Component 'Connection' ComplexType.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    CXNOuterDiameter: float | None = Field(
+        None, examples=['5 in'], title='Connection Outer Diameter'
+    )
+    """
+    Outside diameter (OD) of the body of the connection.
+    """
+    CXNInnerDiameter: float | None = Field(
+        None, examples=['4.276 in'], title='Connection Inner Diameter'
+    )
+    """
+    Inside diameter (ID) of the connection.
+    """
+    OutsideConnectionLength: float | None = Field(
+        None, title='Outside Connection Length'
+    )
+    """
+    External length of the connection.
+    """
+    InsideConnectionLength: float | None = Field(None, title='Inside Connection Length')
+    """
+    Internal length of the connection.
+    """
+    ThreadTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentConnectionType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Thread Type Identifier')
+    """
+    Thread/Connection Type
+    """
+    ThreadSize: float | None = Field(None, title='Thread Size')
+    """
+    Thread size/diameter.
+    """
+    YieldStress: float | None = Field(None, title='Yield Stress')
+    """
+    Tensile yield stress of the connection
+    """
+    YieldTorque: float | None = Field(None, title='Yield Torque')
+    """
+    Torque limit for the connection
+    """
+    PositionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularComponentCXNPosition:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Position Identifier')
+    """
+    Position of connection
+    """
+    CriticalCrossSectionArea: float | None = Field(
+        None, title='Critical Cross Section Area'
+    )
+    """
+    Critical Cross Section Area (for bending stiffness ratio).
+    """
+    LeakPressure: float | None = Field(None, title='Leak Pressure')
+    """
+    Leak Pressure
+    """
+    MakeUpTorque: float | None = Field(None, title='Make Up Torque')
+    """
+    Make Up Torque
+    """

osdu_models/abstract/abstract_tubular_component_hole_opener/__init__.py

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

osdu_models/abstract/abstract_tubular_component_hole_opener/v1_0_0.py

@@ -0,0 +1,54 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_tubular_component_hole_opener/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractTubularComponentHoleOpener(BaseModel):
+    """
+    Hole Opener Component Schema. Describes the hole-opener tool (often called a ‘reamer’) used on the tubular string. Based on the WITSML Tubular 'HoleOpener' ComplexType
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    HoleOpenerTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HoleOpenerType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Hole Opener Type Identifier')
+    """
+    Type of hole opener - Under reamer or fixed blade.
+    """
+    NumCutters: int | None = Field(None, title='Number of Cutters')
+    """
+    Number of cutters on the tool.
+    """
+    HoleOpenerDiameter: float | None = Field(None, title='Hole Opener Diameter')
+    """
+    Diameter of the reamer.
+    """
+    HoleOpenerDiameterMaximum: float | None = Field(
+        None, title='Hole Opener Diameter Maximum'
+    )
+    """
+    Maximum extended size of the hole opener when the arms are extended.
+    """
+    FishneckLength: float | None = Field(None, title='Fishneck Length')
+    """
+    Fishneck length of the hole opener. Dimension supplied by manufacturer. This dimension is used with the retrieval tool in case item is lost in hole.
+    """
+    FlowRatePercent: float | None = Field(None, title='Flow Rate Percent')
+    """
+    Flow rate percent across the tool
+    """
+    TotalFlowArea: float | None = Field(None, title='Total Flow Area')
+    """
+    Total Flow Area across the nozzles (jets)
+    """
+    PluggedPercent: float | None = Field(None, title='Plugged Percent')
+    """
+    % of the Hole Opener Nozzles plugged on retrieval of the tool
+    """

osdu_models/abstract/abstract_tubular_component_jar/__init__.py

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

osdu_models/abstract/abstract_tubular_component_jar/v1_0_0.py

@@ -0,0 +1,55 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_tubular_component_jar/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractTubularComponentJar(BaseModel):
+    """
+    Captures information about drilling jars, which are mechanical or hydraulic devices used in the drill stem to deliver an impact load to another component of the drill stem, especially when that component is stuck.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    UpSetForce: float | None = Field(None, title='Up Set Force')
+    """
+    Specifies the force required to set the springs inside a mechanical jar into a position to trip the jar in an upward direction.
+    """
+    DownSetForce: float | None = Field(None, title='Down Set Force')
+    """
+    Specifies the force required to set the springs inside a mechanical jar into a position to trip the jar in a downward direction.
+    """
+    UpTripForce: float | None = Field(None, title='Up Trip Force')
+    """
+    Specifies the force required to trip the jar upwards.
+    """
+    DownTripForce: float | None = Field(None, title='Down Trip Force')
+    """
+    Specifies the force required to trip the jar downward.
+    """
+    PumpOpenForce: float | None = Field(None, title='Pump Open Force')
+    """
+    Specifies the force present when jarring while circulating, and if pressure is trapped below the bit.
+    """
+    SealFrictionForce: float | None = Field(None, title='Seal Friction Force')
+    """
+    Specifies the force required to move a hydraulic jar from the tripped position to the reset position so it can be tripped again. .
+    """
+    JarTypeID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-JarType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Jar Type ID')
+    """
+    Specifies the type of jar.
+    """
+    JarActionTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-JarActionType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Jar Action Type ID')
+    """
+    Specifies the type of jar action.
+    """

osdu_models/abstract/abstract_tubular_component_motor/__init__.py

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

osdu_models/abstract/abstract_tubular_component_motor/v1_0_0.py

@@ -0,0 +1,97 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_tubular_component_motor/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ..abstract_tubular_component_pressure_loss import v1_0_0
+
+
+class AbstractTubularComponentMotor(BaseModel):
+    """
+    Mud Motor Tubular Component specific properties. Based on WITSML Tubular  Component 'Motor' ComplexType.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ToolOffset: float | None = Field(None, title='Tool Offset')
+    """
+    Tool offset distance from bottom of Tubular Assembly.
+    """
+    PressureLossFactor: float | None = Field(None, title='Pressure Loss Factor')
+    """
+    Pressure drop across the tool.
+    """
+    FlowRateMinimum: float | None = Field(None, title='Flow Rate Minimum')
+    """
+    Minimum flow rate for tool operation.
+    """
+    FlowRateMaximum: float | None = Field(None, title='Flow Rate Maximum')
+    """
+    Maximum flow rate for tool operation.
+    """
+    RotorNozzleDiameter: float | None = Field(None, title='Rotor Nozzle Diameter')
+    """
+    Diameter of the rotor at the nozzle.
+    """
+    BearingBoxClearance: float | None = Field(None, title='Bearing Box Clearance')
+    """
+    Clearance inside the bearing box.
+    """
+    NumberRotorLobes: int | None = Field(None, title='Number of Rotor Lobes')
+    """
+    Number of Rotor Lobes
+    """
+    NumberStatorLobes: int | None = Field(None, title='Number of Stator Lobes')
+    """
+    Number of Stator Lobes
+    """
+    BearingTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-MudMotorBearingType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Bearing Type ID')
+    """
+    Bearing Type Identifier
+    """
+    OperatingTemperatureMaximum: float | None = Field(
+        None, title='Operating Temperature Maximum'
+    )
+    """
+    Maximum operating temperature for the mud motor
+    """
+    IsRotorCatcherPresent: bool | None = Field(None, title='Is Rotor Catcher Present')
+    """
+    Is Rotor Catcher Present
+    """
+    IsDumpValvePresent: bool | None = Field(None, title='Is Dump Valve Present')
+    """
+    Is Dump Valve Present
+    """
+    NozzleDiameter: float | None = Field(None, title='Nozzle Diameter')
+    """
+    Nozzle Diameter
+    """
+    IsMotorRotatable: bool | None = Field(None, title='Is Motor Rotatable')
+    """
+    Is Motor Rotatable
+    """
+    BendSettingAngleMinimum: float | None = Field(
+        None, title='Bend Setting Angle Minimum'
+    )
+    """
+    Minimum bend angle setting
+    """
+    BendSettingAngleMaximum: float | None = Field(
+        None, title='Bend Setting Angle Maximum'
+    )
+    """
+    Maximum bend angle setting
+    """
+    PressureLossCurve: list[v1_0_0.AbstractTubularComponentPressureLoss] | None = Field(
+        None, title='PressureLossCurve'
+    )
+    """
+    Array of one or more flow rate versus measured pressure loss points used to interpolate pressure loss across the MWD/LWD tool for a given flowrate
+    """

osdu_models/abstract/abstract_tubular_component_pressure_loss/__init__.py

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

osdu_models/abstract/abstract_tubular_component_pressure_loss/v1_0_0.py

@@ -0,0 +1,23 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_tubular_component_pressure_loss/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class AbstractTubularComponentPressureLoss(BaseModel):
+    """
+    Tubular Component Measured Pressure Losses - Flow rate versus Pressure
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FlowRate: float | None = Field(None, title='Flow Rate')
+    """
+    Flow rate when pressure loss measured.
+    """
+    PressureLoss: float | None = Field(None, title='Pressure Loss')
+    """
+    Measured pressure loss for corresponding flow rate.
+    """

osdu_models/abstract/abstract_tubular_component_rss/__init__.py

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