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

osdu_models/masterdata/seismic_acquisition_survey/v1_4_0.py

@@ -0,0 +1,295 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/seismic_acquisition_survey/v1_4_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_master.v1_2_0 import AbstractMaster
+from ...abstract.abstract_project.v1_0_0 import AbstractProject
+from ...abstract.abstract_project_activity.v1_2_0 import AbstractProjectActivity
+
+
+class SourceConfiguration(BaseModel):
+    """
+    Parameters characterizing the seismic source configuration.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    VesselName: str | None = Field(None, title='Vessel Name')
+    """
+    Name of the source vessel (may be the same as the receiver).  In the case of a VSP, this may be a platform or rig.
+    """
+    ShotpointSpacing: float | None = Field(None, title='Shotpoint Spacing')
+    """
+    Horizontal distance between shotpoint locations.
+    """
+    EnergySourceTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicEnergySourceType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Energy Source Type ID')
+    """
+    Seismic Source type. E.g.: Airgun, Vibroseis, Dynamite,Watergun.
+    """
+    SourceArrayCount: int | None = Field(None, title='Source Array Count')
+    """
+    Number of energy sources.
+    """
+    SourceArraySpacing: float | None = Field(None, title='Source Array Spacing')
+    """
+    Distance between energy sources.
+    """
+    SourceArrayDepth: float | None = Field(None, title='Source Array Depth')
+    """
+    Depth of the energy source.
+    """
+    SourceArrayVolume: float | None = Field(None, title='Source Array Volume')
+    """
+    Volume of the energy source.
+    """
+    SourceArraySweepFreqMin: float | None = Field(
+        None, title='Source Array Sweep Frequency Minimum'
+    )
+    """
+    Minimum frequency of the vibroseis source.
+    """
+    SourceArraySweepFreqMax: float | None = Field(
+        None, title='Source Array Sweep Frequency Maximum'
+    )
+    """
+    Maximum frequency of the vibroseis source.
+    """
+    SourceArraySweepLength: float | None = Field(
+        None, title='Source Array Sweep Length'
+    )
+    """
+    Length of the vibroseis source sweep.
+    """
+    Remarks: str | None = Field(None, title='Remarks')
+    """
+    Text remarks regarding the Seismic source configuration.
+    """
+    SourceWellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Source Wellbore ID')
+    """
+    The relationship to the wellbore, in which the source or sources are located.
+    """
+    SourceArrayMinDepth: float | None = Field(None, title='Source Minimum Depth')
+    """
+    Minimum depth of Sources in a wellbore. Used in conjunction with VSP acquisition.
+    """
+    SourceArrayMaxDepth: float | None = Field(None, title='Receiver Maximum Depth')
+    """
+    Maximum depth of receivers in a wellbore. Used in conjunction with VSP acquisition.
+    """
+
+
+class ReceiverConfiguration(BaseModel):
+    """
+    Parameters characterizing the seismic receiver configuration.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    VesselName: str | None = Field(None, title='Vessel Name')
+    """
+    Name of the receiver vessel (may be the same as the source).  In the case of a VSP, this may be a platform or rig.
+    """
+    CableCount: int | None = Field(None, title='Cable Count')
+    """
+    Number of receiver arrays (lines).
+    """
+    CableLength: float | None = Field(None, title='Cable Length')
+    """
+    Total length of receiver array.
+    """
+    CableSpacing: float | None = Field(None, title='Cable Spacing')
+    """
+    Horizontal distance between receiver arrays.
+    """
+    CableDepth: float | None = Field(None, title='Cable Depth')
+    """
+    Marine seismic cable towing depth below sea surface  (Positive Down).
+    """
+    ReceiverTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicReceiverType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Receiver Type ID')
+    """
+    The type of receivers, e.g. geophones, hydrophones, ocean bottom seismometers.
+    """
+    ReceiverCount: int | None = Field(None, title='Receiver Count')
+    """
+    Number of receivers on a cable.
+    """
+    ReceiverSpacingInterval: float | None = Field(None, title='Receiver Spacing')
+    """
+    Distance between receivers on same cable.
+    """
+    ReceiverGroupSpacing: float | None = Field(None, title='Receiver Group Spacing')
+    """
+    Distance between receiver groups on the same cable.
+    """
+    Remarks: str | None = Field(None, title='Remarks')
+    """
+    Text remarks regarding the Seismic Receiver configuration.
+    """
+    WellboreID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Wellbore')
+    """
+    The relationship to the wellbore, in which the receivers are located. Used in conjunction with VSP acquisition.
+    """
+    WellboreReceiverMinDepth: float | None = Field(
+        None, title='Wellbore Receiver Minimum Depth'
+    )
+    """
+    Minimum depth of receivers in a wellbore. Used in conjunction with VSP acquisition.
+    """
+    WellboreReceiverMaxDepth: float | None = Field(
+        None, title='Wellbore Receiver Maximum Depth'
+    )
+    """
+    Maximum depth of receivers in a wellbore. Used in conjunction with VSP acquisition.
+    """
+
+
+class Data(
+    OsduCommonResources, AbstractMaster, AbstractProject, AbstractProjectActivity
+):
+    """
+    `data` payload for SeismicAcquisitionSurvey 1.4.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SeismicGeometryTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicGeometryType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Reference to the standard values for the general layout of the acquisition.  This is an hierarchical value.  The top value is like 2D, 3D, 4D, Borehole, Passive.  The second value is like NATS, WATS, Brick, Crosswell.  Nodes are separated by forward slash.
+    """
+    AcquisitionTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicAcquisitionType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Acquisition Type ID')
+    """
+    Acquisition approach used Conventional, Wide Azimuth, Multi Azimuth etc.
+    """
+    OperatingEnvironmentID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-OperatingEnvironment:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Identifies the setting of acquisition (land, marine, transition zone).
+    """
+    AreaCalculated: float | None = None
+    """
+    The calculated are covered by the survey. This value is calculated during the loading of the survey.
+    """
+    AreaNominal: float | None = None
+    """
+    The nominal area covered by the survey. This value is usually entered by the end user.
+    """
+    ShotpointIncrementDistance: float | None = None
+    """
+    DEPRECATED: Use SourceConfigurations[].ShotpointSpacing.  Horizontal distance between shotpoint locations.
+    """
+    EnergySourceTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicEnergySourceType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    DEPRECATED: Use SourceConfigurations[].EnergySourceTypeID.Seismic Source type. E.g.: Airgun, Vibroseis, Dynamite, Watergun.
+    """
+    SourceArrayCount: int | None = None
+    """
+    DEPRECATED: Use SourceConfigurations[].SourceArrayCount. Number of energy sources.
+    """
+    SourceArraySeparationDistance: float | None = None
+    """
+    DEPRECATED: Use SourceConfigurations[].SourceArraySpacing. Distance between energy Sources.
+    """
+    SampleInterval: float | None = None
+    """
+    Vertical sampling interval of data at time of acquisition.
+    """
+    RecordLength: float | None = None
+    """
+    Length of record at time of acquisition.
+    """
+    ShootingAzimuthAngle: float | None = None
+    """
+    Orientation of plane between source and receivers.
+    """
+    CableCount: int | None = None
+    """
+    DEPRECATED: Use ReceiverConfigurations[].CableCount. Number of receiver arrays (lines).
+    """
+    CableLength: float | None = None
+    """
+    DEPRECATED: Use ReceiverConfigurations[].CableLength. Total length of receiver array.
+    """
+    CableSpacingDistance: float | None = None
+    """
+    DEPRECATED: Use ReceiverConfigurations[].CableSpacing. Horizontal distance between receiver arrays.
+    """
+    MinOffsetDistance: float | None = None
+    """
+    Horizontal distance between source and first receiver.
+    """
+    MaxOffsetDistance: float | None = None
+    """
+    Horizontal distance between source and last receiver.
+    """
+    FoldCount: int | None = None
+    """
+    The number of times a point in the subsurface is sampled.  It measures of the redundancy of common midpoint seismic data.
+    """
+    VesselNames: list[str] | None = None
+    """
+    DEPRECATED: use VesselNames in SourceConfigurations and ReceiverConfigurations. List of names of the seismic acquisition (source and streamer) vessels used (marine environment only).
+    """
+    SourceConfigurations: list[SourceConfiguration] | None = None
+    """
+    The seismic source configurations used for this acquisition project.
+    """
+    ReceiverConfigurations: list[ReceiverConfiguration] | None = None
+    """
+    The seismic receiver configurations used for this acquisition project.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = None
+    """
+    The vertical measurement reference for VSP surveys, which defines the vertical reference datum for the measured depths.
+    """
+    PrecedingTimeLapseSurveyID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-SeismicAcquisitionSurvey:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    If populated, this survey is part of a time-lapse survey sequence. It identifies the preceding SeismicAcquisitionSurvey. The first survey in the sequence has an empty or absent PrecedingTimeLapseSurveyID.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/seismic_processing_project/__init__.py

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

osdu_models/masterdata/seismic_processing_project/v1_0_0.py

@@ -0,0 +1,31 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/seismic_processing_project/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_0_0 import AbstractMaster
+from ...abstract.abstract_project.v1_0_0 import AbstractProject
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractProject):
+    """
+    `data` payload for SeismicProcessingProject 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SeismicAcquisitionSurveys: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-SeismicAcquisitionSurvey:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = None
+    """
+    List of seismic acquisition projects (surveys) that originated the underlying data used in Processing Project.  Trace data work product components have an explicit child relationship.  Other affiliated objects may use Lineage.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/seismic_processing_project/v1_1_0.py

@@ -0,0 +1,34 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/seismic_processing_project/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_0_0 import AbstractMaster
+from ...abstract.abstract_project.v1_0_0 import AbstractProject
+from ...abstract.abstract_project_activity.v1_0_0 import AbstractProjectActivity
+
+
+class Data(
+    OsduCommonResources, AbstractMaster, AbstractProject, AbstractProjectActivity
+):
+    """
+    `data` payload for SeismicProcessingProject 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SeismicAcquisitionSurveys: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-SeismicAcquisitionSurvey:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = None
+    """
+    List of seismic acquisition projects (surveys) that originated the underlying data used in Processing Project.  Trace data work product components have an explicit child relationship.  Other affiliated objects may use Lineage.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/seismic_processing_project/v1_2_0.py

@@ -0,0 +1,43 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/seismic_processing_project/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_1_0 import AbstractMaster
+from ...abstract.abstract_project.v1_0_0 import AbstractProject
+from ...abstract.abstract_project_activity.v1_0_0 import AbstractProjectActivity
+
+
+class Data(
+    OsduCommonResources, AbstractMaster, AbstractProject, AbstractProjectActivity
+):
+    """
+    `data` payload for SeismicProcessingProject 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SeismicAcquisitionSurveys: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-SeismicAcquisitionSurvey:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = None
+    """
+    List of seismic acquisition projects (surveys) that originated the underlying data used in Processing Project.  Trace data work product components have an explicit child relationship.  Other affiliated objects may use Lineage.
+    """
+    BinGridID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-SeismicBinGrid:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    For 3D projects, BinGridID relates to the primary bin grid geometry for the processing; for 3D merge projects, it relates to the final (re-)projection and re-binning geometry.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/seismic_processing_project/v1_3_0.py

@@ -0,0 +1,43 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/seismic_processing_project/v1_3_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+from ...abstract.abstract_project.v1_0_0 import AbstractProject
+from ...abstract.abstract_project_activity.v1_2_0 import AbstractProjectActivity
+
+
+class Data(
+    OsduCommonResources, AbstractMaster, AbstractProject, AbstractProjectActivity
+):
+    """
+    `data` payload for SeismicProcessingProject 1.3.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SeismicAcquisitionSurveys: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-SeismicAcquisitionSurvey:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = None
+    """
+    List of seismic acquisition projects (surveys) that originated the underlying data used in Processing Project.  Trace data work product components have an explicit child relationship.  Other affiliated objects may use Lineage.
+    """
+    BinGridID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-SeismicBinGrid:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    For 3D projects, BinGridID relates to the primary bin grid geometry for the processing; for 3D merge projects, it relates to the final (re-)projection and re-binning geometry.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/seismic_processing_project/v1_4_0.py

@@ -0,0 +1,64 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/seismic_processing_project/v1_4_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_1 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+from ...abstract.abstract_project.v1_0_0 import AbstractProject
+from ...abstract.abstract_project_activity.v1_2_0 import AbstractProjectActivity
+
+
+class Data(
+    OsduCommonResources, AbstractMaster, AbstractProject, AbstractProjectActivity
+):
+    """
+    `data` payload for SeismicProcessingProject 1.4.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SeismicAcquisitionSurveys: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-SeismicAcquisitionSurvey:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = None
+    """
+    List of seismic acquisition projects (surveys) that originated the underlying data used in Processing Project.  Trace data work product components have an explicit child relationship.  Other affiliated objects may use Lineage.
+    """
+    BinGridID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-SeismicBinGrid:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    For 3D projects, BinGridID relates to the primary bin grid geometry for the processing; for 3D merge projects, it relates to the final (re-)projection and re-binning geometry.
+    """
+    SeismicLineGeometryIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:work-product-component\-\-SeismicLineGeometry:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            [
+                'namespace:work-product-component--SeismicLineGeometry:SeismicLineGeometry-32d4b6e8-45f1-4c78-98ab-12cd34ef5678:',
+                'namespace:work-product-component--SeismicLineGeometry:SeismicLineGeometry-bca9d8e7-65f4-4ab2-bc12-3456de78f9ab:',
+                'namespace:work-product-component--SeismicLineGeometry:SeismicLineGeometry-12345678-90ab-cdef-1234-567890abcdef:',
+            ]
+        ],
+        title='Seismic LineGeometry IDs',
+    )
+    """
+    For 2D seismic processing projects, this property references the definitive SeismicLineGeometry entities associated with the project. One or more 2D seismic lines may be included.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/storage_facility/__init__.py

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

osdu_models/masterdata/storage_facility/v1_0_0.py

@@ -0,0 +1,24 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/storage_facility/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field
+from typing import Any
+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 Data(OsduCommonResources, AbstractMaster, AbstractFacility):
+    """
+    `data` payload for StorageFacility 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Address: str | None = Field(None, title='Address')
+    """
+    A string holding the complete address.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/storage_facility/v1_1_0.py

@@ -0,0 +1,24 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/storage_facility/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_1_0 import AbstractMaster
+from ...abstract.abstract_facility.v1_1_0 import AbstractFacility
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractFacility):
+    """
+    `data` payload for StorageFacility 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Address: str | None = Field(None, title='Address')
+    """
+    A string holding the complete address.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/storage_facility/v1_2_0.py

@@ -0,0 +1,24 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/storage_facility/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field
+from typing import Any
+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 Data(OsduCommonResources, AbstractMaster, AbstractFacility):
+    """
+    `data` payload for StorageFacility 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Address: str | None = Field(None, title='Address')
+    """
+    A string holding the complete address.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/survey_program/__init__.py

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