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

osdu_models/workproductcomponent/soil_gas_monitoring/v1_1_0.py

@@ -0,0 +1,119 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/soil_gas_monitoring/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_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class AcquisitionDateRange(BaseModel):
+    """
+    Defines the start and end date of data acquisition with a remark
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StartDate: str | None = Field(None, examples=['2022-12-12'], title='Start Date')
+    """
+    Start date of the data acquisition
+    """
+    EndDate: str | None = Field(None, examples=['2022-12-12'], title='End Date')
+    """
+    End date of the data acquisition
+    """
+    Remark: str | None = Field(
+        None, examples=['Started and finished on the same day'], title='Remark'
+    )
+    """
+    Optional free text description
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for SoilGasMonitoring 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ReferenceIdentifier: str | None = Field(
+        None, examples=['XA1234'], title='Reference Identifier'
+    )
+    """
+    Unique or Distinctive Reference Number, Job Number, File Number, Identifier, Label, Name, etc. as indicated on a report, file, etc
+    """
+    GeologicUnitInterpretationIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:work-product-component\-\-GeologicUnitOccurrenceInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='GeologicUnitInterpretationIDs')
+    """
+    An array of StratigraphicUnitInterpretationIds associated to this interval of interest. Typically populated in an enrichment step using information from FormationName
+    """
+    FormationName: str | None = Field(
+        None, examples=['Jurassic'], title='Formation Name'
+    )
+    """
+    Free text formation name. Use GeologicUnitInterpretationIDs, StratigraphicUnitInterpretations wherever possible
+    """
+    WellboreIDs: (
+        list[
+            constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        ]
+        | None
+    ) = Field(None, title='Wellbore IDs')
+    """
+    One or more wellbores associated with the sample/test location. Leave empty if the sample/test location is NOT a wellbore. General locations will inherited WPC spatial area or spatial point
+    """
+    AnalysisMethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SoilGasAnalysisType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Analysis Method ID')
+    """
+    Analytical method used by laboratory to complete analysis testing
+    """
+    DepthTag: str | None = Field(None, title='Depth Tag')
+    """
+    Free text string to classify different depth zones
+    """
+    ApplicationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SoilGasApplication:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='ApplicationID')
+    """
+    What the application or situational setting that the data is being used for or acquired within, for example; carbon capture & storage, depleted oil or gas field, water reservoir, producing oil or gas, fracking, etc
+    """
+    SamplingMethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SoilGasSamplingMethod:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Sampling Method ID')
+    """
+    Methodology for how the sample was acquired
+    """
+    IsBaseline: bool | None = Field(None, title='Is Baseline')
+    """
+    Is this the baseline measurements
+    """
+    AcquisitionDateRanges: list[AcquisitionDateRange] | None = Field(
+        None, title='AcquisitionDateRanges'
+    )
+    """
+    An array which lists the start and end date of the acquisition data
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/stimulation_job/__init__.py

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

osdu_models/workproductcomponent/stimulation_job/v1_0_0.py

@@ -0,0 +1,285 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/stimulation_job/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ...abstract.abstract_fluid_additive import v1_0_0
+from ...abstract.abstract_proppant_agent import v1_0_0 as v1_0_0_1
+from typing import Any
+from ...abstract.abstract_stim_material_quantity import v1_0_0 as v1_0_0_2
+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 MaterialCatalogItem(BaseModel):
+    """
+    Object that defines the additives and proppants on location and used in the stimulation job.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Additives: list[v1_0_0.FluidAdditive] | None = Field(None, title='Additives')
+    """
+    Define the additives on location and used in the stimulation job.
+    """
+    ProppantAgents: list[v1_0_0_1.ProppantAgent] | None = Field(
+        None, title='Proppant Agents'
+    )
+    """
+    Define the proppants on location and used in the stimulation job.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for StimulationJob 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    JobTypeID: str = Field(
+        ..., examples=['Plug & Perf Chemical Frac'], title='Job Type ID'
+    )
+    """
+    Identifier of the type of well stimulation job
+    """
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=['namespace:master-data--Wellbore:11000091175501:'],
+        title='Wellbore ID',
+    )
+    """
+    A link to the wellbore in which the stimulation took place.
+    """
+    WellActivityID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-WellActivity:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--WellActivity:110000911755.COM:'],
+        title='Well Activity ID',
+    )
+    """
+    A link to the well activity to which this stimulation job is associated.
+    """
+    JobStartDateTime: str | None = Field(
+        None, examples=['2020-05-01T07:00:00+0000'], title='Job Start Date Time'
+    )
+    """
+    Start date and time of the stimulation job.
+    """
+    JobEndDateTime: str | None = Field(
+        None, examples=['2020-05-04T21:00:00+0000'], title='Job End Date Time'
+    )
+    """
+    Ending date and time of the stimulation job.
+    """
+    ArrivalDateTime: str | None = Field(
+        None, examples=['2020-04-29T12:00:00+0000'], title='Arrival Date Time'
+    )
+    """
+    Date and time at which the stimulation contractor arrives on location.
+    """
+    MaterialCatalog: list[MaterialCatalogItem] | None = Field(
+        None, title='Material Catalog'
+    )
+    """
+    Object that contains the Additives and Proppants on location and used in the stimulation job.
+    """
+    BHStaticTemperature: float | None = Field(
+        None, examples=['178 degF'], title='BH Static Temperature'
+    )
+    """
+    Bottomhole static temperature for the job (BHST)
+    """
+    BHTreatingTemperature: float | None = Field(
+        None, examples=['155 degF'], title='BH Treating Temperature'
+    )
+    """
+    Expected or calculated bottomhole treating temperature for the job.
+    """
+    ContractorID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:master-data--Organisation:SLB:'],
+        title='Contractor ID',
+    )
+    """
+    Identifier of service company performing the stimulation job.
+    """
+    FlowBackPressure: float | None = Field(
+        None, examples=['2358 psi'], title='Flow Back Pressure'
+    )
+    """
+    Pressure recorded on fluid returning to surface.
+    """
+    FlowBackRate: float | None = Field(
+        None, examples=['3637 ft3/d'], title='Flow Back Rate'
+    )
+    """
+    Flow rate recorded on fluid returning to surface.
+    """
+    FlowBackVolume: float | None = Field(None, title='Flow Back Volume')
+    """
+    Volume recorded on fluid returning to surface.
+    """
+    FluidEfficiency: float | None = Field(
+        None, examples=[0.98], title='Fluid Efficiency'
+    )
+    """
+    Volume ratio of fluid in the fracture at the end of pumping.
+    """
+    FluidPumpingRateMax: float | None = Field(
+        None, examples=['53 bbl/min'], title='Fluid Pumping Rate Max'
+    )
+    """
+    Maximum job fluid pumping rate encountered during treatment of all stages.
+    """
+    HhpOrdered: float | None = Field(None, examples=['200000 hp'], title='HHP Ordered')
+    """
+    Hydraulic horsepower ordered for the stimulation job.
+    """
+    HhpUsed: float | None = Field(None, examples=['157535 hp'], title='HHP Used')
+    """
+    Hydraulic horsepower actually used for the stimulation job.
+    """
+    JobPressureMax: float | None = Field(
+        None, examples=['9421.65 psi'], title='Job Pressure Max'
+    )
+    """
+    Maximum pressure encountered during the job.
+    """
+    JobPressureAvg: float | None = Field(
+        None, examples=['7505.76 psi'], title='Job Pressure Average'
+    )
+    """
+    Average pressure encountered during treatment of all stages.
+    """
+    JobTotalVolume: float | None = Field(
+        None, examples=['4228069 gal[US]'], title='Job Total Volume'
+    )
+    """
+    Total volume pumped for all stages.
+    """
+    OperatorRepresentative: str | None = Field(
+        None, examples=['Joe Bloggs'], title='Operator Representative'
+    )
+    """
+    Name of Operator Representative/Supervisor
+    """
+    OperatorRepresentativeRemarks: str | None = Field(
+        None,
+        examples=[
+            'Well is ready for CT ops once Frac ops completed and stimulation services are R/O'
+        ],
+        title='Operator Representative Remarks',
+    )
+    """
+    Operator Representative Remarks
+    """
+    PIDXCommodityCodeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-StimPIDXCommodityCode:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--StimPIDXCommodityCode:71131000:'],
+        title='PIDX Commodity Code ID',
+    )
+    """
+    Petroleum Industry Data Exchange (PIDX) UNSPSC (Segment 71) commodity code from the oil and gas extraction and production enhancement services family.
+    """
+    ProppantInFormationTotal: float | None = Field(
+        None, examples=['6394508 lbm'], title='Proppant In Formation Total'
+    )
+    """
+    The total mass of proppant placed in the formation for the entire stim job.
+    """
+    ProppantUsedTotal: float | None = Field(
+        None, examples=['6394508 lbm'], title='Proppant Used Total'
+    )
+    """
+    The total mass of proppant used (pumped) for the entire stim job.
+    """
+    PumpTimeTotal: float | None = Field(None, title='Pump Time Total')
+    """
+    The total pumping time/duration for the entire stim job.
+    """
+    StageCount: int | None = Field(None, examples=[27], title='Stage Count')
+    """
+    Integer Number of stages treated during the stimulation job.
+    """
+    Supervisor: str | None = Field(
+        None, examples=['Marcel Schlumberger'], title='Supervisor'
+    )
+    """
+    Name of the service company supervisor.
+    """
+    MaterialUsed: list[v1_0_0_2.AbstractStimMaterialQuantity] | None = Field(
+        None, title='Material Used'
+    )
+    """
+    Total amount of materials used for the Stimulation Job.
+    """
+    WaterSource: str | None = Field(
+        None, examples=['Sunshine Municipal'], title='Water Source'
+    )
+    """
+    Source for water used during the stim job.
+    """
+    WaterManagementPlanIdentifier: str | None = Field(
+        None, examples=['WMP-AA-BB-CC'], title='Water Management Plan Identifier'
+    )
+    """
+    Water management plan identifier for this stim job.
+    """
+    OpenHoleLength: float | None = Field(
+        None, examples=['7000 ft'], title='Open Hole Length'
+    )
+    """
+    Total length of stimulated interval for this stim job.
+    """
+    PadPercent: float | None = Field(None, examples=[1], title='Pad Percent')
+    """
+    The ratio of proppant placed in formation vs proppant pumped
+    """
+    IsCoiledTubingConveyed: bool | None = Field(
+        None, examples=[False], title='Is Coiled Tubing Conveyed'
+    )
+    """
+    Is the stimulation conveyed via coiled tubing?
+    """
+    CleanTotalVolume: float | None = Field(
+        None, examples=['4100000 gal[US]'], title='Clean Total Volume'
+    )
+    """
+    Total clean volume pumped for all job stages during this stim job.  Clean volume is amount of fluid before proppant is added.
+    """
+    WellLog: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Well Log')
+    """
+    Log(s) associated to the Stim Job e.g. Composite Log(s)
+    """
+    Remarks: str | None = Field(
+        None, examples=['27 Stage Perf & Frac Ops'], title='Remarks'
+    )
+    """
+    General remarks about this Stim Job.
+    """
+    ExtensionProperties: dict[str, Any] | None = None