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

osdu_models/workproductcomponent/rock_sample_analysis/v1_3_1.py

@@ -0,0 +1,391 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/rock_sample_analysis/v1_3_1.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_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+from ...abstract.abstract_wpcactivity.v1_2_0 import AbstractWPCActivity
+
+
+class Conditions(BaseModel):
+    """
+    The conditions under which this analysis has been carried out
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Pressure: float | None = Field(None, title='Pressure')
+    """
+    The pressure condition for the analysis.
+    """
+    Temperature: float | None = Field(None, title='Temperature')
+    """
+    The temperature condition for the analysis.
+    """
+    PressureMeasurementTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PressureMeasurementType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Pressure Measurement Type ID')
+    """
+    Identifies the environment where the pressure was measured. E.g. Ambient, Overburden
+    """
+    MeanPressure: float | None = Field(None, title='Mean Pressure')
+    """
+    The average pressure in which the gas permeability has been measured.
+    """
+    PorePressure: float | None = Field(None, title='Pore Pressure')
+    """
+    The pressure of the fluid in the pore space.
+    """
+
+
+class OtherMeasurement(BaseModel):
+    """
+    An array element of an analysis specifying the numeric, text or date-time value associated with a ParameterType.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EffectiveDateTime: str | None = None
+    """
+    The date and time at which this specification becomes effective.
+    """
+    TerminationDateTime: str | None = None
+    """
+    The first point in time when this specification is no longer in effect.
+    """
+    SpecificationQuantity: float | None = None
+    """
+    The numeric value of the parameter.
+    """
+    SpecificationDate: str | None = None
+    """
+    The date value of the parameter.
+    """
+    SpecificationDateTime: str | None = None
+    """
+    The date and time value of the parameter.
+    """
+    SpecificationIndicator: bool | None = None
+    """
+    The indicator value of the parameter.
+    """
+    SpecificationText: str | None = None
+    """
+    The text value of the parameter.
+    """
+    SpecificationTime: str | None = None
+    """
+    The time value of the parameter.
+    """
+    UnitOfMeasureID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The unit for the quantity parameter, like metre (m in SI units system) for quantity Length.
+    """
+    ParameterTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ParameterType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Parameter representing a property or characteristic.
+    """
+
+
+class Remark(BaseModel):
+    """
+    An array containing narrative remarks pertaining to a rock sample analysis.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RemarkID: str | None = Field(None, title='Remark ID')
+    """
+    A unique identifier for each remark record.
+    """
+    Remark: str | None = Field(None, title='Remark')
+    """
+    A descriptive comment for this remark.
+    """
+    RemarkSource: str | None = Field(None, title='Remark Source')
+    """
+    The person, vendor, interpreter or other provider of information.
+    """
+
+
+class RCAMeasurement(BaseModel):
+    """
+    A Routine Core Analysis Measurement.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Conditions_1: Conditions | None = Field(
+        None, alias='Conditions', title='Conditions'
+    )
+    """
+    The conditions under which this analysis has been carried out
+    """
+    Permeability: float | None = Field(None, title='Permeability')
+    """
+    The measured sample permeability.
+    """
+    Porosity: float | None = Field(None, title='Porosity')
+    """
+    The measured sample porosity.
+    """
+    OtherMeasurements: list[OtherMeasurement] | None = Field(
+        None, title='Other Measurements'
+    )
+    """
+    Other measurements made in the context of this analysis
+    """
+    Remarks: list[Remark] | None = Field(None, title='Analysis Remarks')
+    """
+    An array containing operational or quality comments pertaining to a rock sample analysis.
+    """
+    PermeabilityMeasurementTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PermeabilityMeasurementType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Permeability Measurement Type ID')
+    """
+    The measurement type used to obtain the Permeability values.
+    """
+    PorosityMeasurementTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PorosityMeasurementType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Porosity Measurement Type ID')
+    """
+    The measurement type used to obtain the Porosity values.
+    """
+
+
+class RoutineCoreAnalysis(BaseModel):
+    """
+    If populated RoutineCoreAnalysis contains conditions and results of a routine core analysis. The array AnalysisTypeIDs must then contain a value of RoutineCoreAnalysis.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RCAMeasurements: list[RCAMeasurement] | None = Field(None, title='RCA Measurements')
+    """
+    The conditions under which this analysis has been carried out
+    """
+    GrainDensity: float | None = Field(None, title='Grain Density')
+    """
+    Th measured grain density
+    """
+    GrainDensityMeasurementTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-GrainDensityMeasurementType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Grain Density Measurement Type ID')
+    """
+    The measurement type used to obtain the GrainDensity value.
+    """
+    SaturationOil: float | None = Field(None, title='Saturation Oil')
+    """
+    The fraction of oil volume compared to the total pore volume.
+    """
+    SaturationWater: float | None = Field(None, title='Saturation Water')
+    """
+    The fraction of water volume compared to the total pore volume.
+    """
+    SaturationGas: float | None = Field(None, title='Saturation Gas')
+    """
+    The fraction of gas volume compared to the total pore volume.
+    """
+    SaturationMethodTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SaturationMethodType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Saturation Method Type ID')
+    """
+    The saturation method type, like Dean Stark, Retort, Karl Fischer.
+    """
+    WeightOfSalt: float | None = Field(None, title='Weight Of Salt')
+    """
+    The weight of salt in the brine, needed in conjunction with SaturationWater.
+    """
+
+
+class GrainSizeAnalysis(BaseModel):
+    """
+    If populated, it contains information that additional content is available containing grain size analysis results. The array AnalysisTypeIDs must then contain a value of GrainSizeAnalysis.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    GrainSizeMethodTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-GrainSizeAnalysisMethod:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Grain Size Method ID')
+    """
+    The type of grain size analysis carried out during this analysis.
+    """
+    GrainSizeClassificationSchemeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-GrainSizeClassificationScheme:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Grain Size Classification Scheme ID')
+    """
+    The relationship to the GrainSizeClassificationScheme reference value record, which defined the grain size interval to GrainSizeClassification mapping. It provides the detailed context to the MeanGrainSizeDescription.
+    """
+    MeanGrainSizeClassificationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-GrainSizeClassification:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Mean Grain Size Classification ID')
+    """
+    The mean grain size as determined in the analysis. It holds the relationship to a GrainSizeClassification reference value.
+    """
+    MedianGrainSize: float | None = Field(None, title='Median Grain Size')
+    """
+    The median grain size as numeric value, as determined in this analysis.
+    """
+
+
+class Data(
+    OsduCommonResources,
+    AbstractWPCGroupType,
+    AbstractWorkProductComponent,
+    AbstractWPCActivity,
+):
+    """
+    `data` payload for RockSampleAnalysis 1.3.1.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Wellbore ID')
+    """
+    Unique wellbore identifier. Required when RockSampleAnalysis does not have relationship with master-data Core.  E.g. analysis for sidewall core.
+    """
+    CoringID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Coring:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = Field(None, title='Coring ID')
+    """
+    Identifies the Core on which this batch of analysis was performed.
+    """
+    RockSampleID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-RockSample:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Rock Sample ID')
+    """
+    Identifies the RockSample on which this batch of analysis was performed.
+    """
+    LabSampleIdentifier: str | None = Field(
+        None, examples=['KK-16'], title='Laboratory Sample Identifier'
+    )
+    """
+    The name or sample identifier assigned to the sample by the laboratory. This name or identifier is used to key into the associated content (e.g., document) to find the portion of the content dealing with the specific sample.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='Vertical Measurement'
+    )
+    """
+    References an entry in the VerticalMeasurements array for the Wellbore identified by WellboreID, or a standalone vertical reference which defines the vertical reference datum for all measured depths of the RockSample record. If this is not populated, the VerticalMeasurement is derived from the Coring.
+    """
+    AnalysisDate: str | None = Field(None, title='Analysis Date')
+    """
+    The date the batch of rock sample analysis was performed.
+    """
+    TopDepth: float | None = Field(None, title='Top Depth')
+    """
+    The first depth index from the analysis result.
+    """
+    BottomDepth: float | None = Field(None, title='Bottom Depth')
+    """
+    The last depth index from the analysis result.
+    """
+    DepthShiftsID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Depth Shifts ID')
+    """
+    The WellLog representation carrying the core-depth to logging-depth correction or mapping used or to be used with this analysis.
+    """
+    RoutineCoreAnalysis_1: RoutineCoreAnalysis | None = Field(
+        None, alias='RoutineCoreAnalysis', title='Routine Core Analysis'
+    )
+    """
+    If populated RoutineCoreAnalysis contains conditions and results of a routine core analysis. The array AnalysisTypeIDs must then contain a value of RoutineCoreAnalysis.
+    """
+    GrainSizeAnalysis_1: GrainSizeAnalysis | None = Field(
+        None, alias='GrainSizeAnalysis', title='Grain Size Analysis'
+    )
+    """
+    If populated, it contains information that additional content is available containing grain size analysis results. The array AnalysisTypeIDs must then contain a value of GrainSizeAnalysis.
+    """
+    LaboratoryName: str | None = Field(None, title='Laboratory Name')
+    """
+    Name or branch of the laboratory performing the analysis.
+    """
+    AnalysisOrganisationID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Analysis Organisation ID')
+    """
+    Identifies the Organisation that produces/produced this analysis.
+    """
+    SampleOrientationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SampleOrientationType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Sample Orientation ID')
+    """
+    The de-normalized Sample Orientation derived from the RockSample.
+    """
+    Remarks: list[Remark] | None = Field(None, title='Analysis Remarks')
+    """
+    An array containing operational or quality comments pertaining to a rock sample analysis.
+    """
+    AnalysisTypeIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-RockSampleAnalysisType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Analysis Type IDs')
+    """
+    Type of laboratory test(s) performed (e.g. Routine Core Analysis, Grain Size) on a specific rock sample by a given laboratory.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/sample_image/__init__.py

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

osdu_models/workproductcomponent/sample_image/v1_0_0.py

@@ -0,0 +1,129 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/sample_image/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import 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_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for SampleImage 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SampleIDs: (
+        list[constr(pattern=r'^[\w\-\.]+:master-data\-\-Sample:[\w\-\.\:\%]+:[0-9]*$')]
+        | None
+    ) = Field(None, title='Sample IDs')
+    """
+    The samples that the image relates to. One or many Sample relationships are permitted. The Sample object captures attributes of a sample/ specimen (rock or fluid) acquired either through an original acquisition event, sub-sampling event, generated from recombination of other samples / specimens or derived through the application of some laboratory process on the parent sample.
+    """
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Wellbore ID')
+    """
+    The associated wellbore. This is an optional relationship if the SampleID is populated with the WellboreID.
+    """
+    ImageTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-RockImageType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Image Type ID')
+    """
+    The type of image. Examples include Photograph, Computed Tomography, Thin Section, etc.
+    """
+    TopDepthMeasuredDepth: float | None = Field(
+        None, examples=[3000], title='Top Depth Measured Depth'
+    )
+    """
+    If the top depth is the same as the SampleID record top depth this is an optional property. 
+    The measured top depth in a wellbore relevant to the image. For a singular point depth the top and base depth should be the same.
+    """
+    BaseDepthMeasuredDepth: float | None = Field(
+        None, examples=[3000], title='Base Depth Measured Depth'
+    )
+    """
+    If the base depth is the same as the SampleID record base depth this is an optional property. 
+    The measured base depth in a wellbore relevant to the image. For a singular point depth the top and base depth should be the same
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='Vertical Measurement'
+    )
+    """
+    The data structure defining the zero depth point for the measured depths as well as the VerticalMeasurementSource (driller's depth or logger's depth), so that it becomes clear whether or not a depth correction is required and if so, in which direction the correction has to be performed (driller's depth to logger's depth or vice versa).
+    """
+    DepthShiftID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellLog:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Depth Shift ID')
+    """
+    The WellLog representation carrying the preferred sample-depth to logging-depth correction or mapping
+    """
+    AcquisitionDate: str | None = Field(
+        None, examples=['2022-09-09'], title='Acquisition Date'
+    )
+    """
+    The date the image was originally taken or acquired
+    """
+    ServiceCompanyID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Service CompanyID')
+    """
+    The organisation or contractor that originally took or acquired the image
+    """
+    ReferenceIdentifier: str | None = Field(
+        None, examples=['X12A'], title='Image Reference Identifier'
+    )
+    """
+    Unique or Distinctive Image Reference Number, Job Number, File Number, Identifier, Label, Name, etc. Typically given by the original image acquisition supplier and as indicated in the report or file. Use this attribute to allow correlation back to the original source document, file, etc.
+    """
+    Remark: str | None = Field(
+        None, examples=['Natural light. Taken in the field.'], title='Remark'
+    )
+    """
+    Remarks regarding the image acquisition and or processing environment or parameters
+    """
+    FormatInterval: float | None = Field(None, examples=[4], title='Format Interval')
+    """
+    The interval included in the image. Typically used for conventional core. For example 1m or 4m
+    """
+    TextualHeader: list[str] | None = Field(
+        None,
+        examples=[
+            [
+                'File Size: 322 kB\nFile Type: JPEG\nMIME Type: image/jpeg\nImage Width: 1231\nImage Height: 927\nEncoding Process: Baseline DCT, Huffman coding\nBits Per Sample: 8\nColor Components: 3\nX Resolution: 1\nY Resolution: 1\nSoftware: Google\nYCbCr Sub Sampling: YCbCr4:2:0 (2 2)'
+            ]
+        ],
+        title='Textual Header',
+    )
+    """
+    A free text array to capture the image file header or image parameters for knowledge capture, index and search purposes. Header values can be extracted from, e.g., Exchangeable Image File Format (EXIF) properties, Digital Imaging and Communications in Medicine (DICOM) header properties (such as x-ray intensity) and etc.
+    """
+    LightingConditionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ImageLightingCondition:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Lighting Condition ID')
+    """
+    The type of lighting conditions used when capturing the image. Examples include Ultraviolet, White, Natural, etc
+    """
+    Magnification: float | None = Field(None, examples=[5], title='Magnification')
+    """
+    Magnification of the image
+    """
+    ExtensionProperties: dict[str, Any] | None = None