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

osdu_models/workproductcomponent/reservoir_simulation_rock_physics_model/v1_0_0.py

@@ -0,0 +1,131 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/reservoir_simulation_rock_physics_model/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_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 BasisOfModelling(BaseModel):
+    """
+    This set of attributes represents the context surrounding the processes used in running through model characterization.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    CompressibilityModelInputSampleAnalysisIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:work-product-component\-\-SamplesAnalysis:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Compressibility Model Input Sample Analysis IDs')
+    """
+    Identifiers of the Samples Analysis records from which this model has been derived.
+    """
+    CompressibilityModelInputDataCollectionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-PersistedCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Compressibility Model Input Data Collection ID')
+    """
+    Identifies the Persisted Collection containing relevant data used to derive this model, except for SamplesAnalysis, which are identified by CompressibilityModelInputSampleAnalysisIDs.
+    """
+    ThermalModelInputSampleAnalysisIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:work-product-component\-\-SamplesAnalysis:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Thermal Model Input Sample Analysis IDs')
+    """
+    Identifiers of the Samples Analysis records from which this model has been derived.
+    """
+    ThermalModelInputDataCollectionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-PersistedCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Thermal Model Input Data Collection ID')
+    """
+    Identifies the Persisted Collection containing relevant data used to derive this model, except for SamplesAnalysis, which are identified by ThermalModelInputSampleAnalysisIDs.
+    """
+    ModellingApplicationsUsed: list[str] | None = Field(
+        None, title='Modelling Applications Used'
+    )
+    """
+    The software applications used in creating this data. Best practice is to also capture the application version.
+    """
+    IntendedWorkflowUsageIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-WorkflowUsageType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Intended Workflow Usage IDs')
+    """
+    Identifies the subsequent business workflows for which this data is intended to be used.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for ReservoirSimulationRockPhysicsModel 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    CompressibilityModelTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CompressibilityModelType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Compressibility Model Type ID')
+    """
+    Identifier of the type of compressibility model used for this rock physics model.
+    """
+    ThermalModelTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ThermalModelType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Thermal Model Type ID')
+    """
+    Identifier of the type of thermal model used for this rock physics model. This is used for the thermal simulations.
+    """
+    BasisOfModelling_1: BasisOfModelling | None = Field(
+        None, alias='BasisOfModelling', title='Basis Of Modelling'
+    )
+    """
+    This set of attributes represents the context surrounding the processes used in running through model characterization.
+    """
+    ParentModelID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-ReservoirSimulationRockPhysicsModel:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Parent Model ID')
+    """
+    This is used, as a form of lineage, to explicitly indicate the model OSDU record from which this model was derived. Only to be used in the case that this model is derived from another.
+    """
+    DatePublished: str | None = Field(None, title='Date Published')
+    """
+    This represents the date the model generated was published and made available to the consumers or downstream applications..
+    """
+    Remarks: list[v1_0_0.AbstractRemark] | None = Field(None, title='Remarks')
+    """
+    An array of remarks that provide more context for this data record.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/reservoir_simulation_run_configuration/__init__.py

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

osdu_models/workproductcomponent/reservoir_simulation_run_configuration/v1_0_0.py

@@ -0,0 +1,90 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/reservoir_simulation_run_configuration/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field
+from typing import Any
+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 Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for ReservoirSimulationRunConfiguration 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    QueueSystem: str | None = Field(
+        None, examples=['local,pbs,slurm,azure-batch'], title='Queue System'
+    )
+    """
+    Identifies the HPC queue system on which job(s) are submitted (e.g. slurm, pbs, azure-batch).
+    """
+    QueueName: str | None = Field(None, title='Queue Name')
+    """
+    Identifies the HPC queue name on which job(s) are submitted.
+    """
+    QueueParameters: str | None = Field(None, title='Queue Parameters')
+    """
+    HPC queue submission parameters (queue system type specific) typically provided as command line options.
+    """
+    SimulatorVersion: str | None = Field(None, title='Simulator Version')
+    """
+    Version of the simulation software
+    """
+    SimulatorName: str | None = Field(None, title='Simulator Name')
+    """
+    Name of the simulation software
+    """
+    SimulatorParameters: str | None = Field(None, title='Simulator Parameters')
+    """
+    Simulator-specific command line parameters controlling the execution.
+    """
+    CPUHardware: str | None = Field(None, title='CPU Hardware')
+    """
+    Hardware specifications of the CPU machine used for simulation, such as the exact cores/chips present. (e.g., AMD EPYC 7V12 (Rome) [x86-64], Intel Xeon Platinum 8168 (Skylake) [x86-64])
+    """
+    GPUHardware: str | None = Field(None, title='GPU Hardware')
+    """
+    Hardware specifications of the GPU machine used for simulation, such as the exact cores/chips present. (e.g., NVIDIA Tesla M60)
+    """
+    MachineType: str | None = Field(None, title='Machine Type')
+    """
+    Machine type or SKU used by for the compute nodes. (e.g., Standard_HB120rs_v2)
+    """
+    InterconnectType: str | None = Field(None, title='Interconnect Type')
+    """
+    Interconnect type for HPC multi-node simulation. (e.g., Ethernet, InfiniBand HDR)
+    """
+    NumberOfNodes: int | None = Field(None, title='Number Of Nodes')
+    """
+    Total number of compute nodes allocated for simulation.
+    """
+    NumberOfProcessors: int | None = Field(None, title='Number Of Processors')
+    """
+    Total number of compute processors (cores) allocated across all nodes.
+    """
+    NumberOfThreadsPerProcess: int | None = Field(
+        None, title='Number Of Threads Per Process'
+    )
+    """
+    Number of threads per process for mixed mode simulation.
+    """
+    Memory: float | None = Field(None, title='Memory')
+    """
+    Total memory allocated for simulation across all nodes (in MB).
+    """
+    NumberOfGPUs: int | None = Field(None, title='Number Of GPUs')
+    """
+    Total number of GPUs allocated across all nodes.
+    """
+    QueueJobID: str | None = Field(None, title='Queue Job ID')
+    """
+    Job ID as issued/allocated by the HPC queue system (queue system type specific)
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/rock_fluid_organization_interpretation/__init__.py

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

osdu_models/workproductcomponent/rock_fluid_organization_interpretation/v1_0_0.py

@@ -0,0 +1,263 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/rock_fluid_organization_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\-\-ModelFeature|work-product-component\-\-LocalModelFeature):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Model Feature Identifier')
+    """
+    Reference to the Feature this Interpretation refers to
+    """
+    FeatureName: str | None = Field(None, title='Model Feature Name')
+    """
+    Name of the feature this Interpretation refers to
+    """
+    MemberIDs: list[
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-RockFluidUnitInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+    ] = Field(
+        ...,
+        examples=[
+            [
+                'namespace:work-product-component--RockFluidUnitInterpretation:a7a81843-9bea-5ce4-913c-f67e4ea154ff:',
+                'namespace:work-product-component--RockFluidUnitInterpretation:aff9a086-3da6-53c0-baef-222c2273a040:',
+            ]
+        ],
+        title='MemberIDs',
+    )
+    """
+    List of RockFluidUnit interpretation parts of the Collection, defined as an array of the member IDs
+    """
+    ExtensionProperties: dict[str, Any] | None = None