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

osdu_models/masterdata/fluids_report/v1_0_0.py

@@ -0,0 +1,458 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/fluids_report/v1_0_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_0_0 import AbstractMaster
+
+
+class RheometerViscosity(BaseModel):
+    """
+    Viscosity values observed
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Speed: float = Field(..., title='Speed')
+    """
+    Rotational speed of the rheometer, typically in RPM.
+    """
+    Viscosity: float = Field(..., title='Viscosity')
+    """
+    The raw reading from a rheometer. This could be, but is not necessarily, a viscosity.
+    """
+
+
+class RheometerItem(BaseModel):
+    """
+    Rheometer values observed
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    TemperatureRheometer: float = Field(..., title='Temperature Rheometer')
+    """
+    The temperature at which the rheometer values were measured
+    """
+    PressureRheometer: float = Field(..., title='Pressure Rheometer')
+    """
+    The pressure at which the rheometer values were measured
+    """
+    RheometerViscosities: list[RheometerViscosity] | None = Field(
+        None, title='Rheometer Viscosities'
+    )
+    """
+    The viscosities recorder during the Rheometer test
+    """
+
+
+class FluidItem(BaseModel):
+    """
+    Information regarding an individual fluid that is part of the Drilling Report.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Type: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-FluidType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Type')
+    """
+    Description for the type of fluid.
+    """
+    SampleLocation: str | None = Field(None, title='Sample Location')
+    """
+    Sample location.
+    """
+    SampleDateTime: str | None = Field(None, title='Date Time')
+    """
+    The time when fluid readings were recorded.
+    """
+    MeasuredDepth: float | None = Field(None, title='Measured Depth')
+    """
+    The measured depth where the fluid readings were recorded.
+    """
+    TVD: float | None = Field(None, title='TVD')
+    """
+    The true vertical depth where the fluid readings were recorded.
+    """
+    EquivalentCirculatingDensity: float | None = Field(
+        None, title='Equivalent Circulating Density'
+    )
+    """
+    Equivalent circulating density where fluid reading was recorded or calculated/simulated
+    """
+    EquivalentStaticDensity: float | None = Field(
+        None, title='Equivalent Static Density'
+    )
+    """
+    Equivalent static density where fluid reading was recorded or calculated/simulated
+    """
+    KickToleranceVolume: float | None = Field(None, title='Kick Tolerance Volume')
+    """
+    Assumed kick volume for calculation of kick tolerance based on the kick intensity where the fluid reading was recorded.
+    """
+    KickToleranceIntensity: float | None = Field(None, title='Kick Tolerance Intensity')
+    """
+    Assumed kick density for calculation of kick tolerance where the fluid reading was recorded.
+    """
+    TemperatureFlowLine: float | None = Field(None, title='Temperature Flow Line')
+    """
+    Flow line temperature measurement where the fluid reading was recorded.
+    """
+    MudClass: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-MudClass:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Mud Class')
+    """
+    The class of the drilling fluid.
+    """
+    Density: float | None = Field(None, title='Density')
+    """
+    Fluid density. This excludes the cuttings.
+    """
+    ViscosityFunnel: float | None = Field(None, title='Viscosity Funnel')
+    """
+    Funnel viscosity in seconds.
+    """
+    TemperatureViscosity: float | None = Field(None, title='Temperature Viscosity')
+    """
+    Funnel viscosity temperature.
+    """
+    PlasticViscosity: float | None = Field(None, title='Plastic Viscosity')
+    """
+    Plastic viscosity.
+    """
+    YieldPoint: float | None = Field(None, title='Yield Point')
+    """
+    Yield point (Bingham and Herschel Bulkley models).
+    """
+    LowShearYieldPoint: float | None = Field(None, title='Low Shear Yield Point')
+    """
+    Shearing capacity of mud at low velocity
+    """
+    Gel0Sec: float | None = Field(None, title='Gel0 Sec')
+    """
+    Zero-second gels.
+    """
+    Gel10Sec: float | None = Field(None, title='Gel10 Sec')
+    """
+    Ten-second gels.
+    """
+    Gel10Min: float | None = Field(None, title='Gel10 Min')
+    """
+    Ten-minute gels.
+    """
+    Gel30Min: float | None = Field(None, title='Gel30 Min')
+    """
+    Thirty-minute gels.
+    """
+    FilterCakeLtlp: float | None = Field(None, title='Filter Cake Ltlp')
+    """
+    Filter cake thickness at low (normal) temperature and pressure.
+    """
+    FiltrateLtlp: float | None = Field(None, title='Filtrate Ltlp')
+    """
+    API water loss (low temperature and pressure mud filtrate measurement) (volume per 30 min).
+    """
+    AnnularShapeRatio: float | None = Field(None, title='Annular Shape Ratio')
+    """
+    Cleaning coefficient of drilling fluid
+    """
+    FiltrateTemperatureHthp: float | None = Field(
+        None, title='Filtrate Temperature Hthp'
+    )
+    """
+    High temperature high pressure (HTHP) temperature.
+    """
+    FiltratePressureHthp: float | None = Field(None, title='Filtrate Pressure Hthp')
+    """
+    High temperature high pressure (HTHP) pressure.
+    """
+    FiltrateHthp: float | None = Field(None, title='Filtrate Hthp')
+    """
+    High temperature high pressure (HTHP) filtrate (volume per 30 min).
+    """
+    FilterCakeHthp: float | None = Field(None, title='Filter Cake Hthp')
+    """
+    High temperature high pressure (HTHP) filter cake thickness.
+    """
+    SolidsPc: float | None = Field(None, title='Solids Pc')
+    """
+    Solids percentage from retort.
+    """
+    WaterPc: float | None = Field(None, title='Water Pc')
+    """
+    Water content percent.
+    """
+    OilPc: float | None = Field(None, title='Oil Pc')
+    """
+    Percent oil content from retort.
+    """
+    SandPc: float | None = Field(None, title='Sand Pc')
+    """
+    Sand content percent.
+    """
+    SolidsLowGravPc: float | None = Field(None, title='Solids Low Grav Pc')
+    """
+    Low gravity solids percent.
+    """
+    SolidsLowGrav: float | None = Field(None, title='Solids Low Grav')
+    """
+    Solids low gravity content.
+    """
+    SolidsLowGravCorrected: float | None = Field(
+        None, title='Solids Low Grav Corrected'
+    )
+    """
+    Solids low gravity content corrected for chloride content
+    """
+    SolidsHiGravPc: float | None = Field(None, title='Solids Hi Grav Pc')
+    """
+    Solids high gravity percent.
+    """
+    SolidsHiGrav: float | None = Field(None, title='Solids Hi Grav')
+    """
+    Solids high gravity content.
+    """
+    SolidsHiGravCorrected: float | None = Field(None, title='Solids Hi Grav Corrected')
+    """
+    Solids high gravity content corrected for chloride content
+    """
+    SolidsCalcPc: float | None = Field(None, title='Solids Calc Pc')
+    """
+    Percent calculated solids content.
+    """
+    BaritePc: float | None = Field(None, title='Barite Pc')
+    """
+    Barite content percent.
+    """
+    Lcm: float | None = Field(None, title='Lcm')
+    """
+    Lost circulation material.
+    """
+    Mbt: float | None = Field(None, title='Mbt')
+    """
+    Cation exchange capacity (CEC) of the mud sample as measured by methylene blue titration (MBT).
+
+    NOTE: This is temporarily set to be a GenericMeasure with no unit validation, pending addition of CEC units to the Energistics UoM spec.
+    """
+    MudPh: float | None = Field(None, title='Mud Ph')
+    """
+    Mud pH.
+    """
+    MudTempPh: float | None = Field(None, title='Mud Temp Ph')
+    """
+    Mud pH measurement temperature.
+    """
+    Pm: float | None = Field(None, title='Pm')
+    """
+    Phenolphthalein alkalinity of whole mud.
+    """
+    PmFiltrate: float | None = Field(None, title='Pm Filtrate')
+    """
+    Phenolphthalein alkalinity of mud filtrate.
+    """
+    Mf: float | None = Field(None, title='Mf')
+    """
+    Methyl orange alkalinity of filtrate.
+    """
+    AlkalinityP1: float | None = Field(None, title='Alkalinity P1')
+    """
+    Mud alkalinity P1 from alternate alkalinity method (volume in ml of 0.02N acid 
+    to reach the phenolphthalein endpoint).
+    """
+    AlkalinityP2: float | None = Field(None, title='Alkalinity P2')
+    """
+    Mud alkalinity P2 from alternate alkalinity method (volume in ml of 0.02N acid to titrate, the reagent mixture to the phenolphthalein endpoint).
+    """
+    Chloride: float | None = Field(None, title='Chloride')
+    """
+    Chloride content.
+    """
+    Calcium: float | None = Field(None, title='Calcium')
+    """
+    Calcium content.
+    """
+    Magnesium: float | None = Field(None, title='Magnesium')
+    """
+    Magnesium content.
+    """
+    Potassium: float | None = Field(None, title='Potassium')
+    """
+    Potassium content.
+    """
+    BrinePc: float | None = Field(None, title='Brine Pc')
+    """
+    Percent brine content.
+    """
+    BrineDensity: float | None = Field(None, title='Brine Density')
+    """
+    Density of water phase of NAF.
+    """
+    Lime: float | None = Field(None, title='Lime')
+    """
+    Lime content.
+    """
+    ElectStab: float | None = Field(None, title='Elect Stab')
+    """
+    Measurement of the emulsion stability and oil-wetting capability in oil-based muds.
+    """
+    CalciumChloridePc: float | None = Field(None, title='Calcium Chloride Pc')
+    """
+    Calcium chloride percent.
+    """
+    CalciumChloride: float | None = Field(None, title='Calcium Chloride')
+    """
+    Calcium chloride content.
+    """
+    CompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Company')
+    """
+    Reference to the Company performing the analysis
+    """
+    MudEngineer: str | None = Field(None, title='Mud Engineer')
+    """
+    The name of the Mud Engineer
+    """
+    Asg: float | None = Field(None, title='Asg')
+    """
+    Average specific gravity of solids.
+    """
+    Polymer: float | None = Field(None, title='Polymer')
+    """
+    Polymers present in the mud system.
+    """
+    PolymerType: list[str] | None = Field(None, title='Polymer Type')
+    """
+    Type of polymers present in the mud system.
+    """
+    SolCorPc: float | None = Field(None, title='Sol Cor Pc')
+    """
+    Solids corrected for chloride content percent.
+    """
+    OilCtg: float | None = Field(None, title='Oil Ctg')
+    """
+    Oil on cuttings.
+    """
+    OilCtgDry: float | None = Field(None, title='Oil Ctg Dry')
+    """
+    Oil on dried cuttings.
+    """
+    HardnessCa: float | None = Field(None, title='Hardness Ca')
+    """
+    Total calcium hardness.
+    """
+    Sulfide: float | None = Field(None, title='Sulfide')
+    """
+    Sulfide content.
+    """
+    AverageCuttingSize: float | None = Field(None, title='Average Cutting Size')
+    """
+    Average size of the drill cuttings.
+    """
+    Carbonate: float | None = Field(None, title='Carbonate')
+    """
+    Carbonate content.
+    """
+    Iron: float | None = Field(None, title='Iron')
+    """
+    Iron content.
+    """
+    MetalRecovered: float | None = Field(None, title='Metal Recovered')
+    """
+    Metal recovered from the wellbore.
+    """
+    Turbidity: float | None = Field(None, title='Turbidity')
+    """
+    Turbidity units to measure the cloudiness or haziness of a fluid.
+    """
+    OilGrease: float | None = Field(None, title='Oil Grease')
+    """
+    Oil and grease content.
+    """
+    Salt: float | None = Field(None, title='Salt')
+    """
+    Salt content.
+    """
+    SaltPc: float | None = Field(None, title='Salt Pc')
+    """
+    Salt percent.
+    """
+    Tct: float | None = Field(None, title='Tct')
+    """
+    True crystallization temperature.
+    """
+    WaterPhaseSalinity: float | None = Field(None, title='Water Phase Salinity')
+    """
+    A factor showing the activity level of salt in oil-based mud.
+    """
+    WholeMudCalcium: float | None = Field(None, title='Whole Mud Calcium')
+    """
+    Calcium content in the whole mud sample, including oil and water phases.
+    """
+    WholeMudChloride: float | None = Field(None, title='Whole Mud Chloride')
+    """
+    Chloride content in the whole mud sample, including oil and water phases.
+    """
+    ZincOxide: float | None = Field(None, title='Zinc Oxide')
+    """
+    Zinc oxide content.
+    """
+    SodiumChloride: float | None = Field(None, title='Sodium Chloride')
+    """
+    Sodium chloride content.
+    """
+    SodiumChloridePc: float | None = Field(None, title='Sodium Chloride Pc')
+    """
+    Sodium chloride percent.
+    """
+    Comments: str | None = Field(None, title='Comments')
+    """
+    Comments and remarks.
+    """
+    Rheometer: list[RheometerItem] | None = Field(None, title='Rheometer')
+    """
+    Details of the Rheometer tests performed on the fluid sample
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for FluidsReport 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StartDateTime: str = Field(..., title='Report Date Time')
+    """
+    Start DateTime of the reporting period
+    """
+    EndDateTime: str = Field(..., title='Report Date Time')
+    """
+    End DateTime of the reporting period
+    """
+    NumReport: float | None = Field(None, title='Report Number')
+    """
+    Fluids report number.
+    """
+    Fluid: list[FluidItem] | None = Field(None, title='Fluid')
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore ID')
+    """
+    Reference to the wellbore that is the subject of this fluids report
+    """
+    Name: str | None = Field(None, title='Name')
+    """
+    Name of Fluids Report
+    """
+    ExtensionProperties: dict[str, Any] | None = None