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

osdu_models/masterdata/fluids_program/v1_1_0.py

@@ -0,0 +1,262 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/fluids_program/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, 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 FluidFacet(BaseModel):
+    """
+    A description of an individual facet composing a fluid
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FluidPropertyFacetNameID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-FluidPropertyFacetName:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Fluid Property Type Facet Name ID')
+    """
+    Identifier to the list of potential types of Fluid Property Facet (e.g. Measured, Range (Min), Range (Max)
+    """
+    FluidPropertyValue: float = Field(..., title='Fluid Property Value')
+    """
+    The actual value of the property
+    """
+    FluidPropertyUnit: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Fluid Property Unit')
+    """
+    The measurement unit of the Fluid Property Value
+    """
+    MeasuredPropertyID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-UnitQuantity:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Measured Property Identifier')
+    """
+    The unique identifier of the fluid property (density or temperature measurement,….)
+    """
+
+
+class FluidProperty(BaseModel):
+    """
+    A description of fluid used in the drilling of a wellbore
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FluidPropertyNameID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-FluidPropertyName:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['namespace:reference-data--FluidPropertyName:MW:'],
+        title='Fluid Property Name',
+    )
+    """
+    An open reference list of fluid properties
+    """
+    FluidFacets: list[FluidFacet] = Field(..., title='Fluid Facets')
+    """
+    Array of Fluids facet that describes each individual programmed property of the fluids.
+    """
+
+
+class BarrelFormulationItem(BaseModel):
+    """
+    Description of the formulation of the barrel that will be part of the drilling mud
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ProductName: str = Field(
+        ..., examples=['Bentonite, Caustic Soda, Soda Ash'], title='Product Name'
+    )
+    """
+    Name of the Product
+    """
+    ConcentrationValue: float | None = Field(None, title='Concentration Value')
+    """
+    The actual value of the planned product concentration
+    """
+    ConcentrationUnitOfMeasure: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Concentration Value Unit of Measure')
+    """
+    The unit of measure of the planned product concentration
+    """
+    Quantity: float | None = Field(None, title='Quantity')
+    """
+    The actual number of units of the component. The unit size of the component. For example if you wanted to use 15 x 25 lb bags then the Unit would be lbs, the UnitSize would be 25 and the Product Package would be "Bag" and the Quantity would be 15
+    """
+    ProductUnitOfMeasure: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Product Unit Of Measure')
+    """
+    The unit size of the component. For example if this product came in 25 lb bags then the Unit would be lbs, the UnitSize would be 25 and the Product Package would be "Bag"
+    """
+    ProductUnitSize: str | None = Field(None, title='Product Unit Size')
+    """
+    The unit size of the component. For example if this product came in 25 lb bags then the Unit would be lbs, the UnitSize would be 25 and the Product Package would be "Bag"
+    """
+    ProductCode: str | None = Field(None, title='Product Code')
+    """
+    The code associated with the product
+    """
+    ProductFunction: str | None = Field(None, title='Product Function')
+    """
+    The function that the component plays in the formulation. For example Base Oil, Fresh Water, Chemical Additive
+    """
+    ProductPackage: str | None = Field(None, title='Product Package')
+    """
+    The packaging that the component comes in. For example Sacks, Bags. For Liquids this is usually N/A
+    """
+    ProductSg: float | None = Field(None, title='Product Specific Gravity')
+    """
+    The specific gravity value of the component.
+    """
+
+
+class FluidsSystem(BaseModel):
+    """
+    Provides the overall description of the drilling fluids system.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FluidSystemName: str | None = Field(
+        None, examples=['KCL Polymer'], title='Fluid System Name'
+    )
+    """
+    Free text string of the common name or product name of the drilling mud.
+    """
+    FluidPurposeID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-FluidRole:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--FluidRole:Sweep:'],
+        title='Fluid Purpose ID',
+    )
+    """
+    The purpose the mud will play in this hole section (can be Sweep, Displacement Mud).
+    """
+    FluidProperties: list[FluidProperty] = Field(..., title='Fluid Properties')
+    """
+    An array of planned / designed properties of the fluid for the Interval / Phase. Properties may have a specified value or a range that should be maintained
+    """
+    BarrelFormulation: list[BarrelFormulationItem] | None = Field(
+        None, title='Barrel Formulation'
+    )
+    """
+    Description of the formulation to be used for the drilling activity
+    """
+    PolymerType: str | None = Field(None, title='Polymer Type')
+    """
+    Type of polymers present in mud system.
+    """
+
+
+class FluidInterval(BaseModel):
+    """
+    A fluid used in the drilling of a wellbore's section
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    IntervalName: str = Field(..., title='Interval Name')
+    """
+    The name of an interval in which the fluid will be used
+    """
+    IntervalTopMeasuredDepth: float = Field(..., title='Interval Top Measured Depth')
+    """
+    The top measured depth of the interval in which the fluid will be used (in many cases, this Measured Depth will be the same than the one provided by WellboreArchitecture.HoleSection content). Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    IntervalBaseMeasuredDepth: float = Field(..., title='Interval Base Measured Depth')
+    """
+    The bottom measured depth of the interval in which the fluid will be used (in many cases, this Measured Depth will be the same than the one provided by WellboreArchitecture.HoleSection content). Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    HoleSectionID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-HoleSection:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Hole Section ID')
+    """
+    Description of the Hole Section for this Fluids Program
+    """
+    InstalledTubularAssemblyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-TubularAssembly:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Installed Tubular Assembly ID')
+    """
+    The identifier of the tubular to be installed.
+    """
+    FluidTypeID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-FluidType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Fluid Type ID')
+    """
+    A fixed list of reference values describing the high level type of the drilling fluid
+    """
+    LabReferenceNumber: float | None = Field(None, title='Lab Reference Number')
+    """
+    A reference number allowing traceability back to the analysis of the fluid in a lab
+    """
+    ViscosityFunnel: float | None = Field(None, title='Viscosity Funnel')
+    """
+    Funnel viscosity in seconds.
+    """
+    Comments: str | None = Field(None, title='Comments')
+    """
+    Comments and remarks.
+    """
+    FluidsSystem_1: FluidsSystem = Field(
+        ..., alias='FluidsSystem', title='Fluid System'
+    )
+    """
+    Provides the overall description of the drilling fluids system.
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for FluidsProgram 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore ID')
+    """
+    Identifier of the planned Wellbore
+    """
+    FluidIntervals: list[FluidInterval] = Field(..., title='Fluid Intervals')
+    """
+    An array of fluid intervals that in turn describe the target fluid properties that should be implemented
+    """
+    FluidsSupplierID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Fluids Supplier ID')
+    """
+    Identifier of the fluids supplier company
+    """
+    Name: str | None = Field(None, title='Name')
+    """
+    Name of Fluids Program
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/fluids_program/v1_2_0.py

@@ -0,0 +1,270 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/fluids_program/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, 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 FluidFacet(BaseModel):
+    """
+    A description of an individual facet composing a fluid
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FluidPropertyFacetNameID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-FluidPropertyFacetName:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Fluid Property Type Facet Name ID')
+    """
+    Identifier to the list of potential types of Fluid Property Facet (e.g. Measured, Range (Min), Range (Max)
+    """
+    FluidPropertyValue: float = Field(..., title='Fluid Property Value')
+    """
+    The actual value of the property
+    """
+    FluidPropertyUnit: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Fluid Property Unit')
+    """
+    The measurement unit of the Fluid Property Value
+    """
+    MeasuredPropertyID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-UnitQuantity:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Measured Property Identifier')
+    """
+    The unique identifier of the fluid property (density or temperature measurement,….)
+    """
+
+
+class FluidProperty(BaseModel):
+    """
+    A description of fluid used in the drilling of a wellbore
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FluidPropertyNameID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-FluidPropertyName:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['namespace:reference-data--FluidPropertyName:MW:'],
+        title='Fluid Property Name',
+    )
+    """
+    An open reference list of fluid properties
+    """
+    FluidFacets: list[FluidFacet] = Field(..., title='Fluid Facets')
+    """
+    Array of Fluids facet that describes each individual programmed property of the fluids.
+    """
+
+
+class BarrelFormulationItem(BaseModel):
+    """
+    Description of the formulation of the barrel that will be part of the drilling mud
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ProductName: str = Field(
+        ..., examples=['Bentonite, Caustic Soda, Soda Ash'], title='Product Name'
+    )
+    """
+    Name of the Product
+    """
+    ConcentrationValue: float | None = Field(None, title='Concentration Value')
+    """
+    The actual value of the planned product concentration
+    """
+    ConcentrationUnitOfMeasure: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Concentration Value Unit of Measure')
+    """
+    The unit of measure of the planned product concentration
+    """
+    Quantity: float | None = Field(None, title='Quantity')
+    """
+    The actual number of units of the component. The unit size of the component. For example if you wanted to use 15 x 25 lb bags then the Unit would be lbs, the UnitSize would be 25 and the Product Package would be "Bag" and the Quantity would be 15
+    """
+    ProductUnitOfMeasure: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Product Unit Of Measure')
+    """
+    The unit size of the component. For example if this product came in 25 lb bags then the Unit would be lbs, the UnitSize would be 25 and the Product Package would be "Bag"
+    """
+    ProductUnitSize: str | None = Field(None, title='Product Unit Size')
+    """
+    The unit size of the component. For example if this product came in 25 lb bags then the Unit would be lbs, the UnitSize would be 25 and the Product Package would be "Bag"
+    """
+    ProductCode: str | None = Field(None, title='Product Code')
+    """
+    The code associated with the product
+    """
+    ProductFunction: str | None = Field(None, title='Product Function')
+    """
+    The function that the component plays in the formulation. For example Base Oil, Fresh Water, Chemical Additive
+    """
+    ProductPackage: str | None = Field(None, title='Product Package')
+    """
+    The packaging that the component comes in. For example Sacks, Bags. For Liquids this is usually N/A
+    """
+    ProductSg: float | None = Field(None, title='Product Specific Gravity')
+    """
+    The specific gravity value of the component.
+    """
+
+
+class FluidsSystem(BaseModel):
+    """
+    Provides the overall description of the drilling fluids system.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FluidSystemName: str | None = Field(
+        None, examples=['KCL Polymer'], title='Fluid System Name'
+    )
+    """
+    Free text string of the common name or product name of the drilling mud.
+    """
+    FluidPurposeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(reference-data\-\-WellFluidRole|reference-data\-\-FluidRole):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--FluidRole:Sweep:'],
+        title='Fluid Purpose ID',
+    )
+    """
+    The purpose the mud will play in this hole section (can be Sweep, Displacement Mud).
+    """
+    FluidProperties: list[FluidProperty] = Field(..., title='Fluid Properties')
+    """
+    An array of planned / designed properties of the fluid for the Interval / Phase. Properties may have a specified value or a range that should be maintained
+    """
+    BarrelFormulation: list[BarrelFormulationItem] | None = Field(
+        None, title='Barrel Formulation'
+    )
+    """
+    Description of the formulation to be used for the drilling activity
+    """
+    PolymerType: str | None = Field(None, title='Polymer Type')
+    """
+    Type of polymers present in mud system.
+    """
+
+
+class FluidInterval(BaseModel):
+    """
+    A fluid used in the drilling of a wellbore's section
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    IntervalName: str = Field(..., title='Interval Name')
+    """
+    The name of an interval in which the fluid will be used
+    """
+    IntervalTopMeasuredDepth: float = Field(..., title='Interval Top Measured Depth')
+    """
+    The top measured depth of the interval in which the fluid will be used (in many cases, this Measured Depth will be the same than the one provided by WellboreArchitecture.HoleSection content). Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    IntervalBaseMeasuredDepth: float = Field(..., title='Interval Base Measured Depth')
+    """
+    The bottom measured depth of the interval in which the fluid will be used (in many cases, this Measured Depth will be the same than the one provided by WellboreArchitecture.HoleSection content). Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    HoleSectionID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-HoleSection:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Hole Section ID')
+    """
+    Description of the Hole Section for this Fluids Program
+    """
+    InstalledTubularAssemblyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(master-data\-\-TubularAssembly|work-product-component\-\-TubularAssembly):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--TubularAssembly:9_58ProdCasing:'],
+        title='Installed Tubular Assembly ID',
+    )
+    """
+    The identifier of the tubular to be installed.
+    """
+    FluidTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(reference-data\-\-WellFluidType|reference-data\-\-FluidType):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Fluid Type ID')
+    """
+    A fixed list of reference values describing the high level type of the drilling fluid
+    """
+    LabReferenceNumber: float | None = Field(None, title='Lab Reference Number')
+    """
+    A reference number allowing traceability back to the analysis of the fluid in a lab
+    """
+    ViscosityFunnel: float | None = Field(None, title='Viscosity Funnel')
+    """
+    Funnel viscosity in seconds.
+    """
+    Comments: str | None = Field(None, title='Comments')
+    """
+    Comments and remarks.
+    """
+    FluidsSystem_1: FluidsSystem = Field(
+        ..., alias='FluidsSystem', title='Fluid System'
+    )
+    """
+    Provides the overall description of the drilling fluids system.
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for FluidsProgram 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore ID')
+    """
+    Identifier of the planned Wellbore
+    """
+    FluidIntervals: list[FluidInterval] = Field(..., title='Fluid Intervals')
+    """
+    An array of fluid intervals that in turn describe the target fluid properties that should be implemented
+    """
+    FluidsSupplierID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Fluids Supplier ID')
+    """
+    Identifier of the fluids supplier company
+    """
+    Name: str | None = Field(None, title='Name')
+    """
+    Name of Fluids Program
+    """
+    ExtensionProperties: dict[str, Any] | None = None