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

osdu_models/abstract/abstract_any_crs_feature_collection/v1_1_0.py

@@ -0,0 +1,300 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_any_crs_feature_collection/v1_1_0.json
+
+from __future__ import annotations
+from enum import Enum
+from pydantic import BaseModel, ConfigDict, Field, RootModel, constr
+from typing import Any
+
+
+class Type(Enum):
+    AnyCrsFeatureCollection = 'AnyCrsFeatureCollection'
+
+
+class Type31(Enum):
+    AnyCrsFeature = 'AnyCrsFeature'
+
+
+class Type32(Enum):
+    AnyCrsPoint = 'AnyCrsPoint'
+
+
+class Geometry(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type32
+    coordinates: list[float] = Field(..., min_length=2)
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type33(Enum):
+    AnyCrsLineString = 'AnyCrsLineString'
+
+
+class Coordinate(RootModel[list[float]]):
+    root: list[float]
+
+
+class Geometry17(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type33
+    coordinates: list[Coordinate] = Field(..., min_length=2)
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type34(Enum):
+    AnyCrsPolygon = 'AnyCrsPolygon'
+
+
+class Geometry18(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type34
+    coordinates: list[list[Coordinate]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type35(Enum):
+    AnyCrsMultiPoint = 'AnyCrsMultiPoint'
+
+
+class Geometry19(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type35
+    coordinates: list[list[float]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type36(Enum):
+    AnyCrsMultiLineString = 'AnyCrsMultiLineString'
+
+
+class Geometry20(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type36
+    coordinates: list[list[Coordinate]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type37(Enum):
+    AnyCrsMultiPolygon = 'AnyCrsMultiPolygon'
+
+
+class Geometry21(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type37
+    coordinates: list[list[list[Coordinate]]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type38(Enum):
+    AnyCrsGeometryCollection = 'AnyCrsGeometryCollection'
+
+
+class Type39(Enum):
+    AnyCrsPoint = 'AnyCrsPoint'
+
+
+class Geometries(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type39
+    coordinates: list[float] = Field(..., min_length=2)
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type40(Enum):
+    AnyCrsLineString = 'AnyCrsLineString'
+
+
+class Geometries13(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type40
+    coordinates: list[Coordinate] = Field(..., min_length=2)
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type41(Enum):
+    AnyCrsPolygon = 'AnyCrsPolygon'
+
+
+class Geometries14(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type41
+    coordinates: list[list[Coordinate]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type42(Enum):
+    AnyCrsMultiPoint = 'AnyCrsMultiPoint'
+
+
+class Geometries15(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type42
+    coordinates: list[list[float]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type43(Enum):
+    AnyCrsMultiLineString = 'AnyCrsMultiLineString'
+
+
+class Geometries16(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type43
+    coordinates: list[list[Coordinate]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type44(Enum):
+    AnyCrsMultiPolygon = 'AnyCrsMultiPolygon'
+
+
+class Geometries17(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type44
+    coordinates: list[list[list[Coordinate]]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Geometry22(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type38
+    geometries: list[
+        Geometries
+        | Geometries13
+        | Geometries14
+        | Geometries15
+        | Geometries16
+        | Geometries17
+    ]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Feature(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type31
+    properties: dict[str, Any] | None
+    geometry: (
+        Geometry
+        | Geometry17
+        | Geometry18
+        | Geometry19
+        | Geometry20
+        | Geometry21
+        | Geometry22
+        | None
+    )
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class AbstractAnyCrsFeatureCollection(BaseModel):
+    """
+    A schema like GeoJSON FeatureCollection with a non-WGS 84 CRS context; based on https://geojson.org/schema/FeatureCollection.json. Attention: the coordinate order is fixed: Longitude/Easting/Westing/X first, followed by Latitude/Northing/Southing/Y, optionally height as third coordinate.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type
+    CoordinateReferenceSystemID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CoordinateReferenceSystem:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--CoordinateReferenceSystem:BoundProjected:EPSG::32021_EPSG::15851:'
+        ],
+        title='Coordinate Reference System ID',
+    )
+    """
+    The CRS reference into the CoordinateReferenceSystem catalog.
+    """
+    VerticalCoordinateReferenceSystemID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CoordinateReferenceSystem:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--CoordinateReferenceSystem:Vertical:EPSG::5714:'
+        ],
+        title='Vertical Coordinate Reference System ID',
+    )
+    """
+    The explicit VerticalCRS reference into the CoordinateReferenceSystem catalog. This property stays empty for 2D geometries. Absent or empty values for 3D geometries mean the context may be provided by a CompoundCRS in 'CoordinateReferenceSystemID' or implicitly EPSG:5714 MSL height
+    """
+    VerticalUnitID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--UnitOfMeasure:m:'],
+        title='Vertical Unit ID',
+    )
+    """
+    The explicit vertical unit ID, referring to a reference-data--UnitOfMeasure record; this is only required for features containing 3-dimensional coordinates and undefined vertical CoordinateReferenceSystems; if a VerticalCoordinateReferenceSystemID is populated, the VerticalUnitID is given by the VerticalCoordinateReferenceSystemID's data.CoordinateSystem.VerticalAxisUnitID. The VerticalUnitID definition overrides any self-contained definition in persistableReferenceUnitZ.
+    """
+    persistableReferenceCrs: str = Field(
+        ...,
+        examples=[
+            '{"authCode":{"auth":"OSDU","code":"32021079"},"lateBoundCRS":{"authCode":{"auth":"EPSG","code":"32021"},"name":"NAD_1927_StatePlane_North_Dakota_South_FIPS_3302","type":"LBC","ver":"PE_10_9_1","wkt":"PROJCS[\\"NAD_1927_StatePlane_North_Dakota_South_FIPS_3302\\",GEOGCS[\\"GCS_North_American_1927\\",DATUM[\\"D_North_American_1927\\",SPHEROID[\\"Clarke_1866\\",6378206.4,294.9786982]],PRIMEM[\\"Greenwich\\",0.0],UNIT[\\"Degree\\",0.0174532925199433]],PROJECTION[\\"Lambert_Conformal_Conic\\"],PARAMETER[\\"False_Easting\\",2000000.0],PARAMETER[\\"False_Northing\\",0.0],PARAMETER[\\"Central_Meridian\\",-100.5],PARAMETER[\\"Standard_Parallel_1\\",46.18333333333333],PARAMETER[\\"Standard_Parallel_2\\",47.48333333333333],PARAMETER[\\"Latitude_Of_Origin\\",45.66666666666666],UNIT[\\"Foot_US\\",0.3048006096012192],AUTHORITY[\\"EPSG\\",32021]]"},"name":"NAD27 * OGP-Usa Conus / North Dakota CS27 South zone [32021,15851]","singleCT":{"authCode":{"auth":"EPSG","code":"15851"},"name":"NAD_1927_To_WGS_1984_79_CONUS","type":"ST","ver":"PE_10_9_1","wkt":"GEOGTRAN[\\"NAD_1927_To_WGS_1984_79_CONUS\\",GEOGCS[\\"GCS_North_American_1927\\",DATUM[\\"D_North_American_1927\\",SPHEROID[\\"Clarke_1866\\",6378206.4,294.9786982]],PRIMEM[\\"Greenwich\\",0.0],UNIT[\\"Degree\\",0.0174532925199433]],GEOGCS[\\"GCS_WGS_1984\\",DATUM[\\"D_WGS_1984\\",SPHEROID[\\"WGS_1984\\",6378137.0,298.257223563]],PRIMEM[\\"Greenwich\\",0.0],UNIT[\\"Degree\\",0.0174532925199433]],METHOD[\\"NADCON\\"],PARAMETER[\\"Dataset_conus\\",0.0],OPERATIONACCURACY[5.0],AUTHORITY[\\"EPSG\\",15851]]"},"type":"EBC","ver":"PE_10_9_1"}'
+        ],
+        title='CRS Reference',
+    )
+    """
+    The CRS reference as persistableReference string. If populated, the CoordinateReferenceSystemID takes precedence.
+    """
+    persistableReferenceVerticalCrs: str | None = Field(
+        None,
+        examples=[
+            '{"authCode":{"auth":"EPSG","code":"5714"},"name":"MSL_Height","type":"LBC","ver":"PE_10_9_1","wkt":"VERTCS[\\"MSL_Height\\",VDATUM[\\"Mean_Sea_Level\\"],PARAMETER[\\"Vertical_Shift\\",0.0],PARAMETER[\\"Direction\\",1.0],UNIT[\\"Meter\\",1.0],AUTHORITY[\\"EPSG\\",5714]]"}'
+        ],
+        title='Vertical CRS Reference',
+    )
+    """
+    The VerticalCRS reference as persistableReference string. If populated, the VerticalCoordinateReferenceSystemID takes precedence. The property is null or empty for 2D geometries. For 3D geometries and absent or null persistableReferenceVerticalCrs the vertical CRS is either provided via persistableReferenceCrs's CompoundCRS or it is implicitly defined as EPSG:5714 MSL height.
+    """
+    persistableReferenceUnitZ: str | None = Field(
+        None,
+        examples=[
+            '{"scaleOffset":{"scale":1.0,"offset":0.0},"symbol":"m","baseMeasurement":{"ancestry":"Length","type":"UM"},"type":"USO"}'
+        ],
+        title='Z-Unit Reference',
+    )
+    """
+    The unit of measure for the Z-axis (only for 3-dimensional coordinates, where the CRS does not describe the vertical unit). Note that the direction is upwards positive, i.e. Z means height.
+    """
+    features: list[Feature]
+    bbox: list[float] | None = Field(None, min_length=4)

osdu_models/abstract/abstract_bin_grid/__init__.py

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

osdu_models/abstract/abstract_bin_grid/v1_0_0.py

@@ -0,0 +1,103 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_bin_grid/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, constr
+from ..abstract_coordinates import v1_0_0
+from ..abstract_spatial_location import v1_0_0 as v1_0_0_1
+
+
+class AbstractBinGrid(BaseModel):
+    """
+    The shared properties for a bin grid.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    BinGridName: str | None = None
+    """
+    Name of bin grid (e.g., GEOCO_GREENCYN_PHV_2012).  Probably the name as it exists in a separate corporate store if OSDU is not main system.
+    """
+    BinGridTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicBinGridType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Type of bin grid (Acquisition, Processing, Velocity, MagGrav, Magnetics, Gravity, GeologicModel, Reprojected, etc.)
+    """
+    SourceBinGridID: int | None = None
+    """
+    Identifier of the source bin grid as stored in a corporate database/application if OSDU is not main system.
+    """
+    SourceBinGridAppID: str | None = None
+    """
+    Identifier (name) of the corporate database/application that stores the source bin grid definitions if OSDU is not main system.
+    """
+    CoveragePercent: float | None = None
+    """
+    Nominal design fold as intended by the bin grid definition, expressed as the mode in percentage points (60 fold = 6000%).
+    """
+    BinGridDefinitionMethodTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BinGridDefinitionMethodType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    This identifies how the Bin Grid is defined:  4=ABCD four-points method was used to define the grid (P6 parameters are optional and can contain derived values; P6BinNodeIncrementOnIAxis and P6BinNodeIncrementOnJaxis can be used as part of four-point method).  Use a perspective transformation to map between map coordinates and bin coordinates. Note point order.  6=P6 definition method was used to define the bin grid (ABCD points are optional and can contain derived values; ABCDBinGridSpatialLocation must specify the projected CRS).  Use an affine transformation to map between map coordinates and bin coordinates.
+    """
+    ABCDBinGridLocalCoordinates: list[v1_0_0.AbstractCoordinates] | None = None
+    """
+    Array of 4 corner points for bin grid in local coordinates: Point A (min inline, min crossline); Point B (min inline, max crossline); Point C (max inline, min crossline); Point D (max inline, max crossline).  If Point D is not given and BinGridDefinitionMethodTypeID=4, it must be supplied, with its spatial location, before ingestion to create a parallelogram in map coordinate space.  Note correspondence of inline=x, crossline=y.
+    """
+    ABCDBinGridSpatialLocation: v1_0_0_1.AbstractSpatialLocation | None = None
+    """
+    Bin Grid ABCD points containing the projected coordinates, projected CRS and quality metadata.  This attribute is required also for the P6 definition method to define the projected CRS, even if the ABCD coordinates would be optional (recommended to be always calculated).
+    """
+    P6TransformationMethod: int | None = None
+    """
+    EPSG code: 9666 for right-handed, 1049 for left-handed.  See IOGP Guidance Note 373-07-2 and 483-6.
+    """
+    P6BinGridOriginI: float | None = None
+    """
+    Inline coordinate of tie point (e.g., center or A point)
+    """
+    P6BinGridOriginJ: float | None = None
+    """
+    Crossline coordinate of tie point (e.g., center or A point)
+    """
+    P6BinGridOriginEasting: float | None = None
+    """
+    Easting coordinate of tie point (e.g., center or A point)
+    """
+    P6BinGridOriginNorthing: float | None = None
+    """
+    Northing coordinate of tie point (e.g., center or A point)
+    """
+    P6ScaleFactorOfBinGrid: float | None = None
+    """
+    Scale factor for Bin Grid.  If not provided then 1 is assumed. Unit is unity.
+    """
+    P6BinWidthOnIaxis: float | None = None
+    """
+    Distance between two inlines at the given increment apart, e.g., 30 m with P6BinNodeIncrementOnIaxis=1.  Unit from projected CRS in ABCDBinGridSpatialLocation
+    """
+    P6BinWidthOnJaxis: float | None = None
+    """
+    Distance between two crosslines at the given increment apart, e.g., 25 m with P6BinNodeIncrementOnJaxis=4.  Unit from projected CRS in ABCDBinGridSpatialLocation
+    """
+    P6MapGridBearingOfBinGridJaxis: float | None = None
+    """
+    Clockwise angle from grid north (in projCRS) in degrees from 0 to 360 of the direction of increasing crosslines (constant inline), i.e., of the vector from point A to B. 
+    """
+    P6BinNodeIncrementOnIaxis: int | None = None
+    """
+    Increment (positive integer) for the inline coordinate. If not provided then 1 is assumed.  The bin grid definition is expected to have increment 1 and the increment stored with the SeismicTraceData (“inline increment”) takes precedence over the increment set at the BinGrid.  Alternatively the increments are allowed to be defined with the BinGrid, but this should be avoided to allow for variations in sampling in trace data sets.
+    """
+    P6BinNodeIncrementOnJaxis: int | None = None
+    """
+    Increment (positive integer) for the crossline coordinate. If not provided then 1 is assumed.  The bin grid definition is expected to have increment 1 and the increment stored with the SeismicTraceData (“crossline increment”) takes precedence over the increment set at the BinGrid. Alternatively the increments are allowed to be defined with the BinGrid, but this should be avoided to allow for variations in sampling in trace data sets.
+    """

osdu_models/abstract/abstract_bin_grid/v1_1_0.py

@@ -0,0 +1,103 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_bin_grid/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, constr
+from ..abstract_coordinates import v1_0_0
+from ..abstract_spatial_location import v1_1_0
+
+
+class AbstractBinGrid(BaseModel):
+    """
+    The shared properties for a bin grid.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    BinGridName: str | None = None
+    """
+    Name of bin grid (e.g., GEOCO_GREENCYN_PHV_2012).  Probably the name as it exists in a separate corporate store if OSDU is not main system.
+    """
+    BinGridTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-SeismicBinGridType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Type of bin grid (Acquisition, Processing, Velocity, MagGrav, Magnetics, Gravity, GeologicModel, Reprojected, etc.)
+    """
+    SourceBinGridID: int | None = None
+    """
+    Identifier of the source bin grid as stored in a corporate database/application if OSDU is not main system.
+    """
+    SourceBinGridAppID: str | None = None
+    """
+    Identifier (name) of the corporate database/application that stores the source bin grid definitions if OSDU is not main system.
+    """
+    CoveragePercent: float | None = None
+    """
+    Nominal design fold as intended by the bin grid definition, expressed as the mode in percentage points (60 fold = 6000%).
+    """
+    BinGridDefinitionMethodTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BinGridDefinitionMethodType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    This identifies how the Bin Grid is defined:  4=ABCD four-points method was used to define the grid (P6 parameters are optional and can contain derived values; P6BinNodeIncrementOnIAxis and P6BinNodeIncrementOnJaxis can be used as part of four-point method).  Use a perspective transformation to map between map coordinates and bin coordinates. Note point order.  6=P6 definition method was used to define the bin grid (ABCD points are optional and can contain derived values; ABCDBinGridSpatialLocation must specify the projected CRS).  Use an affine transformation to map between map coordinates and bin coordinates.
+    """
+    ABCDBinGridLocalCoordinates: list[v1_0_0.AbstractCoordinates] | None = None
+    """
+    DEPRECATED: Use  AbstractGeoJson.PropertiesBinGridCorners properties inside the ABCDBinGridSpatialLocation. Previously:  Array of 4 corner points for bin grid in local coordinates: Point A (min inline, min crossline); Point B (min inline, max crossline); Point C (max inline, min crossline); Point D (max inline, max crossline).  If Point D is not given and BinGridDefinitionMethodTypeID=4, it must be supplied, with its spatial location, before ingestion to create a parallelogram in map coordinate space.  Note correspondence of inline=x, crossline=y.
+    """
+    ABCDBinGridSpatialLocation: v1_1_0.AbstractSpatialLocation | None = None
+    """
+    Bin Grid ABCD points containing the projected coordinates, projected CRS and quality metadata.  This attribute is required also for the P6 definition method to define the projected CRS, even if the ABCD coordinates would be optional (recommended to be always calculated). It is recommended to populate the GeoJSON/AnyCrsGeoJSON with properties according to the AbstractGeoJson.PropertiesBinGridCorners schema fragment.
+    """
+    P6TransformationMethod: int | None = None
+    """
+    EPSG code: 9666 for right-handed, 1049 for left-handed.  See IOGP Guidance Note 373-07-2 and 483-6.
+    """
+    P6BinGridOriginI: float | None = None
+    """
+    Inline coordinate of tie point (e.g., center or A point)
+    """
+    P6BinGridOriginJ: float | None = None
+    """
+    Crossline coordinate of tie point (e.g., center or A point)
+    """
+    P6BinGridOriginEasting: float | None = None
+    """
+    Easting coordinate of tie point (e.g., center or A point)
+    """
+    P6BinGridOriginNorthing: float | None = None
+    """
+    Northing coordinate of tie point (e.g., center or A point)
+    """
+    P6ScaleFactorOfBinGrid: float | None = None
+    """
+    Scale factor for Bin Grid.  If not provided then 1 is assumed. Unit is unity.
+    """
+    P6BinWidthOnIaxis: float | None = None
+    """
+    Distance between two inlines at the given increment apart, e.g., 30 m with P6BinNodeIncrementOnIaxis=1.  Unit from projected CRS in ABCDBinGridSpatialLocation
+    """
+    P6BinWidthOnJaxis: float | None = None
+    """
+    Distance between two crosslines at the given increment apart, e.g., 25 m with P6BinNodeIncrementOnJaxis=4.  Unit from projected CRS in ABCDBinGridSpatialLocation
+    """
+    P6MapGridBearingOfBinGridJaxis: float | None = None
+    """
+    Clockwise angle from grid north (in projCRS) in degrees from 0 to 360 of the direction of increasing crosslines (constant inline), i.e., of the vector from point A to B.
+    """
+    P6BinNodeIncrementOnIaxis: int | None = None
+    """
+    Increment (positive integer) for the inline coordinate. If not provided then 1 is assumed.  The bin grid definition is expected to have increment 1 and the increment stored with the SeismicTraceData (“inline increment”) takes precedence over the increment set at the BinGrid.  Alternatively the increments are allowed to be defined with the BinGrid, but this should be avoided to allow for variations in sampling in trace data sets.
+    """
+    P6BinNodeIncrementOnJaxis: int | None = None
+    """
+    Increment (positive integer) for the crossline coordinate. If not provided then 1 is assumed.  The bin grid definition is expected to have increment 1 and the increment stored with the SeismicTraceData (“crossline increment”) takes precedence over the increment set at the BinGrid. Alternatively the increments are allowed to be defined with the BinGrid, but this should be avoided to allow for variations in sampling in trace data sets.
+    """

osdu_models/abstract/abstract_business_rule/__init__.py

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

osdu_models/abstract/abstract_business_rule/v1_0_0.py

@@ -0,0 +1,69 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_business_rule/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class DataRuleSet(BaseModel):
+    """
+    The list of data rule sets that is relevant for this business process. Each data rule set reference is associated with a run-status.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DataRuleSetID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-QualityDataRuleSet:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='DataRuleSet ID')
+    """
+    The relationship to the QualityDataRuleSet.
+    """
+    DataRuleSetRunStatus: bool | None = Field(None, title='DataRuleSet Run Status')
+    """
+    True if data ruleset rule has passed, False if data ruleset rule dit not pass.
+    """
+
+
+class DataRule(BaseModel):
+    """
+    The list of individual data rules that is relevant for this business process. Each data rule reference is associated with a run-status.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DataRuleID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-QualityDataRule:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='DataRule ID')
+    """
+    The relationship to the individual QualityDataRule.
+    """
+    DataRuleRunStatus: bool | None = Field(None, title='DataRule Run Status')
+    """
+    True if data rule has passed, False if data rule did not pass.
+    """
+
+
+class AbstractBusinessRule(BaseModel):
+    """
+    The business rule is a collection of one or more data rule sets with their run status as well as a collection of individual rules with their run status.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DataRuleSets: list[DataRuleSet] | None = Field(None, title='Data Rule Sets')
+    """
+    The list of data rule sets that is relevant for this business process. Each data rule set reference is associated with a run-status.
+    """
+    DataRules: list[DataRule] | None = Field(None, title='Date Rules')
+    """
+    The list of individual data rules that is relevant for this business process. Each data rule reference is associated with a run-status.
+    """

osdu_models/abstract/abstract_collaboration_lifecycle_event/__init__.py

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

osdu_models/abstract/abstract_collaboration_lifecycle_event/v1_0_0.py

@@ -0,0 +1,49 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_collaboration_lifecycle_event/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractCollaborationLifecycleEvent(BaseModel):
+    """
+    An event in the lifecycle of a CollaborationProject containing references to the CollaborationProjectCollections involved at the time of the event.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EventID: str | None = Field(None, examples=['CreationEvent'], title='EventID')
+    """
+    A unique identifier of this event element in a sequence of events as, e.g., in CollaborationProject.
+    """
+    Name: str | None = Field(None, title='Name')
+    """
+    A user-given event name.
+    """
+    DateTime: str | None = Field(None, title='Date and Time')
+    """
+    The date and time of the event.
+    """
+    Remark: str | None = Field(None, title='Remark')
+    """
+    A user defined remark associated with this event.
+    """
+    ResourceCollectionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-CollaborationProjectCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Resource Collection ID')
+    """
+    The relationship to a CollaborationProjectCollection containing the System of Record resources used by the project.
+    """
+    WIPResourceCollectionID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-CollaborationProjectCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='WIP Resource Collection ID')
+    """
+    The relationship to a CollaborationProjectCollection containing the Work in Progress resources published in the context of the project.
+    """

osdu_models/abstract/abstract_column_based_table/__init__.py

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