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

osdu_models/workproductcomponent/fluid_boundary_interpretation/v1_2_0.py

@@ -0,0 +1,290 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/fluid_boundary_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 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\-\-BoundaryFeature|work-product-component\-\-LocalBoundaryFeature):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:work-product-component--LocalBoundaryFeature:01038741-3433-406B-9189-22B298C3E2A2:'
+        ],
+        title='Feature ID',
+    )
+    """
+    Reference to the local boundary Feature the interpretation refers to.
+    """
+    FeatureName: str | None = Field(None, title='FeatureName')
+    """
+    Name of the feature the Interpretation refers to
+    """
+    FluidContactTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FluidContactType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='FluidContactTypeID')
+    """
+    Describes the fluid Contact boundary type ( such as a gas-oil contact (GOC), a water-oil contact (WOC), a gas-oil contact (GOC), or seal)
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/fluid_model/__init__.py

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

osdu_models/workproductcomponent/fluid_model/v1_0_0.py

@@ -0,0 +1,203 @@
+# generated by datamodel-codegen:
+#   filename:  workproductcomponent/fluid_model/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_contact import v1_1_0
+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 ModelPropertyFormulationMethod(BaseModel):
+    """
+    This captures information around the fluid model definition property and the methodology used in estimating its property values.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ModelPropertyTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FluidModelPropertyType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Model Property Type ID')
+    """
+    Identifies the fluid model property available in the model definition. Typical properties referenced here will include phase equilibrium values, densities, water compressibilities and viscosities.
+    """
+    ModelPropertyFormulationMethodID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FluidModelPropertyFormulationMethod:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Model Property Formulation Method ID')
+    """
+    Identifies the formulation method used in generating the numerical values assigned to the model property. E.g, Peng-Robinson
+    """
+
+
+class BasisOfModelling(BaseModel):
+    """
+    This set of attributes represents the context surrounding the processes used in running through model characterization.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    InputDataCollectionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-PersistedCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:work-product-component--PersistedCollection:f3e451d1-9d49-559f-93d8-2e36722016fb:'
+        ],
+        title='Input Data Collection ID',
+    )
+    """
+    Identifies the Persisted Collection containing relevant data used to derive this model, except for Samples Analysis, which are identified by InputSampleAnalysisIDs.
+    """
+    ModelPropertyFormulationMethods: list[ModelPropertyFormulationMethod] | None = (
+        Field(None, title='Model Property Formulation Methods')
+    )
+    """
+    This provides an array of fluid model definition properties and the methodology used in estimating its property values.
+    """
+    ModellingApplicationsUsed: list[str] | None = Field(
+        None, title='Modelling Applications Used'
+    )
+    """
+    The software applications used in creating this model. For example, this could be a PVT software application that is used to create the tabular 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.
+    """
+    IsOptimizedForEnhancedRecoveryStudies: bool | None = Field(
+        None, title='Optimized For Enhanced Recovery Studies'
+    )
+    """
+    Indicates whether or not this model is intended to be applied for enhanced recovery studies.
+    """
+    IsModelPvtOptimized: bool | None = Field(None, title='Is Model Pvt Optimized')
+    """
+    Indicates whether or not this fluid model is optimized or generated from an optimized application model using required PVT data.
+    """
+    IsModelViscosityOptimized: bool | None = Field(
+        None, title='Is Model Viscosity Optimized'
+    )
+    """
+    Indicates whether or not the fluid model is optimized or generated from an optimized application model on validated viscosity data.
+    """
+    IsCompositionLumped: bool | None = Field(None, title='Is Composition Lumped')
+    """
+    Indicates whether or not the components described in the model are lumped, meaning the list of components has some components combined together, resulting in a more limited list as compared with the reported compositional analysis, which has the full, extended, component list. A "false" value indicates the components are not lumped, but rather extended, as found in the full compositional analysis. This is mostly applicable in Equation of State Model scenarios, with "true" being most common to support the Reservoir Simulation workflow.
+    """
+    ComponentCount: float | None = Field(None, title='Component Count')
+    """
+    This provides the number of components used in characterizing the model. This is mostly applicable in Equation of State Model scenarios.
+    """
+    BlackOilFlashMechanismAppliedID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BlackOilFlashMechanismApplied:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Black Oil Flash Mechanism Applied ID')
+    """
+    Identifies the liberation or flash process that was selected as most likely to represent the depletion in the reservoir, and therefore applied to create the Black Oil model. This is only applicable for Black Oil models.
+    """
+
+
+class Data(OsduCommonResources, AbstractWPCGroupType, AbstractWorkProductComponent):
+    """
+    `data` payload for FluidModel 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FluidModelTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FluidModelType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Fluid Model Type ID')
+    """
+    Identifies the type of model used. Models can support one or more business contexts. E.g., for Reservoir Simulation, key types of fluid models are Black Oil, Compositional, and Thermal Compositional.
+    """
+    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\-\-FluidModel:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Parent Model ID')
+    """
+    This is used, as a form of lineage, to explicitly indicate the fluid model OSDU record from which this fluid model was derived. Only to be used in the case that this fluid 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.
+    """
+    ModellingContacts: list[v1_1_0.AbstractContact] | None = Field(
+        None, title='Modelling Contacts'
+    )
+    """
+    Information about the analysts responsible for creating the model.
+    """
+    ModelAreaOfInterestIDs: (
+        list[
+            constr(
+                pattern=r'^[\w\-\.]+:(master-data\-\-Field|master-data\-\-Reservoir|master-data\-\-ReservoirSegment|master-data\-\-Wellbore|master-data\-\-GenericFacility|work-product-component\-\-WellboreIntervalSet):[\w\-\.\:\%]+:[0-9]*$'
+            )
+        ]
+        | None
+    ) = Field(None, title='Model Area Of Interest IDs')
+    """
+    A list of specific areas or business objects within which this model definition can be applied; E.g. Reservoir, ReservoirSegment, or Wellbore.
+    """
+    IsApplicableForThermalSimulation: bool | None = Field(
+        None, title='Is Applicable For Thermal Simulation'
+    )
+    """
+    Indicates whether or not this model can be applied for simulation of thermal systems (thermodynamic systems in which the temperature of the system varies, as opposed to isothermal systems, in which the temperature remains constant).
+    """
+    FluidModelSaturationTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FluidModelSaturationType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Fluid Model Saturation Type ID')
+    """
+    Identifies the type of saturation system the model was built for, such as a bubble point or a dew point fluid system.
+    """
+    HasVariableDepthFluidProperties: bool | None = Field(
+        None, title='Has Variable Depth Fluid Properties'
+    )
+    """
+    Indicates whether or not this fluid model consists of composition or other fluid properties (implied by Fluid Model Type) that vary by depth.
+    """
+    Remarks: list[v1_0_0.AbstractRemark] | None = Field(None, title='Remarks')
+    """
+    An array containing operational or quality comments pertaining to the fluid model represented by this work product component.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/workproductcomponent/formation_integrity_test/__init__.py

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