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

osdu_models/masterdata/well_site_structure/v1_0_0.py

@@ -0,0 +1,164 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/well_site_structure/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ...abstract.abstract_facility_vertical_measurement.v1_0_0 import (
+    AbstractFacilityVerticalMeasurement,
+)
+from ...abstract.abstract_spatial_location import v1_1_0
+from ...abstract.abstract_location_uncertainty import v1_0_0
+from typing import Any
+from ...abstract.abstract_remark import v1_0_0 as v1_0_0_1
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+from ...abstract.abstract_facility.v1_1_0 import AbstractFacility
+
+
+class VerticalMeasurement(AbstractFacilityVerticalMeasurement):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    VerticalMeasurementID: str | None = Field(
+        None, examples=['UniqueVerticalMeasurementID']
+    )
+    """
+    The ID for a distinct vertical measurement within the WellSiteStructure VerticalMeasurements array so that it may be referenced by other vertical measurements if necessary.
+    """
+    RigID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Rig:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = Field(None, title='Rig ID')
+    """
+    The optional relationship to the rig, which was used while this vertical measurement was in active use.
+    """
+
+
+class WellSlot(BaseModel):
+    """
+    List of slots for the WellSiteStructure. A slot is a circular opening on a platform wellhead deck or subsea template from which to construct a well.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SlotID: str | None = Field(
+        None, examples=['WellSiteStructure:1100009117-Slot3'], title='Slot Identifier'
+    )
+    """
+    Slot Identifier, may be used by a Well to associate to a Slot
+    """
+    SlotName: str | None = Field(None, examples=['Hay SWD No.4'], title='Slot Name')
+    """
+    Slot Name or Number
+    """
+    SlotLocation: v1_1_0.AbstractSpatialLocation | None = Field(
+        None, title='Slot Location'
+    )
+    """
+    Slot Location
+    """
+    SlotLocalNSOffset: float | None = Field(
+        None, examples=['244 ft'], title='Slot Local N/-S Offset'
+    )
+    """
+    Slot Local North/-South Coordinate offset from WellSiteStructure Centre location
+    """
+    SlotLocalEWOffset: float | None = Field(
+        None, examples=['220 ft'], title='Slot Local E/-W Offset'
+    )
+    """
+    Slot Local East/-West Coordinate offset from WellSiteStructure Centre location
+    """
+    SlotLocationUncertainty: v1_0_0.AbstractLocationUncertainty | None = Field(
+        None, title='Slot Location Uncertainty'
+    )
+    """
+    Slot Local Uncertainty within the Wellsite Structure
+    """
+    Remarks: str | None = Field(None, title='Remarks')
+    """
+    Remarks
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractFacility):
+    """
+    `data` payload for WellSiteStructure 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StructureTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellSiteStructureType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--WellSiteStructureType:Pad:'],
+        title='Structure Type ID',
+    )
+    """
+    The type of Wellsite Structure
+    """
+    LocationUncertainty: v1_0_0.AbstractLocationUncertainty | None = Field(
+        None, title='Location Uncertainty'
+    )
+    """
+    Location Uncertainty for the WellsiteStructure location coordinates
+    """
+    WellSlots: list[WellSlot] | None = Field(None, title='Well Slots')
+    """
+    List of Well Slots and their coordinates
+    """
+    LocationDescription: str | None = Field(None, title='Location Description')
+    """
+    Location Description text
+    """
+    IsFieldCentre: bool | None = Field(None, examples=[True], title='Is Field Centre')
+    """
+    Is the WellSiteStructure origin coordinate for the Field
+    """
+    DrivingInstructions: str | None = Field(None, title='Driving Instructions')
+    """
+    Description on how to drive to the location
+    """
+    VerticalMeasurements: list[VerticalMeasurement] | None = Field(
+        None, title='Vertical Measurements'
+    )
+    """
+    List of all elevations pertaining to the well site structure like, ground level/water depth, default rig elevation, mud line elevation, etc.
+    """
+    DefaultVerticalMeasurementID: str | None = Field(
+        None,
+        examples=['UniqueVerticalMeasurementID'],
+        title='Default Vertical Measurement ID',
+    )
+    """
+    The default datum reference point, or zero depth point, used to determine other points vertically in a well.  References an entry in the VerticalMeasurements array.
+    """
+    DefaultVerticalCRSID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CoordinateReferenceSystem:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--CoordinateReferenceSystem:Vertical:EPSG::8050:'
+        ],
+        title='Default Vertical CRS ID',
+    )
+    """
+    The default vertical coordinate reference system used in the vertical measurements for a well or wellbore if absent from input vertical measurements and there is no other recourse for obtaining a valid CRS.
+    """
+    SlotSize: float | None = Field(None, examples=['30 in'], title='Slot Size')
+    """
+    Diameter or Radius of the Slot
+    """
+    Remarks: list[v1_0_0_1.AbstractRemark] | None = Field(None, title='Remarks')
+    """
+    Free text remarks
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/wellbore/__init__.py

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

osdu_models/masterdata/wellbore/v1_0_0.py

@@ -0,0 +1,105 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/wellbore/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, constr
+from ...abstract.abstract_facility_vertical_measurement.v1_0_0 import (
+    AbstractFacilityVerticalMeasurement,
+)
+from typing import Any
+from ...abstract.abstract_wellbore_drilling_reason import v1_0_0
+from ...abstract.abstract_spatial_location import v1_0_0 as v1_0_0_1
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_0_0 import AbstractMaster
+from ...abstract.abstract_facility.v1_0_0 import AbstractFacility
+
+
+class VerticalMeasurement(AbstractFacilityVerticalMeasurement):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    VerticalMeasurementID: str | None = None
+    """
+    The ID for a distinct vertical measurement within the Wellbore VerticalMeasurements array so that it may be referenced by other vertical measurements if necessary.
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractFacility):
+    """
+    `data` payload for Wellbore 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Well:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = None
+    SequenceNumber: int | None = None
+    """
+    A number that indicates the order in which wellbores were drilled.
+    """
+    VerticalMeasurements: list[VerticalMeasurement] | None = None
+    """
+    List of all depths and elevations pertaining to the wellbore, like, plug back measured depth, total measured depth, KB elevation
+    """
+    DrillingReasons: list[v1_0_0.AbstractWellboreDrillingReason] | None = None
+    """
+    The history of drilling reasons of the wellbore.
+    """
+    KickOffWellbore: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    This is a pointer to the parent wellbore. The wellbore that starts from top has no parent.
+    """
+    TrajectoryTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellboreTrajectoryType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Describes the predominant shapes the wellbore path can follow if deviated from vertical. Sample Values: Horizontal, Vertical, Directional.
+    """
+    DefinitiveTrajectoryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellboreTrajectory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    SRN of Wellbore Trajectory which is considered the authoritative or preferred version.
+    """
+    TargetFormation: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-GeologicalFormation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The Formation of interest for which the Wellbore is drilled to interact with. The Wellbore may terminate in a lower formation if the requirement is to drill through the entirety of the target formation, therefore this is not necessarily the Formation at TD.
+    """
+    PrimaryMaterialID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-MaterialType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The primary material injected/produced from the wellbore.
+    """
+    DefaultVerticalMeasurementID: str | None = None
+    """
+    The default datum reference point, or zero depth point, used to determine other points vertically in a wellbore.  References an entry in the Vertical Measurements array of this wellbore.
+    """
+    ProjectedBottomHoleLocation: v1_0_0_1.AbstractSpatialLocation | None = None
+    """
+    The bottom hole location of the wellbore denoted by a projected horizontal coordinate reference system (Horizontal CRS), such a UTM zone. 'Projected' in this property does not mean 'planned' or 'projected-to-bit'. If both GeographicBottomHoleLocation and ProjectedBottomHoleLocation properties are populated on this wellbore, they must identify the same point, just in different CRSs.
+    """
+    GeographicBottomHoleLocation: v1_0_0_1.AbstractSpatialLocation | None = None
+    """
+    The bottom hole location of the wellbore denoted by a specified geographic horizontal coordinate reference system (Horizontal CRS), such as WGS84, NAD27, or ED50. If both GeographicBottomHoleLocation and ProjectedBottomHoleLocation properties are populated on this wellbore, they must identify the same point, just in different CRSs.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/wellbore/v1_1_0.py

@@ -0,0 +1,264 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/wellbore/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ...abstract.abstract_facility_vertical_measurement.v1_0_0 import (
+    AbstractFacilityVerticalMeasurement,
+)
+from typing import Any
+from ...abstract.abstract_wellbore_drilling_reason import v1_0_0
+from ...abstract.abstract_spatial_location import v1_1_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_1_0 import AbstractMaster
+from ...abstract.abstract_facility.v1_0_0 import AbstractFacility
+
+
+class VerticalMeasurement(AbstractFacilityVerticalMeasurement):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    VerticalMeasurementID: str | None = None
+    """
+    The ID for a distinct vertical measurement within the Wellbore VerticalMeasurements array so that it may be referenced by other vertical measurements if necessary.
+    """
+    RigID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Rig:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = Field(None, title='Rig ID')
+    """
+    The relationship to the rig, which was used while this vertical measurement was in active use.
+    """
+
+
+class HistoricalInterest(BaseModel):
+    """
+    A 'well interest' at some time period as defined by effective and termination date.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    InterestTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellInterestType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Interest Type ID')
+    """
+    Business Interest [Well Interest Type] describes whether a company currently considers a wellbore or its data to be a real or planned asset, and if so, the nature of and motivation for that company's interest.
+    """
+    EffectiveDateTime: str | None = Field(None, title='Effective Date Time')
+    """
+    The date and time at which the well interest type becomes effective.
+    """
+    TerminationDateTime: str | None = Field(None, title='Termination Date Time')
+    """
+    The date and time at which the well interest type is no longer in effect.
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractFacility):
+    """
+    `data` payload for Wellbore 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Well:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = None
+    SequenceNumber: int | None = None
+    """
+    A number that indicates the order in which wellbores were drilled.
+    """
+    VerticalMeasurements: list[VerticalMeasurement] | None = None
+    """
+    List of all depths and elevations pertaining to the wellbore, like, plug back measured depth, total measured depth, KB elevation
+    """
+    DrillingReasons: list[v1_0_0.AbstractWellboreDrillingReason] | None = None
+    """
+    The history of drilling reasons of the wellbore.
+    """
+    KickOffWellbore: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    This is a pointer to the parent wellbore. The wellbore that starts from top has no parent.
+    """
+    TrajectoryTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellboreTrajectoryType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Describes the predominant shapes the wellbore path can follow if deviated from vertical. Sample Values: Horizontal, Vertical, Directional.
+    """
+    DefinitiveTrajectoryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellboreTrajectory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    SRN of Wellbore Trajectory which is considered the authoritative or preferred version.
+    """
+    TargetFormation: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-GeologicalFormation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The Formation of interest for which the Wellbore is drilled to interact with. The Wellbore may terminate in a lower formation if the requirement is to drill through the entirety of the target formation, therefore this is not necessarily the Formation at TD.
+    """
+    PrimaryMaterialID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-MaterialType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    DEPRECATED: Please use PrimaryProductTypeID instead, which refers to the narrower WellProductType. The primary material injected/produced from the wellbore.
+    """
+    DefaultVerticalMeasurementID: str | None = None
+    """
+    The default datum reference point, or zero depth point, used to determine other points vertically in a wellbore.  References an entry in the Vertical Measurements array of this wellbore.
+    """
+    ProjectedBottomHoleLocation: v1_1_0.AbstractSpatialLocation | None = None
+    """
+    The bottom hole location of the wellbore denoted by a projected horizontal coordinate reference system (Horizontal CRS), such a UTM zone. 'Projected' in this property does not mean 'planned' or 'projected-to-bit'. If both GeographicBottomHoleLocation and ProjectedBottomHoleLocation properties are populated on this wellbore, they must identify the same point, just in different CRSs.
+    """
+    GeographicBottomHoleLocation: v1_1_0.AbstractSpatialLocation | None = None
+    """
+    The bottom hole location of the wellbore denoted by a specified geographic horizontal coordinate reference system (Horizontal CRS), such as WGS84, NAD27, or ED50. If both GeographicBottomHoleLocation and ProjectedBottomHoleLocation properties are populated on this wellbore, they must identify the same point, just in different CRSs.
+    """
+    BusinessIntentionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellBusinessIntention:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Business Intention [Well Business Intention] is the general purpose for which resources are approved for drilling a new well or subsequent wellbore(s).
+    """
+    RoleID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-WellRole:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    Role [Well Role] is the current purpose, whether planned or actual. If there are multiple Roles among a wellbore's components, the well may be assigned the facet value with the highest significance. The value of Role may change over the Life Cycle.
+    """
+    InterestTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellInterestType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Business Interest [Well Interest Type] describes whether a company currently considers a wellbore entity or its data to be a real or planned asset, and if so, the nature of and motivation for that company's interest.
+    """
+    HistoricalInterests: list[HistoricalInterest] | None = None
+    """
+    The list of past and present interests associated with the time period they were/are valid
+    """
+    WasBusinessInterestFinancialOperated: bool | None = None
+    """
+    Identifies, for the purpose of current use, if the Business Interest [Well Interest Type] for this Well has ever been FinancialOperated in the past.
+    """
+    WasBusinessInterestFinancialNonOperated: bool | None = None
+    """
+    Identifies, for the purpose of current use, if the Business Interest [Well Interest Type] for this Well has ever been FinancialNonOperated in the past.
+    """
+    WasBusinessInterestObligatory: bool | None = None
+    """
+    Identifies, for the purpose of current use, if the Business Interest [Well Interest Type] for this Well has ever been Obligatory in the past.
+    """
+    WasBusinessInterestTechnical: bool | None = None
+    """
+    Identifies, for the purpose of current use, if the Business Interest [Well Interest Type] for this Well has ever been Technical in the past.
+    """
+    WellboreTrajectoryTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellboreTrajectoryType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Profile Type [Wellbore Trajectory Type] is the general geometry of the wellbore relative to the vertical plane. The specific criteria for Profile Type may vary by operator or regulator. The facet value may change if conditions encountered during drilling are not what was planned or permitted.
+    """
+    PrimaryProductTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellProductType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Product Type [Well Product Type] is the physical product(s) that can be attributed to any wellbore component. A Primary Product Significance identifies the Product Type that is most significant.
+    """
+    SecondaryProductTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellProductType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Product Type [Well Product Type] is the physical product(s) that can be attributed to any wellbore component. A Secondary Product Significance identifies the Product Type that is the second most significant.
+    """
+    TertiaryProductTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellProductType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Product Type [Well Product Type] is the physical product(s) that can be attributed to any wellbore component. A Tertiary Product Significance identifies the Product Type that is the third most significant.
+    """
+    ShowProductTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellProductType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Product Type [Well Product Type] is the physical product(s) that can be attributed to any wellbore component. A Show Product Significance identifies a Product Type present in non-commercial quantity.
+    """
+    ConditionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellCondition:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Condition [Well Condition] is the operational state of a wellbore component relative to the Role [Well Role].
+    """
+    FluidDirectionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellFluidDirection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Fluid Direction [Well Fluid Direction] is the flow direction of the wellhead stream. The facet value can change over the life of the wellbore.
+    """
+    OutcomeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellBusinessIntentionOutcome:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Outcome [Well Drilling Outcome] is the result of attempting to accomplish the Business Intention [Well Business Intention].
+    """
+    StatusSummaryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellStatusSummary:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Identifies the status of a wellbore component in a way that may combine and-or summarize concepts found in other status facets. For example, a Wellbore Status Summary of Gas Injector Shut-in, which contains commonly desired business information, combines concepts from Product Type, Fluid Direction, and Condition.
+    """
+    ExtensionProperties: dict[str, Any] | None = None