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

osdu_models/masterdata/wellbore_opening/v1_2_0.py

@@ -0,0 +1,138 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/wellbore_opening/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_master.v1_2_0 import AbstractMaster
+
+
+class WellboreOpeningState(BaseModel):
+    """
+    The life cycle status of a WellboreOpening at some point in time.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EffectiveDateTime: str | None = Field(None, title='Effective Date Time')
+    """
+    The date and time at which the WellboreOpening state becomes effective.
+    """
+    TerminationDateTime: str | None = Field(None, title='Termination Date Time')
+    """
+    The date and time at which the WellboreOpening state is no longer in effect.
+    """
+    WellboreOpeningStateTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellboreOpeningStateType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='WellboreOpening State Type ID')
+    """
+    WellboreOpening State Type is a set of major phases that are significant to regulators and/or business stakeholders.
+    """
+    Remark: str | None = Field(None, title='Remark')
+    """
+    A comment or remark attributed to the state.
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for WellboreOpening 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore')
+    """
+    Business natural key or code of the Wellbore to which this record belongs
+    """
+    Name: str | None = Field(None, title='Name')
+    """
+    Name/Label for WellboreOpening i.e. for display on log
+    """
+    Description: str | None = Field(None, title='Description')
+    """
+    A remark, comment or generic description.
+    """
+    WellboreOpeningStates: list[WellboreOpeningState] | None = Field(
+        None, title='Wellbore Opening States'
+    )
+    """
+    The history of life cycle states this WellboreOpening has been through.
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='VerticalMeasurement'
+    )
+    """
+    The vertical measurement reference for the interval top and base. Either VerticalMeasurement with supplementing type properties or VerticalMeasurementID (an external vertical reference defined in the object VerticalReferenceEntityID) are populated.
+    """
+    WellboreOpeningTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-WellboreOpeningType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Wellbore Opening Type ID')
+    """
+    The type of Wellbore Opening created along the wellbore reservoir interval. Note: does not include GravelPack which is placed behind the opening, see IsGravelPack.
+    """
+    IsGravelPack: bool | None = Field(None, title='Is Gravel-Pack')
+    """
+    Has the wellbore opening interval been gravel-packed.
+    """
+    MeasuredDepthTop: float | None = Field(None, title='MeasuredDepthTop')
+    """
+    This is the top MD of the interval (copied from Perf Interval). For the instance of a Packer being set mid-Interval, you'd split into 2 Wellbore Openings w/ the top of the bottom interval being the bottom of the packer. Note that the original Perf Interval would not be changed for this occurrence; instead the Wellbore Opening would be split to reflect this.
+    """
+    MeasuredDepthBase: float | None = Field(None, title='MeasuredDepthBase')
+    """
+    This is the bottom MD of the interval (copied from Perf Interval)
+    """
+    PerforationIntervalID: (
+        constr(
+            pattern=r'^[\w\-\.]+:master-data\-\-PerforationInterval:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Associated Perforation Interval ID')
+    """
+    Perf Interval which created the Wellbore Opening — this would be absent for open hole or slotted liner.
+    """
+    IsolatedIntervalIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-IsolatedInterval:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Associated Isolated Interval IDs')
+    """
+    A list of Associated Isolated Interval IDs
+    """
+    ReservoirIDs: (
+        list[
+            constr(pattern=r'^[\w\-\.]+:master-data\-\-Reservoir:[\w\-\.\:\%]+:[0-9]*$')
+        ]
+        | None
+    ) = Field(None, title='Reservoir IDs')
+    """
+    The relationships to reservoirs, to which this WellboreOpening connects. In the most common cases this will be a single reservoir. This array can be left empty when the ReservoirSegmentIDs property is populated since each ReservoirSegment will identify a unique Reservoir.
+    """
+    ReservoirSegmentIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:master-data\-\-ReservoirSegment:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Reservoir Segment IDs')
+    """
+    The relationship to the ReservoirSegments, to which this WellboreOpening connects. ReservoirSegments offer a finer granularity of connection. ReservoirSegmentIDs may stay empty in case of reservoirs not sub-divided into ReservoirSegments.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/__init__.py

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

osdu_models/workproductcomponent/activity/__init__.py

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

osdu_models/workproductcomponent/activity/v1_0_0.py

@@ -0,0 +1,28 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/activity/v1_0_0.json
+
+from __future__ import annotations
+from typing import Any
+from pydantic import ConfigDict
+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,
+)
+from ...abstract.abstract_wpcactivity.v1_0_0 import AbstractWPCActivity
+
+
+class Data(
+    OsduCommonResources,
+    AbstractWPCGroupType,
+    AbstractWorkProductComponent,
+    AbstractWPCActivity,
+):
+    """
+    `data` payload for Activity 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/activity/v1_1_0.py

@@ -0,0 +1,28 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/activity/v1_1_0.json
+
+from __future__ import annotations
+from typing import Any
+from pydantic import ConfigDict
+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_1_0 import (
+    AbstractWorkProductComponent,
+)
+from ...abstract.abstract_wpcactivity.v1_1_0 import AbstractWPCActivity
+
+
+class Data(
+    OsduCommonResources,
+    AbstractWPCGroupType,
+    AbstractWorkProductComponent,
+    AbstractWPCActivity,
+):
+    """
+    `data` payload for Activity 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/activity/v1_2_0.py

@@ -0,0 +1,28 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/activity/v1_2_0.json
+
+from __future__ import annotations
+from typing import Any
+from pydantic import ConfigDict
+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,
+)
+from ...abstract.abstract_wpcactivity.v1_1_0 import AbstractWPCActivity
+
+
+class Data(
+    OsduCommonResources,
+    AbstractWPCGroupType,
+    AbstractWorkProductComponent,
+    AbstractWPCActivity,
+):
+    """
+    `data` payload for Activity 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/activity/v1_3_0.py

@@ -0,0 +1,28 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/activity/v1_3_0.json
+
+from __future__ import annotations
+from typing import Any
+from pydantic import ConfigDict
+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,
+)
+from ...abstract.abstract_wpcactivity.v1_2_0 import AbstractWPCActivity
+
+
+class Data(
+    OsduCommonResources,
+    AbstractWPCGroupType,
+    AbstractWorkProductComponent,
+    AbstractWPCActivity,
+):
+    """
+    `data` payload for Activity 1.3.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/activity/v1_4_0.py

@@ -0,0 +1,28 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/activity/v1_4_0.json
+
+from __future__ import annotations
+from typing import Any
+from pydantic import ConfigDict
+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 Data(
+    OsduCommonResources,
+    AbstractWPCGroupType,
+    AbstractWorkProductComponent,
+    AbstractWPCActivity,
+):
+    """
+    `data` payload for Activity 1.4.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/aquifer_interpretation/__init__.py

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

osdu_models/workproductcomponent/aquifer_interpretation/v1_0_0.py

@@ -0,0 +1,246 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/aquifer_interpretation/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_technical_assurance import v1_0_0
+from ...abstract.abstract_spatial_location import v1_0_0 as v1_0_0_1
+from ...abstract.abstract_geo_context import v1_0_0 as v1_0_0_2
+
+
+class Artefact(BaseModel):
+    """
+    An array of Artefacts - each artefact has a Role, Resource tuple. An artefact is distinct from the file, in the sense certain valuable information is generated during loading process (Artefact generation process). Examples include retrieving location data, performing an OCR which may result in the generation of artefacts which need to be preserved distinctly
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RoleID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ArtefactRole:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The SRN of this artefact's role.
+    """
+    ResourceKind: (
+        constr(pattern=r'^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:[0-9]+.[0-9]+.[0-9]+$') | None
+    ) = None
+    """
+    The kind or schema ID of the artefact. Resolvable with the Schema Service.
+    """
+    ResourceID: (
+        constr(pattern=r'^[\w\-\.]+:dataset\-\-[\w\-\.]+:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = None
+    """
+    The SRN which identifies this OSDU Artefact resource.
+    """
+
+
+class LineageAssertion(BaseModel):
+    """
+    Defines relationships with other objects (any kind of Resource) upon which this work product component depends.  The assertion is directed only from the asserting WPC to ancestor objects, not children.  It should not be used to refer to files or artefacts within the WPC -- the association within the WPC is sufficient and Artefacts are actually children of the main WPC file. They should be recorded in the data.Artefacts[] array.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ID: constr(pattern=r'^[\w\-\.]+:[\w\-\.]+:[\w\-\.\:\%]+:[0-9]*$') | None = None
+    """
+    The object reference identifying the DIRECT, INDIRECT, REFERENCE dependency.
+    """
+    LineageRelationshipType: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-LineageRelationshipType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Used by LineageAssertion to describe the nature of the line of descent of a work product component from a prior Resource, such as DIRECT, INDIRECT, REFERENCE.  It is not for proximity (number of nodes away), it is not to cover all the relationships in a full ontology or graph, and it is not to describe the type of activity that created the asserting WPC.  LineageAssertion does not encompass a full provenance, process history, or activity model.
+    """
+
+
+class Data(BaseModel):
+    """
+    The group of properties shared by different kinds of interpretations
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ResourceHomeRegionID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-OSDURegion:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Resource Home Region ID')
+    """
+    The name of the home [cloud environment] region for this OSDU resource object.
+    """
+    ResourceHostRegionIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-OSDURegion:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Resource Host Region ID')
+    """
+    The name of the host [cloud environment] region(s) for this OSDU resource object.
+    """
+    ResourceCurationStatus: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ResourceCurationStatus:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resource Curation Status')
+    """
+    Describes the current Curation status.
+    """
+    ResourceLifecycleStatus: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ResourceLifecycleStatus:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resource Lifecycle Status')
+    """
+    Describes the current Resource Lifecycle status.
+    """
+    ResourceSecurityClassification: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ResourceSecurityClassification:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resource Security Classification')
+    """
+    Classifies the security level of the resource.
+    """
+    Source: str | None = Field(None, title='Data Source')
+    """
+    The entity that produced the record, or from which it is received; could be an organization, agency, system, internal team, or individual. For informational purposes only, the list of sources is not governed.
+    """
+    ExistenceKind: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ExistenceKind:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Existence Kind')
+    """
+    Where does this data resource sit in the cradle-to-grave span of its existence?
+    """
+    TechnicalAssuranceID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TechnicalAssuranceType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Technical Assurance ID')
+    """
+    DEPRECATED: Describes a record's overall suitability for general business consumption based on data quality. Clarifications: Since Certified is the highest classification of suitable quality, any further change or versioning of a Certified record should be carefully considered and justified. If a Technical Assurance value is not populated then one can assume the data has not been evaluated or its quality is unknown (=Unevaluated). Technical Assurance values are not intended to be used for the identification of a single "preferred" or "definitive" record by comparison with other records.
+    """
+    Datasets: (
+        list[constr(pattern=r'^[\w\-\.]+:dataset\-\-[\w\-\.]+:[\w\-\.\:\%]+:[0-9]*$')]
+        | None
+    ) = None
+    """
+    The record id, which identifies this OSDU File or dataset resource.
+    """
+    Artefacts: list[Artefact] | None = None
+    """
+    An array of Artefacts - each artefact has a Role, Resource tuple. An artefact is distinct from the file, in the sense certain valuable information is generated during loading process (Artefact generation process). Examples include retrieving location data, performing an OCR which may result in the generation of artefacts which need to be preserved distinctly
+    """
+    IsExtendedLoad: bool | None = None
+    """
+    A flag that indicates if the work product component is undergoing an extended load.  It reflects the fact that the work product component is in an early stage and may be updated before finalization.
+    """
+    IsDiscoverable: bool | None = None
+    """
+    A flag that indicates if the work product component is searchable, which means covered in the search index.
+    """
+    TechnicalAssurances: list[v1_0_0.AbstractTechnicalAssurance] | None = Field(
+        None, title='Technical Assurances'
+    )
+    """
+    Describes a record's overall suitability for general business consumption based on data quality. Clarifications: Since Certified is the highest classification of suitable quality, any further change or versioning of a Certified record should be carefully considered and justified. If a Technical Assurance value is not populated then one can assume the data has not been evaluated or its quality is unknown (=Unevaluated). Technical Assurance values are not intended to be used for the identification of a single "preferred" or "definitive" record by comparison with other records.
+    """
+    Name: str | None = None
+    """
+    Name
+    """
+    Description: str | None = None
+    """
+    Description.  Summary of the work product component.  Not the same as Remark which captures thoughts of creator about the wpc.
+    """
+    CreationDateTime: str | None = None
+    """
+    Date that a resource (work  product component here) is formed outside of OSDU before loading (e.g. publication date).
+    """
+    Tags: list[str] | None = None
+    """
+    Array of key words to identify the work product, especially to help in search.
+    """
+    SpatialPoint: v1_0_0_1.AbstractSpatialLocation | None = None
+    """
+    A centroid point that reflects the locale of the content of the work product component (location of the subject matter).
+    """
+    SpatialArea: v1_0_0_1.AbstractSpatialLocation | None = None
+    """
+    A polygon boundary that reflects the locale of the content of the work product component (location of the subject matter).
+    """
+    GeoContexts: list[v1_0_0_2.AbstractGeoContext] | None = None
+    """
+    List of geographic entities which provide context to the WPC.  This may include multiple types or multiple values of the same type.
+    """
+    SubmitterName: str | None = None
+    """
+    Name of the person that first submitted the work product component to OSDU.
+    """
+    BusinessActivities: list[str] | None = None
+    """
+    Array of business processes/workflows that the work product component has been through (ex. well planning, exploration).
+    """
+    AuthorIDs: list[str] | None = Field(None, title='Author IDs')
+    """
+    Array of Authors' names of the work product component.  Could be a person or company entity.
+    """
+    LineageAssertions: list[LineageAssertion] | None = None
+    """
+    Defines relationships with other objects (any kind of Resource) upon which this work product component depends.  The assertion is directed only from the asserting WPC to ancestor objects, not children.  It should not be used to refer to files or artefacts within the WPC -- the association within the WPC is sufficient and Artefacts are actually children of the main WPC file. They should be recorded in the data.Artefacts[] array.
+    """
+    OlderPossibleAge: float | None = Field(
+        None, examples=[100], title='OlderPossibleAge'
+    )
+    """
+    Represents the older possible age for the interpretation. Expressed in geological time as millions of years [Ma], and the value must be positive. The age value is not subject to normalization.
+    """
+    YoungerPossibleAge: float | None = Field(
+        None, examples=[80], title='YoungerPossibleAge'
+    )
+    """
+    Represents the younger possible age for the interpretation. Expressed in geological time as millions of years [Ma], and the value must be positive. The age value is not subject to normalization.
+    """
+    DomainTypeID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-DomainType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--DomainType:Time:'],
+        title='DomainTypeID',
+    )
+    """
+    Describes the domain of the interpretation: Depth, Time, Mixed
+    """
+    FeatureID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(master-data\-\-RockVolumeFeature|work-product-component\-\-LocalRockVolumeFeature):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Aquifer ID')
+    """
+    The reference to a local rock volume feature to which this interpretation is associated.
+    """
+    FeatureName: str | None = Field(None, title='FeatureName')
+    """
+    Name of the feature the Interpretation refers to
+    """
+    ExtensionProperties: dict[str, Any] | None = None