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

osdu_models/workproductcomponent/ijk_grid_numerical_aquifer_representation/v1_1_0.py

@@ -0,0 +1,400 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/ijk_grid_numerical_aquifer_representation/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_technical_assurance import v1_1_0
+from ...abstract.abstract_alias_names import v1_0_0
+from ...abstract.abstract_spatial_location import v1_1_0 as v1_1_0_1
+from ...abstract.abstract_geo_context import v1_0_0 as v1_0_0_1
+from ...abstract.abstract_ijk_grid_flow_simulation_boundary_connection 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 record id 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 TimeSeries(BaseModel):
+    """
+    Allow to link the geometry of the representation to a particular index of a time series. This is particularly useful for IJK grids used in geomechanical or basin context where the topology and geometry varies against the time.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    TimeIndex: int = Field(..., examples=[3], title='TimeIndices')
+    """
+    Index of the timestamp of the representation in the associated TimeSeries
+    """
+    TimeSeriesID: constr(
+        pattern=r'^[\w\-\.]+:work-product-component\-\-TimeSeries:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(
+        ...,
+        examples=[
+            'namespace:work-product-component--TimeSeries:85348741-3433-406B-9189-22B298C3E2D2:'
+        ],
+        title='TimeSeriesID',
+    )
+    """
+    Time series the representation is associated to
+    """
+
+
+class IndexableElementCountItem(BaseModel):
+    """
+    Defines the count of a particular indexable element in a representation
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Count: int = Field(..., examples=[10000], title='Count')
+    """
+    The count of indexable element
+    """
+    IndexableElementID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-IndexableElement:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='IndexableElementID')
+    """
+    The indexable element which is counted
+    """
+
+
+class SingleCellAquiferSetItem(BaseModel):
+    """
+    Describe a cell which is a part or the whole definition of an aquifer.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    SupportingGridID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-IjkGridRepresentation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:work-product-component--IjkGridRepresentation:85348741-3433-406B-9189-22B298C3E2D2:'
+        ],
+        title='Supporting Grid',
+    )
+    """
+    The grid where the aquifer cell is defined
+    """
+    I: int | None = Field(None, examples=[10], title='I index')
+    """
+    I index of the cell
+    """
+    J: int | None = Field(None, examples=[20], title='J index')
+    """
+    J index of the cell
+    """
+    K: int | None = Field(None, examples=[30], title='K index')
+    """
+    K index of the cell
+    """
+    Area: float | None = Field(None, examples=[11520.56], title='Area')
+    """
+    Area of the aquifer.
+    """
+    Length: float | None = Field(None, examples=[7045], title='Length')
+    """
+    Length of the aquifer.
+    """
+    Porosity: float | None = Field(None, examples=[0.2], title='Porosity')
+    """
+    Porosity of the aquifer.  Default property, caution if the grid property has got multi realizations.
+    """
+    Permeability: float | None = Field(None, examples=[180], title='Permeability')
+    """
+    Permeability of the aquifer. Default property, caution if the grid property has got multi realizations.
+    """
+    Depth: float | None = Field(None, examples=[2150], title='Depth')
+    """
+    Depth of the aquifer
+    """
+    InitialPressure: float | None = Field(None, examples=[0], title='Initial Pressure')
+    """
+    Initial pressure of the aquifer.  Default property, caution if the grid property has got multi realizations.
+    """
+
+
+class Data(BaseModel):
+    """
+    The group of properties shared by all different kinds of representations.
+    """
+
+    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.
+    """
+    DDMSDatasets: (
+        list[
+            constr(
+                pattern=r'^(([^:/?#]+):)(\/\/([^/?#]+))(\/[^?#]+)(\?([^#]*))?(#(.*))?'
+            )
+        ]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            [
+                'urn://wddms-3/uuid:20840361-adc0-4842-999b-5639bd07bb38',
+                "eml://rddms-1/dataspace('demo/Volve')/resqml20.obj_ContinuousProperty(1615d8d2-2a2d-482c-885e-14225b89e90c)",
+            ]
+        ],
+        title='DDMS Datasets',
+    )
+    """
+    An array of references to content in Domain Data Management Services represented by this work-product-component. The references are formed as URI following https://www.rfc-editor.org/rfc/rfc3986#page-16. This property is exclusively populated by DDMSs. If a work-product-component is represented in more than one DDMS, DDMSs are obliged to find the specific reference by inspecting the URI's authority values matching the DDMS id.
+    """
+    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_1_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.
+    """
+    NameAliases: list[v1_0_0.AbstractAliasNames] | None = None
+    """
+    Alternative names, including historical, by which this work-product-component is/has been known (it should include all the identifiers).
+    """
+    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_1_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_1_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_1.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.
+    """
+    InterpretationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-AquiferInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Aquifer Interpretation ID')
+    """
+    The reference to the AquiferInterpretation this representation belongs to.
+    """
+    InterpretationName: str | None = Field(
+        None, examples=['My Interpretation'], title='Name of the interpretation'
+    )
+    """
+    Name of the interpretation the representation refers to
+    """
+    TimeSeries_1: TimeSeries | None = Field(
+        None, alias='TimeSeries', title='Time Series'
+    )
+    """
+    Allow to link the geometry of the representation to a particular index of a time series. This is particularly useful for IJK grids used in geomechanical or basin context where the topology and geometry varies against the time.
+    """
+    RealizationIndex: int | None = Field(None, examples=[10], title='Realization Index')
+    """
+    The index of the realization of this representation
+    """
+    IndexableElementCount: list[IndexableElementCountItem] | None = Field(
+        None, title='Counts of Indexable element'
+    )
+    """
+    Several optional indexable element counts
+    """
+    LocalModelCompoundCrsID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-LocalModelCompoundCrs:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='ID of the compound CRS where this representation is given')
+    """
+    Allow to link a local CRS with this representation
+    """
+    SingleCellAquiferSet: list[SingleCellAquiferSetItem] | None = Field(
+        None, title='Single Cell Aquifer Set'
+    )
+    """
+    Describe the aquifer by means of one to many single cell of reservoir grids
+    """
+    ConnectionSet: (
+        list[v1_0_0_2.AbstractIjkGridFlowSimulationBoundaryConnection] | None
+    ) = Field(None, title='Connection Set')
+    """
+    List all connections between the aquifer and reservoir grids.
+    """
+    ExtensionProperties: dict[str, Any] | None = None