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

osdu_models/workproductcomponent/reservoir_compartment_interpretation/v1_2_0.py

@@ -0,0 +1,343 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/reservoir_compartment_interpretation/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_technical_assurance import v1_2_0
+from ...abstract.abstract_alias_names import v1_0_0
+from ...abstract.abstract_spatial_location import v1_1_0
+from ...abstract.abstract_geo_context import v1_0_0 as v1_0_0_1
+
+
+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 ReservoirCompartmentUnit(BaseModel):
+    """
+    A subdivision of a reservoir compartment generally corresponding to one geologic unit.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    GeologicUnitID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(work-product-component\-\-GeobodyInterpretation|work-product-component\-\-StratigraphicUnitInterpretation):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:work-product-component--StratigraphicUnitInterpretation:6a11bad8-2db0-4cfd-9828-049c0899ba79:'
+        ],
+        title='GeologicUnit Identifier',
+    )
+    """
+    The stratigraphic or the geobody associated to this Reservoir compartment unit.
+    """
+    RockFluidUnitIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:work-product-component\-\-RockFluidUnitInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(
+        None,
+        examples=[
+            [
+                'namespace:work-product-component--RockFluidUnitInterpretation:2c4d5363-89df-4541-b513-59bac0cdddc4:',
+                'namespace:work-product-component--RockFluidUnitInterpretation:3ba4cbbd-3aaf-461f-9865-5023350a75f0:',
+            ]
+        ],
+        title='Rock Fluid Unit Identifiers',
+    )
+    """
+    The rock fluid unit which are associated to this Reservoir compartment unit.
+    """
+    Identifier: str | None = Field(
+        None, examples=['bad50d43-fcf7-471c-b8a3-4080ddc131c9'], title='Identifier'
+    )
+    """
+    Identifier of the reservoir compartment unit. It should be an UUID ideally. Used to be able to easier reference a reservoir compartment from other WPC.
+    """
+
+
+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.
+    """
+    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_2_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.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.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.
+    """
+    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.
+    """
+    MeanPossibleAge: float | None = Field(None, examples=[90], title='MeanPossibleAge')
+    """
+    Represents the mean 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|master-data\-\-RockVolumeFeature|work-product-component\-\-LocalModelFeature|work-product-component\-\-LocalRockVolumeFeature):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Feature Identifier')
+    """
+    Reference to the Feature this Interpretation refers to.
+    """
+    FeatureName: str | None = Field(None, title='FeatureName')
+    """
+    Name of the feature the Interpretation refers to
+    """
+    ReservoirCompartmentUnits: list[ReservoirCompartmentUnit] | None = Field(
+        None, title='ReservoirCompartmentUnits'
+    )
+    """
+    A collection of subdivisions of a reservoir compartment generally corresponding to one geologic unit.
+    """
+    BoundaryIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:(work-product-component\-\-HorizonInterpretation|work-product-component\-\-FaultInterpretation|work-product-component\-\-GeobodyBoundaryInterpretation):[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Boundary Identifiers')
+    """
+    References to the surfaces which delimit the reservoir compartment.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/reservoir_estimated_volumes/__init__.py

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

osdu_models/workproductcomponent/reservoir_estimated_volumes/v1_0_0.py

@@ -0,0 +1,67 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/reservoir_estimated_volumes/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_column_based_table import v1_1_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 ReservoirEstimatedVolumes 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EstimatedVolumeTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirEstimatedVolumeType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Estimated Volume Type ID')
+    """
+    The discriminator type references scoping the dataset to either Estimated In-Place Volumes or Estimated Ultimate Recoverable Volumes.
+    """
+    ParentObjectID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(master-data\-\-Field|master-data\-\-Reservoir|master-data\-\-ReservoirSegment):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='ParentObjectID')
+    """
+    Identifier of the parent object those estimations are computed for (Field, Reservoir, Reservoir Segment)
+    """
+    EstimationName: str = Field(..., title='Estimation Name')
+    """
+    A name to describe the set of estimated volumes.
+    """
+    EstimationDate: str | None = Field(None, title='Estimation Date')
+    """
+    Date the estimation of volumes were run.
+    """
+    HydrocarbonTypeIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-WellProductType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Hydrocarbon Type Identifier')
+    """
+    The types of hydrocarbons present in the reservoir. When there is only one value specified, it represents the dominant hydrocarbon present. When multiple values are specified, the first value represents the dominant hydrocarbon, the next value represents the secondary, and so on.
+    """
+    EffectiveEstimationYear: str | None = Field(
+        None, examples=['2022'], title='EffectiveEstimationYear'
+    )
+    """
+    Year for which the estimation of volumes is effective.
+    """
+    Volumes: v1_1_0.AbstractColumnBasedTable | None = Field(None, title='Volumes')
+    """
+    The column based table with the estimated volumes.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/reservoir_estimated_volumes/v1_1_0.py

@@ -0,0 +1,67 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/reservoir_estimated_volumes/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_column_based_table import v1_2_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 ReservoirEstimatedVolumes 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EstimatedVolumeTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirEstimatedVolumeType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Estimated Volume Type ID')
+    """
+    The discriminator type references scoping the dataset to either Estimated In-Place Volumes or Estimated Ultimate Recoverable Volumes.
+    """
+    ParentObjectID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(master-data\-\-Field|master-data\-\-Reservoir|master-data\-\-ReservoirSegment):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='ParentObjectID')
+    """
+    Identifier of the parent object those estimations are computed for (Field, Reservoir, Reservoir Segment)
+    """
+    EstimationName: str = Field(..., title='Estimation Name')
+    """
+    A name to describe the set of estimated volumes.
+    """
+    EstimationDate: str | None = Field(None, title='Estimation Date')
+    """
+    Date the estimation of volumes were run.
+    """
+    HydrocarbonTypeIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-WellProductType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Hydrocarbon Type Identifier')
+    """
+    The types of hydrocarbons present in the reservoir. When there is only one value specified, it represents the dominant hydrocarbon present. When multiple values are specified, the first value represents the dominant hydrocarbon, the next value represents the secondary, and so on.
+    """
+    EffectiveEstimationYear: str | None = Field(
+        None, examples=['2022'], title='EffectiveEstimationYear'
+    )
+    """
+    Year for which the estimation of volumes is effective.
+    """
+    Volumes: v1_2_0.AbstractColumnBasedTable | None = Field(None, title='Volumes')
+    """
+    The column based table with the estimated volumes.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/reservoir_estimated_volumes/v1_1_1.py

@@ -0,0 +1,67 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/reservoir_estimated_volumes/v1_1_1.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_column_based_table import v1_2_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 Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for ReservoirEstimatedVolumes 1.1.1.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EstimatedVolumeTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirEstimatedVolumeType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Estimated Volume Type ID')
+    """
+    The discriminator type references scoping the dataset to either Estimated In-Place Volumes or Estimated Ultimate Recoverable Volumes.
+    """
+    ParentObjectID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(master-data\-\-Field|master-data\-\-Reservoir|master-data\-\-ReservoirSegment):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='ParentObjectID')
+    """
+    Identifier of the parent object those estimations are computed for (Field, Reservoir, Reservoir Segment)
+    """
+    EstimationName: str = Field(..., title='Estimation Name')
+    """
+    A name to describe the set of estimated volumes.
+    """
+    EstimationDate: str | None = Field(None, title='Estimation Date')
+    """
+    Date the estimation of volumes were run.
+    """
+    HydrocarbonTypeIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:reference-data\-\-WellProductType:[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Hydrocarbon Type Identifier')
+    """
+    The types of hydrocarbons present in the reservoir. When there is only one value specified, it represents the dominant hydrocarbon present. When multiple values are specified, the first value represents the dominant hydrocarbon, the next value represents the secondary, and so on.
+    """
+    EffectiveEstimationYear: str | None = Field(
+        None, examples=['2022'], title='EffectiveEstimationYear'
+    )
+    """
+    Year for which the estimation of volumes is effective.
+    """
+    Volumes: v1_2_1.AbstractColumnBasedTable | None = Field(None, title='Volumes')
+    """
+    The column based table with the estimated volumes.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/reservoir_model_scenario/__init__.py

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

osdu_models/workproductcomponent/reservoir_model_scenario/v1_0_0.py

@@ -0,0 +1,58 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/reservoir_model_scenario/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+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 ReservoirModelScenario 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ModelName: str = Field(..., title='Model Name')
+    """
+    Name of the model scenario
+    """
+    ModelVersionNumber: float = Field(..., title='Model Version Number')
+    """
+    Version of the iterative scenario
+    """
+    ModelReasonDescription: str | None = Field(None, title='Model Reason Description')
+    """
+    Free text to describe shortly the key hypothesis if this specific model. Should be used to capture rationale to create this scenario.
+    """
+    ReservoirID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Reservoir:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Reservoir Identifier')
+    """
+    Identifier of the head "Reservoir" object this model is referring to
+    """
+    ReservoirSegmentCollectionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-PersistedCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reservoir Segment Collection Identifier')
+    """
+    Identifier of the set of reservoir segments this model is encapsulating.
+    """
+    EarthModelID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-EarthModelInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Earth Model Identifier')
+    """
+    Identifier of the head Earth Model Entity this scenario is described by.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/reservoir_simulation_equilibrium_model/__init__.py

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