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

osdu_models/abstract/abstract_tubular_component_rss/v1_0_0.py

@@ -0,0 +1,107 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_tubular_component_rss/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 AbstractTubularComponentRss(BaseModel):
+    """
+    Rotary Steerable Tool Tubular Component specific properties. Based on WITSML Tubular  Component 'RotarySteerableTool' ComplexType.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    BendAngle: float | None = Field(None, title='Bend Angle')
+    """
+    Bend Angle.
+    """
+    BendOffset: float | None = Field(None, title='Bend Offset')
+    """
+    Offset distance from the bottom connection to the bend,
+    """
+    DeflectionMethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-RotarySteerableDeflectionMethod:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Deflection Method ID')
+    """
+    Method used to direct the deviation of the trajectory: point bit or push bit
+    """
+    DownlinkFlowrateMinimum: float | None = Field(
+        None, title='Downlink Flowrate Minimum'
+    )
+    """
+    Minimum flow rate for programming the tool.
+    """
+    DownlinkFlowrateMaximum: float | None = Field(
+        None, title='Downlink Flowrate Maximum'
+    )
+    """
+    Maximum flow rate for programming 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.
+    """
+    HoleSizeMininum: float | None = Field(None, title='Hole Size Mininum')
+    """
+    Minimum size of the hole in which the tool can operate.
+    """
+    HoleSizeMaximum: float | None = Field(None, title='Hole Size Maximum')
+    """
+    Maximum size of the hole in which the tool can operate.
+    """
+    OperatingSpeed: float | None = Field(None, title='Operating Speed')
+    """
+    Suggested operating speed.
+    """
+    PressureLossFactor: float | None = Field(None, title='Pressure Loss Factor')
+    """
+    Pressure drop across the tool.
+    """
+    SpeedMaximum: float | None = Field(None, title='Speed Maximum')
+    """
+    Maximum rotation speed.
+    """
+    WobMaximum: float | None = Field(None, title='WOB Maximum')
+    """
+    Maximum weight on the bit.
+    """
+    PadCount: int | None = Field(None, title='Pad Count')
+    """
+    The number of contact pads.
+    """
+    PadLength: float | None = Field(None, title='Pad Length')
+    """
+    Length of the contact pad.
+    """
+    PadWidth: float | None = Field(None, title='Pad Width')
+    """
+    Width of the contact pad.
+    """
+    PadOffset: float | None = Field(None, title='Pad Offset')
+    """
+    Offset distance from the bottom of the pad to the bottom connector.
+    """
+    OpenPadOuterDiameter: float | None = Field(None, title='Open Pad Outer Diameter')
+    """
+    Outside diameter of the tool when the pads are activated.
+    """
+    ClosePadOuterDiameter: float | None = Field(None, title='Close Pad Outer Diameter')
+    """
+    Outside diameter of the tool when the pads are closed.
+    """
+    PressureLossCurve: list[v1_0_0.AbstractTubularComponentPressureLoss] | None = Field(
+        None, title='PressureLossCurve'
+    )
+    """
+    Array of one or more pressure loss versus flowrate points used to interpolate pressure loss across the MWD/LWD tool.
+    """

osdu_models/abstract/abstract_tubular_component_stabiliser/__init__.py

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

osdu_models/abstract/abstract_tubular_component_stabiliser/v1_0_0.py

@@ -0,0 +1,90 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_tubular_component_stabiliser/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractTubularComponentStabiliser(BaseModel):
+    """
+    Stabiliser Tubular Component specific properties. Based on the WITSML Tubular schema 'Stabiliser' ComplexType.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StabiliserTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-StabiliserType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--StabiliserType:IntegralBladeStabilizer:'],
+        title='Stabiliser Type ID',
+    )
+    """
+    Stabiliser design classification.
+    """
+    StabiliserBladeDesignTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-StabiliserBladeDesignType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--StabiliserBladeDesignType:SpiralBlade:'],
+        title='Stabiliser Blade Design Type ID',
+    )
+    """
+    Blade type classification.
+    """
+    StabiliserOperatingDesignID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-StabiliserOperatingDesign:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--StabiliserOperatingDesign:Rotating:'],
+        title='Stabiliser Operating Design ID',
+    )
+    """
+    Stabiliser operating design classification.
+    """
+    BladeOuterDiameterMinimum: float | None = Field(
+        None, examples=['12.25 in'], title='Minimum Blade OD'
+    )
+    """
+    Minimum Outer Diameter of the Blades.
+    """
+    BladeOuterDiameterMaximum: float | None = Field(
+        None, examples=['12.25 in'], title='Maximum Blade OD'
+    )
+    """
+    Maximum Outer Diameter of the Blades.
+    """
+    NumberBlades: int | None = Field(None, examples=[3], title='Number of Blades')
+    """
+    Number of blades on the Stabiliser.
+    """
+    LengthBlade: float | None = Field(None, examples=['24 in'], title='Blade Length')
+    """
+    Length of the blade.
+    """
+    LengthBladeGauge: float | None = Field(
+        None, examples=['26 in'], title='Length Blade Gauge'
+    )
+    """
+    Gauge Length of the blade. That is, the length of the blade measured at the OD Blade Max.
+    """
+    BladePadDiameter: float | None = Field(
+        None, examples=['2.5 in'], title='Blade Pad Diameter'
+    )
+    """
+    Width of the blade at the contact interval of the pad.
+    """
+    FictionFactor: float | None = Field(None, examples=[0.2], title='Friction Factor')
+    """
+    Coefficient of Friction 0 - 1.
+    """

osdu_models/abstract/abstract_unstructured_column_layer_grid_patch/__init__.py

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

osdu_models/abstract/abstract_unstructured_column_layer_grid_patch/v1_0_0.py

@@ -0,0 +1,29 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_unstructured_column_layer_grid_patch/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from ..abstract_column_layer_grid_patch.v1_0_0 import AbstractColumnLayerGridPatch
+
+
+class AbstractUnstructuredColumnLayerGridPatch(AbstractColumnLayerGridPatch):
+    """
+    Definition of a collection of polyhedra which are only organized by column. Only an abstract group type in order to be reused in GPGrid.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ColumnShapeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ColumnShapeType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--ColumnShapeType:Polygonal:'],
+        title='Column shape',
+    )
+    """
+    Indicates the common shape of all columns in this grid : triangular, quadrilateral, polygonal
+    """

osdu_models/abstract/abstract_unstructured_grid_patch/__init__.py

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

osdu_models/abstract/abstract_unstructured_grid_patch/v1_0_0.py

@@ -0,0 +1,36 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_unstructured_grid_patch/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractUnstructuredGridPatch(BaseModel):
+    """
+    Definition of a collection of polyhedra which are not organized in any dimension. Only an abstract group type in order to be reused in GPGrid.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FaceCount: int | None = Field(None, examples=[2000], title='Count of faces')
+    """
+    The count of faces in this grid
+    """
+    NodeCount: int | None = Field(None, examples=[6500], title='Count of nodes')
+    """
+    The count of nodes in this grid
+    """
+    CellShapeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CellShapeType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--CellShapeType:Polyhedral:'],
+        title='Uniform shape of all cells',
+    )
+    """
+    Indicates the uniform shape of all cells in this grid : tetrahedral, pyramidal, prism, hexahedral, polyhedral
+    """

osdu_models/abstract/abstract_vector_header_mapping/__init__.py

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

osdu_models/abstract/abstract_vector_header_mapping/v1_0_0.py

@@ -0,0 +1,85 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_vector_header_mapping/v1_0_0.json
+
+from __future__ import annotations
+from enum import Enum
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class ScalarIndicator(Enum):
+    """
+    Enumerated string indicating whether to use the normal scalar field for scaling this field (STANDARD), no scaling (NOSCALE), or override scalar (OVERRIDE).  Default is current STANDARD (such as SEG-Y rev2).
+    """
+
+    STANDARD = 'STANDARD'
+    NOSCALE = 'NOSCALE'
+    OVERRIDE = 'OVERRIDE'
+
+
+class VectorHeaderMappingItem(BaseModel):
+    """
+    Array of objects which define the meaning and format of a tabular structure used in a binary file as a header.  The initial use case is the trace headers of a SEG-Y file.  Note that some of this information may be repeated in the SEG-Y EBCDIC header.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    KeyName: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HeaderKeyName:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Key Name')
+    """
+    Relationship to a reference value for a name of a property header such as INLINE, CDPX.
+    """
+    WordFormat: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WordFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Word Format')
+    """
+    Relationship to a reference value for binary data types, such as INT, UINT, FLOAT, IBM_FLOAT, ASCII, EBCDIC.
+    """
+    WordWidth: int | None = Field(None, title='Word Width')
+    """
+    Size of the word in bytes.
+    """
+    Position: int | None = None
+    """
+    Beginning byte position of header value, 1 indexed.
+    """
+    UoM: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Unit of Measure')
+    """
+    Relationship to units of measure reference if header standard is not followed.
+    """
+    ScalarIndicator_1: ScalarIndicator | None = Field(
+        None, alias='ScalarIndicator', title='Scalar Indicator'
+    )
+    """
+    Enumerated string indicating whether to use the normal scalar field for scaling this field (STANDARD), no scaling (NOSCALE), or override scalar (OVERRIDE).  Default is current STANDARD (such as SEG-Y rev2).
+    """
+    ScalarOverride: float | None = Field(None, title='Scalar Override')
+    """
+    Scalar value (as defined by standard) when a value present in the header needs to be overwritten for this value.
+    """
+
+
+class AbstractVectorHeaderMapping(BaseModel):
+    """
+    Array of objects which define the meaning and format of a tabular structure used in a binary file as a header.  The initial use case is the trace headers of a SEG-Y file.  Note that some of this information may be repeated in the SEG-Y EBCDIC header.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    VectorHeaderMapping: list[VectorHeaderMappingItem] | None = None
+    """
+    Array of objects which define the meaning and format of a tabular structure used in a binary file as a header.  The initial use case is the trace headers of a SEG-Y file.  Note that some of this information may be repeated in the SEG-Y EBCDIC header.
+    """

osdu_models/abstract/abstract_vector_header_mapping/v1_1_0.py

@@ -0,0 +1,236 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_vector_header_mapping/v1_1_0.json
+
+from __future__ import annotations
+from enum import Enum
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class ScalarIndicator(Enum):
+    """
+    Enumerated string indicating whether to use the normal scalar field for scaling this field (STANDARD), no scaling (NOSCALE), or override scalar (OVERRIDE).  Default is current STANDARD (such as SEG-Y rev2).
+    """
+
+    STANDARD = 'STANDARD'
+    NOSCALE = 'NOSCALE'
+    OVERRIDE = 'OVERRIDE'
+
+
+class VectorHeaderMappingItem(BaseModel):
+    """
+    Array of objects which define the meaning and format of a tabular structure used in a binary file as a header.  The initial use case is the trace headers of a SEG-Y file.  Note that some of this information may be repeated in the SEG-Y EBCDIC header.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    KeyName: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HeaderKeyName:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Key Name')
+    """
+    Relationship to a reference value for a name of a property header such as INLINE, CDPX.
+    """
+    WordFormat: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WordFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Word Format')
+    """
+    Relationship to a reference value for binary data types, such as INT, UINT, FLOAT, IBM_FLOAT, ASCII, EBCDIC.
+    """
+    WordWidth: int | None = Field(None, title='Word Width')
+    """
+    Size of the word in bytes.
+    """
+    Position: int | None = None
+    """
+    Beginning byte position of header value, 1 indexed.
+    """
+    UoM: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Unit of Measure')
+    """
+    Relationship to units of measure reference if header standard is not followed.
+    """
+    ScalarIndicator_1: ScalarIndicator | None = Field(
+        None, alias='ScalarIndicator', title='Scalar Indicator'
+    )
+    """
+    Enumerated string indicating whether to use the normal scalar field for scaling this field (STANDARD), no scaling (NOSCALE), or override scalar (OVERRIDE).  Default is current STANDARD (such as SEG-Y rev2).
+    """
+    ScalarOverride: float | None = Field(None, title='Scalar Override')
+    """
+    Scalar value (as defined by standard) when a value present in the header needs to be overwritten for this value.
+    """
+
+
+class Operator1(Enum):
+    """
+    The operator 1, an enumeration with permitted values of Plus, Minus, DivideBy, DivideByInteger, MultiplyBy,  Modulo, Equals.
+    """
+
+    Plus = 'Plus'
+    Minus = 'Minus'
+    DivideBy = 'DivideBy'
+    DivideByInteger = 'DivideByInteger'
+    MultiplyBy = 'MultiplyBy'
+    Modulo = 'Modulo'
+    Equals = 'Equals'
+
+
+class Operator2(Enum):
+    """
+    The operator 2, an enumeration with permitted values of Plus, Minus, DivideBy, DivideByInteger, MultiplyBy,  Modulo, Equals.
+    """
+
+    Plus = 'Plus'
+    Minus = 'Minus'
+    DivideBy = 'DivideBy'
+    DivideByInteger = 'DivideByInteger'
+    MultiplyBy = 'MultiplyBy'
+    Modulo = 'Modulo'
+    Equals = 'Equals'
+
+
+class OverrideByExpression(BaseModel):
+    """
+    An expression, potentially in a sequence, allowing the computation of a value or intermediate value.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Input: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HeaderKeyName:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Input')
+    """
+    The input variable given by the HeaderKeyName.
+    """
+    Operator1_1: Operator1 | None = Field(None, alias='Operator1', title='Operator 1')
+    """
+    The operator 1, an enumeration with permitted values of Plus, Minus, DivideBy, DivideByInteger, MultiplyBy,  Modulo, Equals.
+    """
+    Operand1Constant: float | None = Field(None, title='Operand 1 Constant')
+    """
+    The constant operand 1 value.  If populated, Operand1Variable must be absent.
+    """
+    Operand1Variable: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HeaderKeyName:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Operand 1 Variable')
+    """
+    The operand 1 variable given by the HeaderKeyName, where to obtain the value. If populated, Operand1Constant must be absent.
+    """
+    Operator2_1: Operator2 | None = Field(None, alias='Operator2', title='Operator 2')
+    """
+    The operator 2, an enumeration with permitted values of Plus, Minus, DivideBy, DivideByInteger, MultiplyBy,  Modulo, Equals.
+    """
+    Operand2Constant: float | None = Field(None, title='Operand 2 Constant')
+    """
+    The constant operand 2 value. If populated, Operand2Variable must be absent.
+    """
+    Operand2Variable: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HeaderKeyName:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Operand 2 Variable')
+    """
+    The operand 2 variable given by the HeaderKeyName, where to obtain the value. If populated, Operand2Constant must be absent.
+    """
+    Remark: str | None = Field(None, title='Remark')
+    """
+    An optional remark explaining the intention or purpose of this expression.
+    """
+
+
+class TraceHeaderOverride(BaseModel):
+    """
+    An object defining an override condition  for a vector header value, e.g. SEG-Y trace header value.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    KeyName: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HeaderKeyName:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Key Name')
+    """
+    Relationship to a reference value for a name of a property header such as INLINE, CDPX.
+    """
+    OverrideByConstant: float | None = Field(None, title='Override by Constant')
+    """
+    The constant value to be assigned to the position. If populated, the OverrideByExpressions must be empty.
+    """
+    OverrideByExpressions: list[OverrideByExpression] | None = Field(
+        None, title='Override by Expressions'
+    )
+    """
+    The value to be overridden is computed by evaluating the sequence of expressions. If populated, the OverrideByConstant must be empty.
+    """
+
+
+class BinaryHeaderOverride(BaseModel):
+    """
+    An object defining an override condition  for a vector header value, e.g. SEG-Y binary header value.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    KeyName: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-HeaderKeyName:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Key Name')
+    """
+    Relationship to a reference value for a name of a property header such as LineNumber.
+    """
+    OverrideByConstant: int | None = Field(None, title='Override by Constant')
+    """
+    The constant value to be assigned to the position.
+    """
+
+
+class AbstractVectorHeaderMapping(BaseModel):
+    """
+    Array of objects which define the meaning and format of a tabular structure used in a binary file as a header.  The initial use case is the trace headers of a SEG-Y file.  Note that some of this information may be repeated in the SEG-Y EBCDIC header.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    VectorHeaderMapping: list[VectorHeaderMappingItem] | None = Field(
+        None, title='Vector Header Mapping'
+    )
+    """
+    Array of objects which define the meaning and format of a tabular structure used in a binary file as a header.  The initial use case is the trace headers of a SEG-Y file.  Note that some of this information may be repeated in the SEG-Y EBCDIC header.
+    """
+    TraceHeaderOverrides: list[TraceHeaderOverride] | None = Field(
+        None, title='Trace Header Overrides'
+    )
+    """
+    Trace header override definitions.
+    """
+    BinaryHeaderOverrides: list[BinaryHeaderOverride] | None = Field(
+        None, title='Binary Header Overrides'
+    )
+    """
+    Binary header override definitions.
+    """

osdu_models/abstract/abstract_well_license_condition/__init__.py

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