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

osdu_models/workproductcomponent/wellbore_trajectory/v1_1_0.py

@@ -0,0 +1,200 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/wellbore_trajectory/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_facility_vertical_measurement import v1_0_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_0_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_0_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class AvailableTrajectoryStationProperty(BaseModel):
+    """
+    A set of properties describing a trajectory station property which is available for this instance of a WellboreTrajectory.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    TrajectoryStationPropertyTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TrajectoryStationPropertyType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'partition-id:reference-data--TrajectoryStationPropertyType:AzimuthTN:'
+        ],
+        title='Trajectory Station Property Type ID',
+    )
+    """
+    The reference to a trajectory station property type - or if interpreted as channels, the curve or channel name type, identifying e.g. MD, Inclination, Azimuth. This is a relationship to a reference-data--TrajectoryStationPropertyType record id.
+    """
+    StationPropertyUnitID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['partition-id:reference-data--UnitOfMeasure:dega:'],
+        title='Station Property Unit ID',
+    )
+    """
+    Unit of Measure for the station properties of type TrajectoryStationPropertyType.
+    """
+    Name: str | None = Field(None, examples=['AzimuthTN'], title='Name')
+    """
+    The name of the curve (e.g. column in a CSV document) as originally found. If absent The name of the TrajectoryStationPropertyType is intended to be used.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for WellboreTrajectory 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Service Company')
+    """
+    Name of the Survey Company.
+    """
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore')
+    """
+    A unique name, code or number designated to the Wellbore.
+    """
+    TopDepthMeasuredDepth: float = Field(..., title='Survey Top Measured Depth')
+    """
+    Measured depth in wellbore where the directional survey starts. This should equal the minimum station measured depth for this directional survey, regardless of whether the surveyed station represents an actual surveyed MD or not.
+    """
+    AzimuthReferenceType: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-AzimuthReferenceType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Azimuth Reference Type')
+    """
+    The North reference of the trajectory used to define the azimuth angular measurement values. For example, True North, Grid North, Magnetic North.
+    """
+    CalculationMethodType: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CalculationMethodType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Calculation Method Type')
+    """
+    Calculation Method Type used to compute the TVD, X OFFSET, Y OFFSET and DOG LEG SEVERITY values for this Directional Survey. For example, Radius of Curvature, Minimum Curvature, Balanced Tangential, etc.
+    """
+    ProjectedCRSID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CoordinateReferenceSystem:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--CoordinateReferenceSystem:Projected:EPSG::32615:'
+        ],
+        title='Projected Coordinate Reference System ID',
+    )
+    """
+    Coordinate Reference System defining the Projection of the station EASTING and NORTHING values. If  type is "Grid North" and EASTING and NORTHING attributes are stored, clearly identifying their projection is required.
+    """
+    ActiveIndicator: bool | None = Field(None, title='Active Survey Indicator')
+    """
+    A flag indicating if the survey is currently active or valid within his lifecycle stage, not necessarily the definitive survey.
+    """
+    SurveyType: str | None = Field(None, title='Directional Survey Type')
+    """
+    The type of this directional survey.  For example a "Directional Survey" where MD, Inclination and Azimuth are all measured or a "Position Log" where Inclination and Azimuth are both null and only MD, TVD and X/Y Offsets are available) - or "Full Survey" where everything is fully filled-up, depth-inclination-azimuth.
+    """
+    AcquisitionDate: str | None = Field(None, title='Effective Date')
+    """
+    The date that the survey data was acquired on the field.
+    """
+    GeographicCRSID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CoordinateReferenceSystem:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--CoordinateReferenceSystem:Geographic2D:EPSG::4326:'
+        ],
+        title='Geographic Coordinate Reference System',
+    )
+    """
+    Coordinate Reference System defining the Geodetic Datum of the station LATITUDE and LONGITUDE values. If LATITUDE and LONGITUDE attributes are stored, clearly identifying their Datum is required.
+    """
+    AcquisitionRemark: str | None = Field(None, title='Survey Remark')
+    """
+    Remarks related to acquisition context which is not the same as Description which is a summary of the work-product-component.
+    """
+    SurveyReferenceIdentifier: str | None = Field(
+        None, title='Survey Reference Identifier'
+    )
+    """
+    Unique or Distinctive Survey Reference Number, Job Number, File Number, Identifier, Label, Name, etc. as indicated on a directional survey report, file, etc.  Use this attribute to allow correlation of the data in this Directional Survey back to the original source document, file, etc.
+    """
+    SurveyToolTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SurveyToolType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Type of the Survey Tool')
+    """
+    The type of tool or equipment used to acquire this Directional Survey.  For example, gyroscopic, magnetic, MWD, TOTCO, acid bottle, etc. Follow OWSG reference data and support the ISCWSA survey tool definitions.
+    """
+    SurveyVersion: str | None = Field(None, title='Survey Version')
+    """
+    The version of the wellbore survey deliverable received from the service provider - as given by this provider
+    """
+    ExtrapolatedMeasuredDepth: float | None = Field(
+        None, title='Extrapolated Measured Depth'
+    )
+    """
+    The measured depth to which the survey segment was extrapolated.
+    """
+    BaseDepthMeasuredDepth: float = Field(..., title='Survey Base Measured Depth')
+    """
+    Measured depth within the wellbore of the LAST surveyed station with recorded data.  If a stored survey has been extrapolated to a deeper depth than the last surveyed station then that is the extrapolated measured depth and not the survey base depth.
+    """
+    TieMeasuredDepth: float | None = Field(None, title='Tie Measured Depth')
+    """
+    Tie-point depth measured along the wellbore from the measurement reference datum to the survey station - where tie point is the place on the originating survey where the current survey intersect it.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement
+    """
+    References an entry in the Vertical Measurement array for the Wellbore identified by WellboreID, which defines the vertical reference datum for all survey station measured depths.
+    """
+    AvailableTrajectoryStationProperties: (
+        list[AvailableTrajectoryStationProperty] | None
+    ) = Field(None, title='Available Trajectory Station Properties')
+    """
+    The array of TrajectoryStationProperty definitions describing the available properties for this instance of WellboreTrajectory.
+    """
+    AppliedOperations: list[str] | None = Field(None, title='Applied Operations')
+    """
+    The audit trail of operations applied to the station coordinates from the original state to the current state. The list may contain operations applied prior to ingestion as well as the operations applied to produce the Wgs84Coordinates. The text elements refer to ESRI style CRS and Transformation names, which may have to be translated to EPSG standard names.
+    """
+    CompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Company ID')
+    """
+    The relationship to company who engaged the service company (ServiceCompanyID) to perform the surveying.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/wellbore_trajectory/v1_2_0.py

@@ -0,0 +1,276 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/wellbore_trajectory/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_facility_vertical_measurement import v1_0_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_1_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class AvailableTrajectoryStationProperty(BaseModel):
+    """
+    A set of properties describing a trajectory station property which is available for this instance of a WellboreTrajectory.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    TrajectoryStationPropertyTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TrajectoryStationPropertyType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'partition-id:reference-data--TrajectoryStationPropertyType:AzimuthTN:'
+        ],
+        title='Trajectory Station Property Type ID',
+    )
+    """
+    The reference to a trajectory station property type - or if interpreted as channels, the curve or channel name type, identifying e.g. MD, Inclination, Azimuth. This is a relationship to a reference-data--TrajectoryStationPropertyType record id.
+    """
+    StationPropertyUnitID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['partition-id:reference-data--UnitOfMeasure:dega:'],
+        title='Station Property Unit ID',
+    )
+    """
+    Unit of Measure for the station properties of type TrajectoryStationPropertyType.
+    """
+    Name: str | None = Field(None, examples=['AzimuthTN'], title='Name')
+    """
+    The name of the curve (e.g. column in a CSV document) as originally found. If absent The name of the TrajectoryStationPropertyType is intended to be used.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for WellboreTrajectory 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Service Company')
+    """
+    Name of the Survey Company.
+    """
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore')
+    """
+    A unique name, code or number designated to the Wellbore.
+    """
+    TopDepthMeasuredDepth: float = Field(
+        ..., examples=[0], title='Survey Top Measured Depth'
+    )
+    """
+    Measured depth in wellbore where the directional survey starts. This should equal the minimum station measured depth for this directional survey, regardless of whether the surveyed station represents an actual surveyed MD or not.
+    """
+    AzimuthReferenceType: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-AzimuthReferenceType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Azimuth Reference Type')
+    """
+    The North reference of the trajectory used to define the azimuth angular measurement values. For example, True North, Grid North, Magnetic North.
+    """
+    CalculationMethodType: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CalculationMethodType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Calculation Method Type')
+    """
+    Calculation Method Type used to compute the TVD, X OFFSET, Y OFFSET and DOG LEG SEVERITY values for this Directional Survey. For example, Radius of Curvature, Minimum Curvature, Balanced Tangential, etc.
+    """
+    ProjectedCRSID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CoordinateReferenceSystem:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--CoordinateReferenceSystem:Projected:EPSG::32615:'
+        ],
+        title='Projected Coordinate Reference System ID',
+    )
+    """
+    Coordinate Reference System defining the Projection of the station EASTING and NORTHING values. If  type is "Grid North" and EASTING and NORTHING attributes are stored, clearly identifying their projection is required.
+    """
+    ActiveIndicator: bool | None = Field(
+        None, examples=[False], title='Active Survey Indicator'
+    )
+    """
+    A flag indicating if the survey is currently active or valid within his lifecycle stage, not necessarily the definitive survey.
+    """
+    SurveyType: str | None = Field(
+        None, examples=['Directional survey'], title='Directional Survey Type'
+    )
+    """
+    The type of this directional survey.  For example a "Directional Survey" where MD, Inclination and Azimuth are all measured or a "Position Log" where Inclination and Azimuth are both null and only MD, TVD and X/Y Offsets are available) - or "Full Survey" where everything is fully filled-up, depth-inclination-azimuth.
+    """
+    AcquisitionDate: str | None = Field(
+        None, examples=['2023-03-05T00:00:00+0000'], title='Effective Date'
+    )
+    """
+    The date that the survey data was acquired on the field.
+    """
+    GeographicCRSID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CoordinateReferenceSystem:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--CoordinateReferenceSystem:Geographic2D:EPSG::4326:'
+        ],
+        title='Geographic Coordinate Reference System',
+    )
+    """
+    Coordinate Reference System defining the Geodetic Datum of the station LATITUDE and LONGITUDE values. If LATITUDE and LONGITUDE attributes are stored, clearly identifying their Datum is required.
+    """
+    AcquisitionRemark: str | None = Field(
+        None, examples=['Vendor final survey'], title='Survey Remark'
+    )
+    """
+    Remarks related to acquisition context which is not the same as Description which is a summary of the work-product-component.
+    """
+    SurveyReferenceIdentifier: str | None = Field(
+        None, examples=['1234567'], title='Survey Reference Identifier'
+    )
+    """
+    Unique or Distinctive Survey Reference Number, Job Number, File Number, Identifier, Label, Name, etc. as indicated on a directional survey report, file, etc.  Use this attribute to allow correlation of the data in this Directional Survey back to the original source document, file, etc.
+    """
+    SurveyToolTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SurveyToolType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Type of the Survey Tool')
+    """
+    The type of tool or equipment used to acquire this Directional Survey.  For example, gyroscopic, magnetic, MWD, TOTCO, acid bottle, etc. Follow OWSG reference data and support the ISCWSA survey tool definitions.
+    """
+    SurveyVersion: str | None = Field(None, examples=['1'], title='Survey Version')
+    """
+    The version of the wellbore survey deliverable received from the service provider - as given by this provider
+    """
+    ExtrapolatedMeasuredDepth: float | None = Field(
+        None, examples=[2790], title='Extrapolated Measured Depth'
+    )
+    """
+    The measured depth to which the survey segment was extrapolated.
+    """
+    ExtrapolatedMeasuredDepthRemark: str | None = Field(
+        None,
+        examples=['TD@2790m bDFE@32.5m'],
+        title='Extrapolated Measured Depth Remark',
+    )
+    """
+    Comment/Annotation made to WellboreTrajectory describing the projected MD Base or Bottomhole, e.g., listing the Depth Reference Name, Elevation and Bottomhole MD. This can be used for comparison against the survey at a later date.
+    """
+    BaseDepthMeasuredDepth: float = Field(
+        ..., examples=[2790], title='Survey Base Measured Depth'
+    )
+    """
+    Measured depth within the wellbore of the LAST surveyed station with recorded data.  If a stored survey has been extrapolated to a deeper depth than the last surveyed station then that is the extrapolated measured depth and not the survey base depth.
+    """
+    TieMeasuredDepth: float | None = Field(
+        None, examples=[0], title='Tie Measured Depth'
+    )
+    """
+    Tie-point depth measured along the wellbore from the measurement reference datum to the survey station - where tie point is the place on the originating survey where the current survey intersect it.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement = Field(
+        ..., title='Vertical Measurement'
+    )
+    """
+    References an entry in the Vertical Measurement array for the Wellbore identified by WellboreID, which defines the vertical reference datum for all survey station measured depths.
+    """
+    AvailableTrajectoryStationProperties: (
+        list[AvailableTrajectoryStationProperty] | None
+    ) = Field(None, title='Available Trajectory Station Properties')
+    """
+    The array of TrajectoryStationProperty definitions describing the available properties for this instance of WellboreTrajectory.
+    """
+    AppliedOperations: list[str] | None = Field(None, title='Applied Operations')
+    """
+    The audit trail of operations applied to the station coordinates from the original state to the current state. The list may contain operations applied prior to ingestion as well as the operations applied to produce the Wgs84Coordinates. The text elements refer to ESRI style CRS and Transformation names, which may have to be translated to EPSG standard names.
+    """
+    AppliedOperationsDateTime: str | None = Field(
+        None,
+        examples=['2023-03-15T00:00:00+0000'],
+        title='Applied Operations Date Time',
+    )
+    """
+    Date/time when the directional Survey QA/QC was performed.
+    """
+    AppliedOperationsUser: str | None = Field(
+        None, examples=['Joe Bloggs'], title='Applied Operations User'
+    )
+    """
+    Name of Borehole Survey specialist who performed the QA/QC work
+    """
+    AppliedOperationsRemarks: str | None = Field(
+        None,
+        examples=[
+            'Final survey SSP corrected. Mag corrections within tolerance. Meets QA/QC criteria.'
+        ],
+        title='Applied Operations Remarks',
+    )
+    """
+    Any comments captured by the Borehole Survey specialist when performing the QA/QC work.
+    """
+    StartDateTime: str | None = Field(
+        None, examples=['2023-01-15T00:00:00+0000'], title='Start DateTime'
+    )
+    """
+    The date and time capturing when the first survey station was measured.
+    """
+    EndDateTime: str | None = Field(
+        None, examples=['2023-02-27T00:00:00+0000'], title='End DateTime'
+    )
+    """
+    The date and time capturing when the last survey station was measured.
+    """
+    CompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Company ID')
+    """
+    The relationship to company who engaged the service company (ServiceCompanyID) to perform the surveying.
+    """
+    SurfaceGridConvergence: float | None = Field(
+        None, examples=[0.0057596], title='Grid Convergence at Surface'
+    )
+    """
+    The Grid Convergence angle computed at the surface position, which was used for the WellboreTrajectory True North to Grid North Azimuths corrections. Only populated for projected CRSs. Recommended sign convention: Gauss-Bomford.
+    """
+    SurfaceScaleFactor: float | None = Field(
+        None, examples=[1.003], title='Scale Factor at Surface'
+    )
+    """
+    The Scale Factor computed for the wellbore's surface position used for calculating projected Map Coordinates from survey data in WellboreTrajectory.
+    """
+    Tortuosity: float | None = Field(None, examples=[0.00019], title='Tortuosity')
+    """
+    The calculated average Tortuosity for the WellboreTrajectory.
+    """
+    ExtensionProperties: dict[str, Any] | None = None