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

osdu_models/masterdata/reservoir_segment/v1_1_0.py

@@ -0,0 +1,292 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/reservoir_segment/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_alias_names import v1_0_0
+from ...abstract.abstract_geo_context import v1_0_0 as v1_0_0_1
+from ...abstract.abstract_spatial_location import v1_1_0
+from ...abstract.abstract_technical_assurance import v1_2_0
+
+
+class StatusItem(BaseModel):
+    """
+    The operational or legal status of the reservoir
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StatusTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirStatusType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--ReservoirStatusType:FirstProduction:'],
+        title='Status Type Identifier',
+    )
+    """
+    Status description, e.g., Discovery, FirstProduction, Active, FirstInjection, Abandonned.
+    """
+    StatusDate: str | None = Field(None, title='Status Date')
+    """
+    Date of a status change
+    """
+    EffectiveDateTime: str | None = Field(None, title='Effective Date Time')
+    """
+    The date and time at which the reservoir status type becomes effective.
+    """
+    TerminationDateTime: str | None = Field(None, title='Termination Date Time')
+    """
+    The date and time at which the reservoir status type is no longer in effect.
+    """
+
+
+class CurrentStatus(BaseModel):
+    """
+    Currently active Status of a production model element as exploration, appraisal and development. The operational or legal status of the reservoir.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StatusTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirStatusType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--ReservoirStatusType:FirstProduction:'],
+        title='Status Type Identifier',
+    )
+    """
+    Status description, e.g., Discovery, FirstProduction, Active, FirstInjection, Abandonned.
+    """
+    StatusDate: str | None = Field(None, title='Status Date')
+    """
+    Date of a status change
+    """
+    EffectiveDateTime: str | None = Field(None, title='Effective Date Time')
+    """
+    The date and time at which the reservoir status type becomes effective.
+    """
+    TerminationDateTime: str | None = Field(None, title='Termination Date Time')
+    """
+    The date and time at which the reservoir status type is no longer in effect.
+    """
+
+
+class Data(BaseModel):
+    """
+    This abstract entity gathers all the properties universally required to describe any kind of reservoir - at any level considered (Reservoir, Reservoir Segment,….)
+    """
+
+    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.
+    """
+    NameAliases: list[v1_0_0.AbstractAliasNames] | None = None
+    """
+    Alternative names, including historical, by which this master data is/has been known (it should include all the identifiers).
+    """
+    GeoContexts: list[v1_0_0_1.AbstractGeoContext] | None = None
+    """
+    List of geographic entities which provide context to the master data. This may include multiple types or multiple values of the same type.
+    """
+    SpatialLocation: v1_1_0.AbstractSpatialLocation | None = None
+    """
+    The spatial location information such as coordinates, CRS information (left empty when not appropriate).
+    """
+    VersionCreationReason: str | None = None
+    """
+    This describes the reason that caused the creation of a new version of this master data.
+    """
+    TechnicalAssuranceTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TechnicalAssuranceType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TechnicalAssuranceType:Certified:'],
+        title='Technical Assurance Type ID',
+    )
+    """
+    DEPRECATED: (in favor of more nuanced TechnicalAssurances[] array) Describes a master-data 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.
+    """
+    TechnicalAssurances: list[v1_2_0.AbstractTechnicalAssurance] | None = Field(
+        None, title='Technical Assurances'
+    )
+    """
+    Describes a record's overall suitability for general business consumption in context of one or more workflows/personas based on data quality and reviewer's decisions. 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 = Field(None, title='Name')
+    """
+    Name of the reservoir or reservoir segment.
+    """
+    ReservoirUnitArea: float | None = Field(None, title='ReservoirUnitArea')
+    """
+    The productive area is the measured or estimated total area of the reservoir unit considered, usually the area within the hydrocarbon-water contact.
+    """
+    ReservoirUnitPressureDatumTVDSS: float | None = Field(
+        None, title='Reservoir Unit Pressure Datum True Vertical Depth Subsea'
+    )
+    """
+    This is the true vertical depth of the permanent reservoir unit datum used for pressure. This is measured vertically downwards from mean sea level.
+    """
+    IsSegmented: bool | None = Field(None, title='Is Segmented')
+    """
+    This flag indicates that this reservoir is composed of reservoir segments, and that the characteristics of the segments should be aggregated to best describe the characteristics of the reservoir. When not segmented, the single reservoir segment describes the properties of the entire reservoir. If more than one reservoir segment is defined for this reservoir, this flag should be set and the characteristics for the reservoir should be calculated as summary data over all its reservoir segments.
+    """
+    Status: list[StatusItem] | None = Field(None, title='Status')
+    """
+    Array of Historical Status of a production model element as exploration, appraisal and development. The operational or legal status of the reservoir.
+    """
+    CurrentStatus_1: CurrentStatus | None = Field(
+        None, alias='CurrentStatus', title='Current Status'
+    )
+    """
+    Currently active Status of a production model element as exploration, appraisal and development. The operational or legal status of the reservoir.
+    """
+    SectorID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-PersistedCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Sector Identifier')
+    """
+    Identifier of the Persisted Collection in which are referred the whole set of child segments constituting a comprehensive sector. A Persisted Collection is only used when no full-fledged earth model is available. See also ReservoirCompartmentInterpretationID with CompartmentMemberIdentifier for the earth model usage.
+    """
+    ParentReservoirEntityID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(master-data\-\-Reservoir|master-data\-\-ReservoirSegment):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Parent Reservoir Entity Identifier')
+    """
+    Identifier linking to the parent reservoir entity (It could be either a segment or a reservoir)
+    """
+    CompartmentInterpretationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-ReservoirCompartmentInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reservoir Compartment Interpretation Identifier')
+    """
+    If a full-fledged earth model is built, this property takes the role of SectorID to refer to a ReservoirCompartmentInterpretation.
+    """
+    CompartmentMemberIdentifier: str | None = Field(
+        None, title='Compartment Member Identifier'
+    )
+    """
+    If CompartmentInterpretationID is populated, this identifies the member of the data.ReservoirCompartmentUnits[]. Such a member refers to the intersecting RockFluidUnitInterpretation and StratigraphicUnitInterpretation instances.
+    """
+    IsIsolated: bool | None = Field(None, title='Is Isolated')
+    """
+    This flag indicates that this reservoir segment (usually a fault block) is hydraulically isolated (i.e., not in pressure communication) from other segments in the reservoir.
+    """
+    OriginalHydrocarbonPoreVolume: float | None = Field(
+        None, title='Original Hydrocarbon Pore Volume'
+    )
+    """
+    This is the best estimate of the original hydrocarbon total pore volume of the reservoir segment at initial conditions.
+    """
+    StructuralOrganizationInterpretationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-StructuralOrganizationInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Structural Organization Interpretation ID')
+    """
+    The reference to an earth model structural organization, which contains the list of relevant fault and horizon interpretations for this ReservoirSegment.
+    """
+    ReservoirSegmentTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirSegmentType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reservoir Segment Type Identifier')
+    """
+    Identifier of the reference-data object describing the type of the reservoir segment (note: not a validated field). This brief description is intended to afford the consumer of this data the intent/purpose/use for which this reservoir segment exists.
+    """
+    Remark: str | None = Field(None, title='Remark')
+    """
+    Any relevant remark or comment to characterize this Reservoir Segment
+    """
+    SegmentTopDepthTVDSS: float | None = Field(
+        None, title='Segment TopDepth TVD Subsea'
+    )
+    """
+    For a reservoir zone, this is the average true vertical depth subsea to the top of the zone.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/reservoir_segment/v1_2_0.py

@@ -0,0 +1,298 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/reservoir_segment/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_alias_names import v1_0_0
+from ...abstract.abstract_geo_context import v1_0_0 as v1_0_0_1
+from ...abstract.abstract_spatial_location import v1_1_0
+from ...abstract.abstract_technical_assurance import v1_2_0
+
+
+class StatusItem(BaseModel):
+    """
+    The operational or legal status of the reservoir
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StatusTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirStatusType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--ReservoirStatusType:FirstProduction:'],
+        title='Status Type Identifier',
+    )
+    """
+    Status description, e.g., Discovery, FirstProduction, Active, FirstInjection, Abandonned.
+    """
+    StatusDate: str | None = Field(None, title='Status Date')
+    """
+    Date of a status change
+    """
+    EffectiveDateTime: str | None = Field(None, title='Effective Date Time')
+    """
+    The date and time at which the reservoir status type becomes effective.
+    """
+    TerminationDateTime: str | None = Field(None, title='Termination Date Time')
+    """
+    The date and time at which the reservoir status type is no longer in effect.
+    """
+
+
+class CurrentStatus(BaseModel):
+    """
+    Currently active Status of a production model element as exploration, appraisal and development. The operational or legal status of the reservoir.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    StatusTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirStatusType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--ReservoirStatusType:FirstProduction:'],
+        title='Status Type Identifier',
+    )
+    """
+    Status description, e.g., Discovery, FirstProduction, Active, FirstInjection, Abandonned.
+    """
+    StatusDate: str | None = Field(None, title='Status Date')
+    """
+    Date of a status change
+    """
+    EffectiveDateTime: str | None = Field(None, title='Effective Date Time')
+    """
+    The date and time at which the reservoir status type becomes effective.
+    """
+    TerminationDateTime: str | None = Field(None, title='Termination Date Time')
+    """
+    The date and time at which the reservoir status type is no longer in effect.
+    """
+
+
+class Data(BaseModel):
+    """
+    This abstract entity gathers all the properties universally required to describe any kind of reservoir - at any level considered (Reservoir, Reservoir Segment,….)
+    """
+
+    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.
+    """
+    NameAliases: list[v1_0_0.AbstractAliasNames] | None = None
+    """
+    Alternative names, including historical, by which this master data is/has been known (it should include all the identifiers).
+    """
+    GeoContexts: list[v1_0_0_1.AbstractGeoContext] | None = None
+    """
+    List of geographic entities which provide context to the master data. This may include multiple types or multiple values of the same type.
+    """
+    SpatialLocation: v1_1_0.AbstractSpatialLocation | None = None
+    """
+    The spatial location information such as coordinates, CRS information (left empty when not appropriate).
+    """
+    VersionCreationReason: str | None = None
+    """
+    This describes the reason that caused the creation of a new version of this master data.
+    """
+    TechnicalAssuranceTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-TechnicalAssuranceType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--TechnicalAssuranceType:Certified:'],
+        title='Technical Assurance Type ID',
+    )
+    """
+    DEPRECATED: (in favor of more nuanced TechnicalAssurances[] array) Describes a master-data 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.
+    """
+    TechnicalAssurances: list[v1_2_0.AbstractTechnicalAssurance] | None = Field(
+        None, title='Technical Assurances'
+    )
+    """
+    Describes a record's overall suitability for general business consumption in context of one or more workflows/personas based on data quality and reviewer's decisions. 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 = Field(None, title='Name')
+    """
+    Name of the reservoir or reservoir segment.
+    """
+    ReservoirUnitArea: float | None = Field(None, title='ReservoirUnitArea')
+    """
+    The productive area is the measured or estimated total area of the reservoir unit considered, usually the area within the hydrocarbon-water contact.
+    """
+    ReservoirUnitPressureDatumTVDSS: float | None = Field(
+        None, title='Reservoir Unit Pressure Datum True Vertical Depth Subsea'
+    )
+    """
+    This is the true vertical depth of the permanent reservoir unit datum used for pressure. This is measured vertically downwards from mean sea level.
+    """
+    IsSegmented: bool | None = Field(None, title='Is Segmented')
+    """
+    This flag indicates that this reservoir is composed of reservoir segments, and that the characteristics of the segments should be aggregated to best describe the characteristics of the reservoir. When not segmented, the single reservoir segment describes the properties of the entire reservoir. If more than one reservoir segment is defined for this reservoir, this flag should be set and the characteristics for the reservoir should be calculated as summary data over all its reservoir segments.
+    """
+    Status: list[StatusItem] | None = Field(None, title='Status')
+    """
+    Array of Historical Status of a production model element as exploration, appraisal and development. The operational or legal status of the reservoir.
+    """
+    CurrentStatus_1: CurrentStatus | None = Field(
+        None, alias='CurrentStatus', title='Current Status'
+    )
+    """
+    Currently active Status of a production model element as exploration, appraisal and development. The operational or legal status of the reservoir.
+    """
+    SectorID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-PersistedCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Sector Identifier')
+    """
+    Identifier of the Persisted Collection in which are referred the whole set of child segments constituting a comprehensive sector. A Persisted Collection is only used when no full-fledged earth model is available. See also ReservoirCompartmentInterpretationID with CompartmentMemberIdentifier for the earth model usage.
+    """
+    ParentReservoirEntityID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(master-data\-\-Reservoir|master-data\-\-ReservoirSegment):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Parent Reservoir Entity Identifier')
+    """
+    Identifier linking to the parent reservoir entity (It could be either a segment or a reservoir)
+    """
+    CompartmentInterpretationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-ReservoirCompartmentInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reservoir Compartment Interpretation Identifier')
+    """
+    If a full-fledged earth model is built, this property takes the role of SectorID to refer to a ReservoirCompartmentInterpretation.
+    """
+    CompartmentMemberIdentifier: str | None = Field(
+        None, title='Compartment Member Identifier'
+    )
+    """
+    If CompartmentInterpretationID is populated, this identifies the member of the data.ReservoirCompartmentUnits[]. Such a member refers to the intersecting RockFluidUnitInterpretation and StratigraphicUnitInterpretation instances.
+    """
+    IsIsolated: bool | None = Field(None, title='Is Isolated')
+    """
+    This flag indicates that this reservoir segment (usually a fault block) is hydraulically isolated (i.e., not in pressure communication) from other segments in the reservoir.
+    """
+    OriginalHydrocarbonPoreVolume: float | None = Field(
+        None, title='Original Hydrocarbon Pore Volume'
+    )
+    """
+    This is the best estimate of the original hydrocarbon total pore volume of the reservoir segment at initial conditions.
+    """
+    StructuralOrganizationInterpretationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-StructuralOrganizationInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Structural Organization Interpretation ID')
+    """
+    The reference to an earth model structural organization, which contains the list of relevant fault and horizon interpretations for this ReservoirSegment.
+    """
+    ReservoirSegmentTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirSegmentType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reservoir Segment Type Identifier')
+    """
+    DEPRECATED: Use IntentPurposeUseDescription instead. The use of the reference value list reference-data--ReservoirSegmentType is no longer encouraged. Previously: Identifier of the reference-data object describing the type of the reservoir segment (note: not a validated field). This brief description is intended to afford the consumer of this data the intent/purpose/use for which this reservoir segment exists.
+    """
+    IntentPurposeUseDescription: str | None = Field(
+        None, title='Intent or Purpose or Use Description'
+    )
+    """
+    This brief description is intended to inform the consumer of this data about the intent/purpose/use for which this reservoir segment exists.
+    """
+    Remark: str | None = Field(None, title='Remark')
+    """
+    Any relevant remark or comment to characterize this Reservoir Segment
+    """
+    SegmentTopDepthTVDSS: float | None = Field(
+        None, title='Segment TopDepth TVD Subsea'
+    )
+    """
+    For a reservoir zone, this is the average true vertical depth subsea to the top of the zone.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/reservoir_segment/v2_0_0.py

@@ -0,0 +1,83 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/reservoir_segment/v2_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_master.v1_2_0 import AbstractMaster
+from ...abstract.abstract_generic_reservoir_unit.v2_0_0 import (
+    AbstractGenericReservoirUnit,
+)
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractGenericReservoirUnit):
+    """
+    `data` payload for ReservoirSegment 2.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ParentReservoirEntityID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(master-data\-\-Reservoir|master-data\-\-ReservoirSegment):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Parent Reservoir Entity Identifier')
+    """
+    Identifier linking to the parent reservoir entity (It could be either a segment or a reservoir)
+    """
+    CompartmentInterpretationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-ReservoirCompartmentInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reservoir Compartment Interpretation Identifier')
+    """
+    If a full-fledged earth model is built, this property takes the role of SectorID to refer to a ReservoirCompartmentInterpretation.
+    """
+    CompartmentMemberIdentifier: str | None = Field(
+        None, title='Compartment Member Identifier'
+    )
+    """
+    If CompartmentInterpretationID is populated, this identifies the member of the data.ReservoirCompartmentUnits[]. Such a member refers to the intersecting RockFluidUnitInterpretation and StratigraphicUnitInterpretation instances.
+    """
+    SectorID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-PersistedCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Sector Identifier')
+    """
+    Identifier of the Persisted Collection in which are referred the whole set of child segments constituting a comprehensive sector. A Persisted Collection is only used when no full-fledged earth model is available. See also ReservoirCompartmentInterpretationID with CompartmentMemberIdentifier for the earth model usage.
+    """
+    IsIsolated: bool | None = Field(None, title='Is Isolated')
+    """
+    This flag indicates that this reservoir segment (usually a fault block) is hydraulically isolated (i.e., not in pressure communication) from other segments in the reservoir.
+    """
+    StructuralOrganizationInterpretationID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-StructuralOrganizationInterpretation:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Structural Organization Interpretation ID')
+    """
+    The reference to an earth model structural organization, which contains the list of relevant fault and horizon interpretations for this ReservoirSegment.
+    """
+    ReservoirSegmentTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ReservoirSegmentType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reservoir Segment Type Identifier')
+    """
+    DEPRECATED: Use IntentPurposeUseDescription instead. The use of the reference value list reference-data--ReservoirSegmentType is no longer encouraged. Previously: Identifier of the reference-data object describing the type of the reservoir segment (note: not a validated field). This brief description is intended to afford the consumer of this data the intent/purpose/use for which this reservoir segment exists.
+    """
+    IntentPurposeUseDescription: str | None = Field(
+        None, title='Intent or Purpose or Use Description'
+    )
+    """
+    This brief description is intended to inform the consumer of this data about the intent/purpose/use for which this reservoir segment exists.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/rig/__init__.py

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