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

osdu_models/workproductcomponent/sample_image/v1_1_0.py

@@ -0,0 +1,269 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/sample_image/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_remark import v1_0_0 as v1_0_0_1
+from ...abstract.abstract_common_resources.v1_0_1 import OsduCommonResources
+from ...abstract.abstract_wpcgroup_type.v1_2_0 import AbstractWPCGroupType
+from ...abstract.abstract_work_product_component.v1_1_0 import (
+    AbstractWorkProductComponent,
+)
+
+
+class ImageParameter(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ImageParameterTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SampleImageParameters:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Image Parameter Type ID')
+    """
+    The type of parameter under which the image was acquired. In the array of data.ImageParameters[] objects, a particular ImageParameterTypeID value should appear at most once.
+    """
+    NumericParameterValue: float | None = Field(
+        None, examples=[10], title='Numeric Parameter Value'
+    )
+    """
+    The image parameter value of type "Numeric" under which the image was acquired.
+    """
+    BooleanParameterValue: bool | None = Field(None, title='Boolean Parameter Value')
+    """
+    The image parameter value of type "Boolean" under which the image was acquired.
+    """
+    StringParameterValue: str | None = Field(None, title='String Parameter Value')
+    """
+    The image parameter value of type "String" under which the image was acquired.
+    """
+
+
+class ImageReferenceParameters(BaseModel):
+    """
+    Similar to ImageParameters, but reference-data relationships describing reference-value list controlled image properties.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ResolutionSourceTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SampleImageResolutionSource:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resolution Source TypeID')
+    """
+    The source of the pixel resolution for this sample image, for example, it may be inferred from a scale bar or a known reference.
+    """
+    ColourSpaceTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SampleImageColourSpace:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Colour Space Type ID')
+    """
+    The colour space for this sample image, for example, could be RGB, Monochrome, or CMYK.
+    """
+    OpticalLightPathTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SampleImageOpticalLightPath:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Optical Light Path Type ID')
+    """
+    The light path for this sample image, for example, incident or transmitted.
+    """
+    LightingConditionTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SampleImageLightingCondition:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Image Lighting Condition Type ID')
+    """
+    The mode of lighting for this sample image, for example, Natural, White and Ultraviolet.
+    """
+    OpticalLightFilterTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SampleImageOpticalLightFilter:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Optical Light Filter Type ID')
+    """
+    The type of filter applied to the light source of this sample image, for example, Cross Polarised, Brightfield and Darkfield.
+    """
+    BeamTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SampleImageBeamType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='BeamTypeID')
+    """
+    The type of beam in the electron microscope for this sample image, for example, electron or ion beam.
+    """
+    XRayDetectorTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SampleImageXRayDetector:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='XRayDetectorTypeID')
+    """
+    The type of X Ray detector used for this sample image, for example, Wavelength Dispersive Detector WDS/WDX) and Energy Dispersive Detector (EDS/EDX).
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for SampleImage 1.1.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, for examples, Optical Photography, Computed Tomography (CT) and Hyperspectral.
+    """
+    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'
+    )
+    """
+    DEPRECATED: Use the Remarks array object instead. 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')
+    """
+    DEPRECATED Use the `ImageParameters[].LightingConditionTypeID` property instead. The type of lighting conditions used when capturing the image. Examples include Ultraviolet, White, Natural, etc
+    """
+    Magnification: float | None = Field(None, title='Magnification')
+    """
+    DEPRECATED Use the `ImageParameters[].ImageParameterType` property along with the `Magnification` reference value and the `ImageParameterNumericValue` instead. Magnification of the image
+    """
+    ImageParameters: list[ImageParameter] | None = Field(
+        None,
+        examples=[
+            [
+                {
+                    'ImageParameterTypeID': 'namespace:reference-data--SampleImageParameters:PixelWidth:',
+                    'NumericParameterValue': 1231,
+                },
+                {
+                    'ImageParameterTypeID': 'namespace:reference-data--SampleImageParameters:PixelHeight:',
+                    'NumericParameterValue': 927,
+                },
+                {
+                    'ImageParameterTypeID': 'namespace:reference-data--SampleImageParameters:ScaleBar:',
+                    'BooleanParameterValue': False,
+                },
+                {
+                    'ImageParameterTypeID': 'namespace:reference-data--SampleImageParameters:CameraModel:',
+                    'StringParameterValue': 'MobilePhone',
+                },
+            ]
+        ],
+        title='Image Parameters',
+    )
+    """
+    The type of parameters under which the image was acquired
+    """
+    ImageReferenceParameters_1: ImageReferenceParameters | None = Field(
+        None, alias='ImageReferenceParameters', title='Image Reference Parameters'
+    )
+    """
+    Similar to ImageParameters, but reference-data relationships describing reference-value list controlled image properties.
+    """
+    Remarks: list[v1_0_0_1.AbstractRemark] | None = Field(None, title='Remarks')
+    """
+    Remarks regarding the image acquisition and or processing environment or parameters.  One or many remarks can be captured.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/samples_analyses_report/__init__.py

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

osdu_models/workproductcomponent/samples_analyses_report/v1_0_0.py

@@ -0,0 +1,129 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/samples_analyses_report/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_remark 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 SamplesAnalysesReport 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DocumentTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-DocumentType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The kind of document--from a business standpoint, e.g., multi-well study, etc.
+    """
+    NumberOfPages: int | None = None
+    """
+    Number of pages in the document, useful in cases where if it was described in the acquired manifest as opposed to a derived/calculated value
+    """
+    SubTitle: str | None = None
+    """
+    The sub-title of the document.
+    """
+    DocumentSubject: str | None = None
+    """
+    A description text or an array of subjects covered by the document. If present this information must compliment the Tag and SubTitle
+    """
+    DatePublished: str | None = None
+    """
+    The date and time that the results of the analysis containing observed measurements or calculations was published
+    """
+    DateModified: str | None = None
+    """
+    The date and time that the document was last modified
+    """
+    DocumentLanguage: str | None = Field(None, examples=['eng'])
+    """
+    Document language as listed in the ISO 639-3 https://en.wikipedia.org/wiki/ISO_639, https://en.wikipedia.org/wiki/List_of_ISO_639-3_codes
+    """
+    SampleIDs: (
+        list[constr(pattern=r'^[\w\-\.]+:master-data\-\-Sample:[\w\-\.\:\%]+:[0-9]*$')]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            [
+                'namespace:master-data--Sample:Kentish-Knock-South-1_KK-16:',
+                'namespace:master-data--Sample:Kentish-Knock-South-1_KK-17:',
+                'namespace:master-data--Sample:Kentish-Knock-South-1_KK-21:',
+            ]
+        ],
+    )
+    """
+    OSDU Record IDs for the Rock and/or Fluid Sample or Samples on which this batch or batches of analysis were performed.
+    """
+    ReportSampleIdentifiers: list[str] | None = Field(
+        None, examples=[['KK-16', 'KK-17', 'KK-21']]
+    )
+    """
+    The names or identifiers of the analyzed samples in this report or document. These names or identifiers are often assigned by the laboratory. This list can be used to assist in locating the appropriate OSDU Sample records or to find the dataset in the parent report.
+    """
+    SampleAnalysisTypeIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-SampleAnalysisType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            ['namespace:reference-data--SampleAnalysisType:Wettability.Amott-Harvey:']
+        ],
+    )
+    """
+    A list of all sample analysis types represented by this report, whether the sample analysis type relates to Rock, Fluid, or both.
+    """
+    SamplesAnalysisCategoryTagIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-SamplesAnalysisCategoryTag:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            ['namespace:reference-data--SamplesAnalysisCategoryTag:ExxonMobil-SCAL:']
+        ],
+    )
+    """
+    List of higher level grouping terms that are often used within organisations to search for analysis types in addition to the formal Family and Method properties, but which are variable across organisations and therefore do not need to be governed strictly by the OSDU Forum. For example: SCAL, Static SCAL, Dynamic SCAL, Source Rock Analysis. We suggest you use a namespace, like the operators name, like “Shell.SCAL”. BP.SCAL, Equinor.SCAL, Chevron.SCAL, Exxon.SCAL.....
+    """
+    Remarks: list[v1_0_0.AbstractRemark] | None = None
+    """
+    An array containing operational or quality comments pertaining to the sample analysis represented by this work product component.
+    """
+    LaboratoryIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Laboratory ID')
+    """
+    OSDU Record IDs for the laboratories used to conduct the sample analyses contained in this report. This could represent the laboratory company or the laboratory branch.
+    """
+    LaboratoryNames: list[str] | None = None
+    """
+    List of names of laboratories used to conduct the sample analyses contained in this report. This attribute is more freeform than Laboratory IDs and does not have relationships to OSDU Record IDs. This attribute exists to help with a low bar of ingestion but best practice is to resolve each of these to an OSDU Record ID in the LaboratoryIDs attribute.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/samples_analysis/__init__.py

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

osdu_models/workproductcomponent/samples_analysis/v1_0_0.py

@@ -0,0 +1,143 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/samples_analysis/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_remark 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_1 import AbstractWPCActivity
+
+
+class ParentSamplesAnalysesReport(BaseModel):
+    """
+    A pair of properties building a reference to a report combined with a page reference inside the document.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ParentSamplesAnalysesReportID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-SamplesAnalysesReport:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    An OSDU Record representing the report from which this analysis was extracted or an OSDU Record from which this analysis was reconstructed.
+    """
+    ParentSamplesAnalysesReportPageNumbers: str | None = Field(
+        None, examples=['12-15,17']
+    )
+    """
+    If this dataset was extracted from a larger report, this identifies the page number or range (if in document format such as PDF) or sheet names (if in document format such as spreadsheet). For ease of parsing, ranges should be denoted with hyphens with no spaces, and divided with commas). E.g. "12-15,17" or "Sheet1,Sheet2".
+    """
+
+
+class Data(
+    OsduCommonResources,
+    AbstractWPCGroupType,
+    AbstractWorkProductComponent,
+    AbstractWPCActivity,
+):
+    """
+    `data` payload for SamplesAnalysis 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SampleIDs: (
+        list[constr(pattern=r'^[\w\-\.]+:master-data\-\-Sample:[\w\-\.\:\%]+:[0-9]*$')]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            [
+                'namespace:master-data--Sample:Kentish-Knock-South-1_KK-16:',
+                'namespace:master-data--Sample:Kentish-Knock-South-1_KK-17:',
+                'namespace:master-data--Sample:Kentish-Knock-South-1_KK-21:',
+            ]
+        ],
+    )
+    """
+    OSDU Record IDs for the Rock and/or Fluid Sample or Samples on which this batch or batches of analysis were performed.
+    """
+    ReportSampleIdentifiers: list[str] | None = Field(
+        None, examples=[['KK-16', 'KK-17', 'KK-21']]
+    )
+    """
+    The names or identifiers of the analyzed samples in this report or document. These names or identifiers are often assigned by the laboratory. This list can be used to assist in locating the appropriate OSDU Sample records or to find the dataset in the parent report.
+    """
+    DateAnalyzed: str | None = None
+    """
+    The date the batch of sample analysis was completed.
+    """
+    LaboratoryIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Laboratory ID')
+    """
+    OSDU Record IDs for the laboratories used to conduct the sample analyses contained in this report.
+    """
+    LaboratoryNames: list[str] | None = None
+    """
+    List of names of laboratories used to conduct the sample analyses contained in this report. This attribute is more freeform than Laboratory IDs and does not have relationships to OSDU Record IDs.
+    """
+    LaboratoryAnalysts: list[str] | None = Field(None, title='Laboratory Contact')
+    """
+    The names and other information of the analysts responsible for conducting and reporting on the analysis performed
+    """
+    Remarks: list[v1_0_0.AbstractRemark] | None = None
+    """
+    An array containing operational or quality comments pertaining to the sample analysis represented by this work product component.
+    """
+    DatePublished: str | None = None
+    """
+    The date and time that the results of the analysis containing observed measurements or calculations was published.
+    """
+    ParentSamplesAnalysesReports: list[ParentSamplesAnalysesReport] | None = None
+    """
+    Identifies the report from which this analysis was extracted or multiple reports from which this analysis was reconstructed.
+    """
+    SampleAnalysisTypeIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-SampleAnalysisType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            ['namespace:reference-data--SampleAnalysisType:Wettability.Amott-Harvey:']
+        ],
+    )
+    """
+    A list of all sample analysis types represented by this report, whether the sample analysis type relates to Rock, Fluid, or both.
+    """
+    SamplesAnalysisCategoryTagIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-SamplesAnalysisCategoryTag:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            ['namespace:reference-data--SamplesAnalysisCategoryTag:ExxonMobil-SCAL:']
+        ],
+    )
+    """
+    List of higher level grouping terms that are often used within organisations to search for analysis types in addition to the formal Family and Method properties, but which are variable across organisations and therefore do not need to be governed strictly by the OSDU Forum. For example: SCAL, Static SCAL, Dynamic SCAL, Source Rock Analysis. We suggest you use a namespace, like the operators name, like “Shell.SCAL”. BP.SCAL, Equinor.SCAL, Chevron.SCAL, Exxon.SCAL.....
+    """
+    ExtensionProperties: dict[str, Any] | None = None