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

osdu_models/workproductcomponent/tubular_assembly/v1_3_0.py

@@ -0,0 +1,216 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/tubular_assembly/v1_3_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_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+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
+    ) = None
+    """
+    SRN of a reference value status type
+    """
+    Description: str | None = None
+    """
+    Used to describe the reason of Activity - such as cut/pull, pulling,
+    """
+    Date: str | None = None
+    """
+    Date the status has been established
+    """
+
+
+class TubularAssemblyState(BaseModel):
+    """
+    Record that reflects the status of the Assembly - as 'installed', 'pulled', 'planned',... - Applicable to tubing/completions as opposed to drillstrings
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StatusTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularAssemblyStatusType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    SRN of a reference value status type
+    """
+    Description: str | None = None
+    """
+    Used to describe the reason of Activity - such as cut/pull, pulling,
+    """
+    Date: str | None = None
+    """
+    Date the status has been established
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for TubularAssembly 1.3.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    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\-\.]+:work-product-component\-\-TubularAssembly:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    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 and their 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 = None
+    """
+    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.
+    """
+    SuspensionPointMD: float | None = None
+    """
+    In case of multi-nesting of assemblies, the 'point' is the Measured Depth of the top of the assembly though with PBRs the Suspension Point may not be the top.
+    """
+    TubularAssemblyNumber: int | None = None
+    """
+    Sequence of the TubularAssembly (Typically BHA sequence)
+    """
+    TubularAssemblyTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TubularAssemblyType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Type of tubular assembly.
+    """
+    StringClassID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-StringClass:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Descriptor for Assembly, e.g. Production, Surface, Conductor, Intermediate, Drilling
+    """
+    ActivityTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(reference-data\-\-ActivityType|reference-data\-\-TubularAssemblyActivityType):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Used to describe if it belongs to a RunActivity or to a PullActivity
+    """
+    ActivityTypeReasonDescription: str | None = None
+    """
+    Used to describe the reason of Activity - such as cut/pull, pulling,…
+    """
+    ArtificialLiftTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ArtificialLiftType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Type of Artificial Lift used (could be "Surface Pump" / "Submersible Pump" / "Gas Lift"….)
+    """
+    LinerTypeID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-LinerType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    This reference table describes the type of liner used in the borehole. For example, slotted, gravel packed or pre-perforated etc.
+    """
+    MixedStringIndicator: constr(pattern=r'^YES|NO$') | None = None
+    """
+    A YES or NO flag indicating the assembly is a mixed string. The length of the assembly may be made up of joints with different tensile strengths, or collapse resistance and yield strengths.
+    """
+    ActiveIndicator: bool | None = None
+    """
+    Indicates if the Assembly is activated or not
+    """
+    TubularDirection: constr(pattern=r'^TOPDOWN|BOTTOMUP$') | None = None
+    """
+    Defines whether the sequence of child tubular components runs either top to bottom, or bottom to top.
+    """
+    TubularAssemblyNominalSize: float | None = None
+    """
+    Nominal size (diameter) describing the whole assembly, e.g. 9.625", 12.25
+    """
+    TubularAssemblyTotalLength: float | None = None
+    """
+    Total Length of the whole assembly.
+    """
+    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.
+    """
+    MinimumInnerDiameter: float | None = None
+    """
+    This is the minimum inner diameter of the whole assembly.
+    """
+    PilotHoleSize: float | None = None
+    """
+    Diameter of the Pilot Hole
+    """
+    SeaFloorPenetrationLength: float | None = None
+    """
+    the distance that the assembly has penetrated below the surface of the sea floor.
+    """
+    AssemblyTopMD: float | None = None
+    """
+    The measured depth of the top from the whole assembly
+    """
+    AssemblyBaseMD: float | None = None
+    """
+    The measured depth of the base from the whole assembly
+    """
+    AssemblyTopReportedTVD: float | None = None
+    """
+    Depth of the top of the Assembly measured from the Well-Head
+    """
+    AssemblyBaseReportedTVD: float | None = None
+    """
+    Depth of the base of the Assembly measured from the Well-Head
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/tubular_component/__init__.py

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

osdu_models/workproductcomponent/tubular_component/v1_0_0.py

@@ -0,0 +1,187 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/tubular_component/v1_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_wpcgroup_type.v1_0_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_0_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for TubularComponent 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    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\-\.]+:work-product-component\-\-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\-\-SectionType:[\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\-\-MaterialType:[\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

osdu_models/workproductcomponent/tubular_component/v1_1_0.py

@@ -0,0 +1,187 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/tubular_component/v1_1_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_wpcgroup_type.v1_0_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_0_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for TubularComponent 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    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\-\.]+:work-product-component\-\-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\-\-SectionType:[\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