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

osdu_models/workproductcomponent/well_log/v1_0_0.py

@@ -0,0 +1,231 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/well_log/v1_0_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 LogServiceDateInterval(BaseModel):
+    """
+    An interval built from two nested values : StartDate and EndDate. It applies to the whole log services and may apply to composite logs as [start of the first run job] and [end of the last run job]Log Service Date
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StartDate: str | None = None
+    EndDate: str | None = None
+
+
+class Curve(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    CurveID: str | None = None
+    """
+    The ID of the Well Log Curve
+    """
+    DateStamp: str | None = None
+    """
+    Date curve was created in the database
+    """
+    CurveVersion: str | None = None
+    """
+    The Version of the Log Curve.
+    """
+    CurveQuality: str | None = None
+    """
+    The Quality of the Log Curve.
+    """
+    InterpreterName: str | None = None
+    """
+    The name of person who interpreted this Log Curve.
+    """
+    IsProcessed: bool | None = None
+    """
+    Indicates if the curve has been (pre)processed or if it is a raw recording
+    """
+    NullValue: bool | None = None
+    """
+    Indicates that there is no measurement within the curve
+    """
+    DepthCoding: constr(pattern=r'^REGULAR|DISCRETE$') | None = None
+    """
+    The Coding of the depth.
+    """
+    Interpolate: bool | None = None
+    """
+    Whether curve can be interpolated or not
+    """
+    TopDepth: float | None = None
+    """
+    Top Depth
+    """
+    BaseDepth: float | None = None
+    """
+    Base Depth
+    """
+    DepthUnit: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Unit of Measure for Top and Base depth
+    """
+    CurveUnit: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Unit of Measure for the Log Curve
+    """
+    Mnemonic: str | None = None
+    """
+    The Mnemonic of the Log Curve is the value as received either from Raw Providers or from Internal Processing team 
+    """
+    LogCurveTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-LogCurveType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The SRN of the Log Curve Type - which is the standard mnemonic chosen by the company - OSDU provides an initial list
+    """
+    LogCurveBusinessValueID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-LogCurveBusinessValue:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The SRN of the Log Curve Business Value Type.
+    """
+    LogCurveMainFamilyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-LogCurveMainFamily:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The SRN of the Log Curve Main Family Type - which is the Geological Physical Quantity measured - such as porosity.
+    """
+    LogCurveFamilyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-LogCurveFamily:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The SRN of the Log Curve Family - which is the detailed Geological Physical Quantity Measured - such as neutron porosity
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for WellLog 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    The Wellbore where the Well Log Work Product Component was recorded
+    """
+    WellLogTypeID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-LogType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    Well Log Type short Description such as Raw; Evaluated; Composite;....
+    """
+    TopMeasuredDepth: float | None = Field(None, title='Top Measured Depth')
+    """
+    OSDU Native Top Measured Depth of the Well Log.
+    """
+    BottomMeasuredDepth: float | None = Field(None, title='Bottom Measured Depth')
+    """
+    OSDU Native Bottom Measured Depth of the Well Log.
+    """
+    ServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    Service Company ID
+    """
+    LogSource: str | None = None
+    """
+    OSDU Native Log Source - will be updated for later releases - not to be used yet 
+    """
+    LogActivity: str | None = None
+    """
+    Log Activity, used to describe the type of pass such as Calibration Pass - Main Pass - Repeated Pass
+    """
+    LogRun: str | None = None
+    """
+    Log Run - describe the run of the log - can be a number, but may be also a alphanumeric description such as a version name
+    """
+    LogVersion: str | None = None
+    """
+    Log Version
+    """
+    LoggingService: str | None = None
+    """
+    Logging Service - mainly a short concatenation of the names of the tools
+    """
+    LogServiceDateInterval_1: LogServiceDateInterval | None = Field(
+        None, alias='LogServiceDateInterval'
+    )
+    """
+    An interval built from two nested values : StartDate and EndDate. It applies to the whole log services and may apply to composite logs as [start of the first run job] and [end of the last run job]Log Service Date
+    """
+    ToolStringDescription: str | None = None
+    """
+    Tool String Description - a long concatenation of the tools used for logging services such as GammaRay+NeutronPorosity
+    """
+    LoggingDirection: str | None = None
+    """
+    Specifies whether curves were collected downward or upward
+    """
+    PassNumber: int | None = None
+    """
+    Indicates if the Pass is the Main one (1) or a repeated one - and it's level repetition
+    """
+    ActivityType: str | None = None
+    """
+    General method or circumstance of logging - MWD, completion, ...
+    """
+    DrillingFluidProperty: str | None = None
+    """
+    Type of mud at time of logging (oil, water based,...)
+    """
+    HoleTypeLogging: constr(pattern=r'^OPENHOLE|CASEDHOLE|CEMENTEDHOLE$') | None = None
+    """
+    Description of the hole related type of logging - POSSIBLE VALUE : OpenHole / CasedHole / CementedHole
+    """
+    VerticalMeasurementID: str | None = None
+    """
+    References an entry in the Vertical Measurement array for the Wellbore identified by WellboreID, which defines the vertical reference datum for all curve measured depths. Either VerticalMeasurementID or VerticalMeasurement are populated.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = None
+    """
+    The vertical measurement reference for the log curves, which defines the vertical reference datum for the logged depths. Either VerticalMeasurement or VerticalMeasurementID are populated.
+    """
+    Curves: list[Curve] | None = None
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/well_log/v1_1_0.py

@@ -0,0 +1,295 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/well_log/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 LogServiceDateInterval(BaseModel):
+    """
+    An interval built from two nested values : StartDate and EndDate. It applies to the whole log services and may apply to composite logs as [start of the first run job] and [end of the last run job]Log Service Date
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StartDate: str | None = None
+    EndDate: str | None = None
+
+
+class Curve(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    CurveID: str | None = None
+    """
+    The ID of the Well Log Curve
+    """
+    DateStamp: str | None = None
+    """
+    Date curve was created in the database
+    """
+    CurveVersion: str | None = None
+    """
+    The Version of the Log Curve.
+    """
+    CurveQuality: str | None = None
+    """
+    The Quality of the Log Curve.
+    """
+    InterpreterName: str | None = None
+    """
+    The name of person who interpreted this Log Curve.
+    """
+    IsProcessed: bool | None = None
+    """
+    Indicates if the curve has been (pre)processed or if it is a raw recording
+    """
+    NullValue: bool | None = None
+    """
+    Indicates that there is no measurement within the curve
+    """
+    DepthCoding: constr(pattern=r'^REGULAR|DISCRETE$') | None = None
+    """
+    DEPRECATED: Replaced by boolean data.IsRegular. The Coding of the depth.
+    """
+    Interpolate: bool | None = None
+    """
+    Whether curve can be interpolated or not
+    """
+    TopDepth: float | None = None
+    """
+    The curve's minimum 'depth', i.e., the reference value at which the curve has its first non-absent value. The curve may contain further absent values in between TopDepth and BaseDepth. Note that the SamplingDomainType may not be a depth as the property name indicates.
+    """
+    BaseDepth: float | None = None
+    """
+    The curve's maximum 'depth' i.e., the reference value at which the curve has its last non-absent value. The curve may contain further absent values in between TopDepth and BaseDepth. Note that the SamplingDomainType may not be a depth as the property name indicates.
+    """
+    DepthUnit: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Unit of Measure for TopDepth and BaseDepth.
+    """
+    CurveUnit: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Unit of Measure for the Log Curve
+    """
+    Mnemonic: str | None = None
+    """
+    The Mnemonic of the Log Curve is the value as received either from Raw Providers or from Internal Processing team
+    """
+    LogCurveTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-LogCurveType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The related record id of the Log Curve Type - which is the standard mnemonic chosen by the company - OSDU provides an initial list
+    """
+    LogCurveBusinessValueID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-LogCurveBusinessValue:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The related record id of the Log Curve Business Value Type.
+    """
+    LogCurveMainFamilyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-LogCurveMainFamily:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The related record id of the Log Curve Main Family Type - which is the Geological Physical Quantity measured - such as porosity.
+    """
+    LogCurveFamilyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-LogCurveFamily:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The related record id of the Log Curve Family - which is the detailed Geological Physical Quantity Measured - such as neutron porosity
+    """
+    NumberOfColumns: int | None = Field(None, examples=[192], title='Number Of Columns')
+    """
+    The number of columns present in this Curve for a single reference value. For simple logs this is typically 1; for image logs this holds the number of image traces or property series. Further information about the columns can be obtained via the respective log or curve APIs of the Domain Data Management Service.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for WellLog 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    The Wellbore where the Well Log Work Product Component was recorded
+    """
+    WellLogTypeID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-LogType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    Well Log Type short Description such as Raw; Evaluated; Composite;....
+    """
+    TopMeasuredDepth: float | None = Field(None, title='Top Measured Depth')
+    """
+    Informational Top Measured Depth of the Well Log. Always populate SamplingStart and SamplingStop, which represents the real sampling of the WellLog, including  non-depth sampling.
+    """
+    BottomMeasuredDepth: float | None = Field(None, title='Bottom Measured Depth')
+    """
+    Informational Bottom Measured Depth of the Well Log. Always populate SamplingStart and SamplingStop, which represents the real sampling of the WellLog, including  non-depth sampling.
+    """
+    ServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    The relationship to a Service Company, typically the producer or logging contractor.
+    """
+    LogSource: str | None = None
+    """
+    OSDU Native Log Source - will be updated for later releases - not to be used yet
+    """
+    LogActivity: str | None = None
+    """
+    Log Activity, used to describe the type of pass such as Calibration Pass - Main Pass - Repeated Pass
+    """
+    LogRun: str | None = None
+    """
+    Log Run - describe the run of the log - can be a number, but may be also a alphanumeric description such as a version name
+    """
+    LogVersion: str | None = None
+    """
+    Log Version
+    """
+    LoggingService: str | None = None
+    """
+    Logging Service - mainly a short concatenation of the names of the tools
+    """
+    LogServiceDateInterval_1: LogServiceDateInterval | None = Field(
+        None, alias='LogServiceDateInterval'
+    )
+    """
+    An interval built from two nested values : StartDate and EndDate. It applies to the whole log services and may apply to composite logs as [start of the first run job] and [end of the last run job]Log Service Date
+    """
+    ToolStringDescription: str | None = None
+    """
+    Tool String Description - a long concatenation of the tools used for logging services such as GammaRay+NeutronPorosity
+    """
+    LoggingDirection: str | None = None
+    """
+    Specifies whether curves were collected downward or upward
+    """
+    PassNumber: int | None = None
+    """
+    Indicates if the Pass is the Main one (1) or a repeated one - and it's level repetition
+    """
+    ActivityType: str | None = None
+    """
+    General method or circumstance of logging - MWD, completion, ...
+    """
+    DrillingFluidProperty: str | None = None
+    """
+    Type of mud at time of logging (oil, water based,...)
+    """
+    HoleTypeLogging: constr(pattern=r'^OPENHOLE|CASEDHOLE|CEMENTEDHOLE$') | None = None
+    """
+    Description of the hole related type of logging - POSSIBLE VALUE : OpenHole / CasedHole / CementedHole
+    """
+    VerticalMeasurementID: str | None = None
+    """
+    DEPRECATED: Use data.VerticalMeasurement.VerticalReferenceID instead. References an entry in the Vertical Measurement array for the Wellbore identified by WellboreID, which defines the vertical reference datum for all curve measured depths. Either VerticalMeasurementID or VerticalMeasurement are populated.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = None
+    """
+    The vertical measurement reference for the log curves, which defines the vertical reference datum for the logged depths. Either VerticalMeasurement or VerticalMeasurementID are populated.
+    """
+    Curves: list[Curve] | None = None
+    FrameIdentifier: str | None = Field(None, examples=[0], title='Frame Identifier')
+    """
+    For multi-frame or multi-section files, this identifier defines the source frame in the file. If the identifier is an index number the index starts with zero and is converted to a string for this property.
+    """
+    SamplingInterval: float | None = Field(
+        None, examples=[0.0254], title='Sampling Interval'
+    )
+    """
+    For regularly sampled curves this property holds the sampling interval. For non regular sampling rate this property is not set. The IsRegular flag indicates whether SamplingInterval is required.
+    """
+    ReferenceCurveID: str | None = Field(
+        None, examples=['MD'], title='Reference Curve ID'
+    )
+    """
+    The data.Curves[].CurveID, which holds the primary index (reference) values.
+    """
+    SamplingStart: float | None = Field(None, examples=[2500.0], title='Sampling Start')
+    """
+    The start value/first value of the ReferenceCurveID, typically the start depth of the logging.
+    """
+    SamplingStop: float | None = Field(None, examples=[7500.0], title='Sampling Stop')
+    """
+    The stop value/last value of the ReferenceCurveID, typically the end depth of the logging.
+    """
+    SamplingDomainTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellLogSamplingDomainType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--WellLogSamplingDomainType:Depth:'],
+        title='Sampling Domain Type ID',
+    )
+    """
+    The sampling domain, e.g. measured depth, true vertical, travel-time, calendar-time.
+    """
+    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 logging.
+    """
+    CandidateReferenceCurveIDs: list[str] | None = None
+    """
+    Secondary index curves, which are alternative candidates to act as ReferenceCurveID. Generally not populated, except in the cases where multiple reference curves are present, e.g. measured depth and time.
+    """
+    ZeroTime: str | None = None
+    """
+    Optional time reference for (calender) time logs. The ISO date time string representing zero time. Not to be confused with seismic travel time zero. The latter is defined by SeismicReferenceDatum.
+    """
+    SeismicReferenceElevation: v1_0_0.AbstractFacilityVerticalMeasurement | None = None
+    """
+    Populated only if the WellLog represents time-depth relationships or checkshots. It is expressed via the standard AbstractFacilityVerticalMeasurement. The following properties are expected to be present: VerticalMeasurementPathID (typically elevation), VerticalMeasurementTypeID as SeismicReferenceDatum, VerticalMeasurement holding the offset to either the VerticalCRSID or the chained VerticalReferenceID in the parent Wellbore.
+    """
+    IsRegular: bool | None = Field(None, title='Is Regular Flag')
+    """
+    Boolean property indicating the sampling mode of the ReferenceCurveID. True means all reference curve values are regularly spaced (see SamplingInterval); false means irregular or discrete sample spacing.
+    """
+    ExtensionProperties: dict[str, Any] | None = None