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

osdu_models/abstract/abstract_proppant_agent/v1_0_0.py

@@ -0,0 +1,233 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_proppant_agent/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class CrushTestDatum(BaseModel):
+    """
+    ISO13503_2 crush test data for this instance of ISO13503_2 data for the proppant agent.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Fines: float | None = Field(None, title='Fines')
+    """
+    Mass percentage of fines after being exposed to stress.
+    """
+    Stress: float | None = Field(None, title='Stress')
+    """
+    Stress measured at a point during a crush test.
+    """
+
+
+class SieveAnalysisDatum(BaseModel):
+    """
+    ISO13503_2 sieve analysis data for this instance of ISO13503_2 data for the proppant agent.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    PercentRetained: float | None = Field(None, title='Percent Retained')
+    """
+    The percentage of mass retained in the sieve.
+    """
+    SieveNumber: int | None = Field(None, title='Sieve Number')
+    """
+    ASTM US Standard Mesh opening size used in the sieve analysis test. To indicate Pan, use 0.
+    """
+
+
+class ISO135032Property(BaseModel):
+    """
+    ISO13503_2 properties for this proppant agent.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    AbsoluteDensity: float | None = Field(None, title='Absolute Density')
+    """
+    The density the material would have if no intra-granular porosity is present. (e.g. Boyle's Law porosimetry).
+    """
+    AcidSolubility: float | None = Field(None, title='Acid Solubility')
+    """
+    The solubility of a proppant in 12:3 HCl:HF for 30 minutes at 150°F is an indication of the amount of soluble materials (i.e. carbonates, feldspars, iron oxides, clays, etc) present in the proppant.
+    """
+    ApparentDensity: float | None = Field(None, title='Apparent Density')
+    """
+    Apparent density excludes extra-granular porosity by placing a known mass in a volume of fluid and determining how much of the fluid is displaced (Archimedes).
+    """
+    BulkDensity: float | None = Field(None, title='Bulk Density')
+    """
+    Bulk density includes both the proppant and the porosity. This is measured by filling a known volume with dry proppant and measuring the weight.
+    """
+    ClustersPercent: float | None = Field(None, title='Clusters Percent')
+    """
+    Percentage of undesirable agglomerated discrete proppant particles which typically occurs more with inefficiently processed natural sand proppants as opposed to manufactured ceramic proppants. ISO 13503-2 and API RP19C limit the mass of clusters to less than 1%.
+    """
+    CrushTestData: list[CrushTestDatum] | None = Field(None, title='Crush Test Data')
+    """
+    Crush Test Data
+    """
+    KValue: int | None = Field(None, title='K Value')
+    """
+    Crush test classification indicating the highest stress level at which a proppant generated no more than 10% crushed material rounded down to the nearest 1,000 psi during a crush test. For example, a value of 14 means 14k which is 14000 psi.
+    """
+    LossOnIgnition: float | None = Field(None, title='Loss On Ignition')
+    """
+    A mass loss (gravimetric) test method applied to coated proppants only, which determines the mass of resin coating applied to a natural sand or manufactured proppant by means of thorough combustion of the flammable resin from the nonflammable proppant. Reported as a % of original mass.
+    """
+    MeanParticleDiameter: float | None = Field(None, title='Mean Particle Diameter')
+    """
+    The mean diameter of particles in a sample of proppant.
+    """
+    MedianParticleDiameter: float | None = Field(None, title='Median Particle Diameter')
+    """
+    The median diameter of particles in a sample of proppant.
+    """
+    Roundness: float | None = Field(None, title='Roundness')
+    """
+    Krumbein Roundness Shape Factor that is a measure of the relative sharpness of grain corners or of grain curvature. Krumbein and Sloss (1963) are the most widely used method of determining shape factors.
+    """
+    SieveAnalysisData: list[SieveAnalysisDatum] | None = Field(
+        None, title='Sieve Analysis Data'
+    )
+    """
+    Sieve Analysis Data
+    """
+    SpecificGravity: float | None = Field(None, title='Specific Gravity')
+    """
+    Not formally part of ISO 13503.2 properties, the specific gravity is the apparent density of the proppant divided by the density of water.
+    """
+    Sphericity: float | None = Field(None, title='Sphericity')
+    """
+    Krumbein Sphericity Shape Factor that is a measure of how closely a proppant particle approaches the shape of a sphere. Krumbein and Sloss (1963) are the most widely used method of determining shape factors.
+    """
+    TurbidityNTU: float | None = Field(None, title='Turbidity NTU')
+    """
+    A measure of water clarity, how much the material suspended in water decreases the passage of light through the water.   Measured according to USEPA 180.1 and expressed in Nephelometric Turbidity Units (NTU).
+    """
+    TurbidityFNU: float | None = Field(None, title='Turbidity FNU')
+    """
+    A measure of water clarity, how much the material suspended in water decreases the passage of light through the water. Measured according to ISO 7027 and expressed in Formazin Nephelometric Units (FNU).
+    """
+
+
+class ISO135035PointItem(BaseModel):
+    """
+    ISO13503_5 point properties for this proppant agent.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Conductivity: float | None = Field(None, title='Conductivity')
+    """
+    Proppant conductivity under stress.
+    """
+    Permeability: float | None = Field(None, title='Permeability')
+    """
+    Proppant permeability under stress.
+    """
+    StressApplied: float | None = Field(None, title='Stress Applied')
+    """
+    The amount of stress applied.
+    """
+    Temperature: float | None = Field(None, title='Temperature')
+    """
+    The temperature at the time measurements were taken.
+    """
+
+
+class ProppantAgent(BaseModel):
+    """
+    Defines the properties of a Proppant and it's test values.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ProppantName: str | None = Field(
+        None, examples=['70 Ottawa Sand'], title='Proppant Name'
+    )
+    """
+    The name of the proppant.
+    """
+    FrictionCoefficientLaminar: float | None = Field(
+        None, title='Friction Coefficient Laminar'
+    )
+    """
+    Laminar flow friction coefficient.
+    """
+    FrictionCoefficientTurbulent: float | None = Field(
+        None, title='Friction Coefficient Turbulent'
+    )
+    """
+    Turbulent flow friction coefficient.
+    """
+    MassAbsorptionCoefficient: float | None = Field(
+        None, title='Mass Absorption Coefficient'
+    )
+    """
+    Characterizes how easily radiation passes through a material. This can be used to compute the concentration of proppant in a slurry using a densitometer.
+    """
+    MeshSizeHigh: int | None = Field(None, examples=[70], title='Mesh Size High')
+    """
+    Integer high value of sieve mesh size: for 4070 sand, this value is 70. For a 70 sand this would be 70.
+    """
+    MeshSizeLow: int | None = Field(None, examples=[70], title='Mesh Size Low')
+    """
+    Integer low value of sieve mesh size: for 4070 sand, this value is 40.
+    """
+    ProppantTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-StimProppantAgentType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--StimProppantAgentType:Sand:'],
+        title='Proppant Type ID',
+    )
+    """
+    Proppant type or function.
+    """
+    UnconfinedCompressiveStrength: float | None = Field(
+        None, title='Unconfined Compressive Strength'
+    )
+    """
+    The unconfined compressive strength of the proppant.
+    """
+    ISO13503_2Properties: list[ISO135032Property] | None = Field(
+        None, title='ISO 13503_2 Properties'
+    )
+    ISO13503_5Point: list[ISO135035PointItem] | None = Field(
+        None, title='ISO 13503_5 Point'
+    )
+    SupplierName: str | None = Field(
+        None, examples=['ASTM Sands'], title='Supplier Name'
+    )
+    """
+    The name of the proppant supplier.
+    """
+    SupplierID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Supplier ID')
+    """
+    Identifier of service company organisation providing this proppant agent for the stimulation job.
+    """
+    SupplierProductCode: str | None = Field(
+        None, examples=['70OTTSAND'], title='Supplier Product Code'
+    )
+    """
+    Supplier's product number/code.
+    """
+    Remarks: str | None = Field(None, title='Remarks')
+    """
+    General remarks about this proppant agent.
+    """

osdu_models/abstract/abstract_ptcondition/__init__.py

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

osdu_models/abstract/abstract_ptcondition/v1_0_0.py

@@ -0,0 +1,23 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_ptcondition/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class AbstractPTCondition(BaseModel):
+    """
+    The pair of absolute pressure and temperature values describing the condition for a particular volume measurement or estimation. The unit of measure context is defined via the meta[] block in the record. Search responses will return pressure in Pa (Pascal) and temperature in K (Kelvin).
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Pressure: float = Field(..., examples=['1 bar'], title='Pressure')
+    """
+    The recorded absolute pressure condition. The unit of measure context is defined via meta[] in the Storage record while the Search responses return the value in base SI unit Pa (Pascal).
+    """
+    Temperature: float = Field(..., examples=['15 degC'], title='Temperature')
+    """
+    The recorded temperature condition. The unit of measure context is defined via meta[] in the Storage record while the Search responses return the value in base SI unit K (Kelvin).
+    """

osdu_models/abstract/abstract_ptcondition/v1_1_0.py

@@ -0,0 +1,35 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_ptcondition/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class AbstractPTCondition(BaseModel):
+    """
+    The pair of absolute pressure and temperature values describing the condition for a particular volume measurement or estimation. The unit of measure context is defined via the meta[] block in the record. Search responses will return pressure in Pa (Pascal) and temperature in K (Kelvin).
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Pressure: float = Field(..., examples=['1 bar'], title='Pressure')
+    """
+    The recorded absolute pressure condition. The unit of measure context is defined via meta[] in the Storage record while the Search responses return the value in base SI unit Pa (Pascal).
+    """
+    Temperature: float = Field(..., examples=['15 degC'], title='Temperature')
+    """
+    The recorded temperature condition. The unit of measure context is defined via meta[] in the Storage record while the Search responses return the value in base SI unit K (Kelvin).
+    """
+    IsStandardConditions: bool | None = Field(None, title='Is Standard Conditions')
+    """
+    To capture when Measurement have been made at Standard Conditions (25°C / 100 kPa)
+    Mutually Exclusive with Pressure/Temperature.
+    Capture
+    """
+    NonStandardConditionsReference: str | None = Field(
+        None, title='Non Standard Conditions Reference'
+    )
+    """
+    Open Text Box to capture the P & T Reference when measurements are made at non standard conditions (such as "Reservoir", "Tank",…)
+    """

osdu_models/abstract/abstract_quality_metric/__init__.py

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

osdu_models/abstract/abstract_quality_metric/v1_0_0.py

@@ -0,0 +1,59 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_quality_metric/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict
+
+
+class AbstractQualityMetric(BaseModel):
+    """
+    Generic quality metric schema fragment containing the universal properties for data profiling and data metrics of OSDU objects.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RunDateTime: str | None = None
+    """
+    Run timestamp of the Business data quality ruleset.
+    """
+    MetadataCountTotal: float | None = None
+    """
+    Total number of metadata attributes for object in scope.
+    """
+    MetadataNull: float | None = None
+    """
+    The count of total number where metadata is not populated.
+    """
+    MetadataCountFormat: float | None = None
+    """
+    Total number of attributes defined in reference value lists.
+    """
+    MetadataFormat: float | None = None
+    """
+    The count of total number where attribute follows the defined reference value lists.
+    """
+    MetadataCountPattern: float | None = None
+    """
+    Total number of attributes with a pattern.
+    """
+    MetadataPattern: float | None = None
+    """
+    The count of total number of attributes that follow pattern.
+    """
+    MetadataCountRequired: float | None = None
+    """
+    Total number required attributes.
+    """
+    MetadataCountRequiredTrue: float | None = None
+    """
+    The count of required metadata that are not populated.
+    """
+    MetadataCountAdditionalProperty: float | None = None
+    """
+    Total number of additional properties.
+    """
+    MetadataAdditionalPropertiesTrue: float | None = None
+    """
+    The count of total number of additional properties that are not populated.
+    """

osdu_models/abstract/abstract_quality_metric/v1_1_0.py

@@ -0,0 +1,63 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_quality_metric/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict
+
+
+class AbstractQualityMetric(BaseModel):
+    """
+    Generic quality metric schema fragment containing the universal properties for data profiling and data metrics of OSDU objects.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    RunDateTime: str | None = None
+    """
+    Run timestamp of the Business data quality ruleset.
+    """
+    MetadataCountTotal: float | None = None
+    """
+    Total number of metadata attributes for object in scope.
+    """
+    MetadataNull: float | None = None
+    """
+    The count of total number where metadata is not populated.
+    """
+    MetadataCountFormat: float | None = None
+    """
+    Total number of attributes defined in reference value lists.
+    """
+    MetadataFormat: float | None = None
+    """
+    The count of total number where attribute follows the defined reference value lists.
+    """
+    MetadataCountPattern: float | None = None
+    """
+    Total number of attributes with a pattern.
+    """
+    MetadataPattern: float | None = None
+    """
+    The count of total number of attributes that follow pattern.
+    """
+    MetadataCountRequired: float | None = None
+    """
+    Total number required attributes.
+    """
+    MetadataCountRequiredTrue: float | None = None
+    """
+    The count of required metadata that are not populated.
+    """
+    MetadataCountAdditionalProperty: float | None = None
+    """
+    Total number of additional properties.
+    """
+    MetadataAdditionalPropertiesTrue: float | None = None
+    """
+    The count of total number of additional properties that are not populated.
+    """
+    MetadataScore: float | None = None
+    """
+    The score in % for the evaluated record.
+    """

osdu_models/abstract/abstract_reference_level/__init__.py

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

osdu_models/abstract/abstract_reference_level/v1_0_0.py

@@ -0,0 +1,94 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_reference_level/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractReferenceLevel(BaseModel):
+    """
+    A reference level or horizontal reference surface definition, which can be used embedded in other schemas.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Height: float | None = Field(None, examples=[0.0], title='Height')
+    """
+    The height above the reference surface defined by the VerticalCoordinateReferenceSystemID positive upwards.
+    """
+    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 relationship to the vertical CRS defining the absolute reference surface.
+    """
+    EffectiveDateTime: str | None = Field(None, title='Effective Date Time')
+    """
+    The date and time at which this reference level instance becomes effective.
+    """
+    TerminationDateTime: str | None = Field(None, title='Termination Date Time')
+    """
+    The date and time at which a reference level instance is no longer in effect.
+    """
+    VerticalMeasurementTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-VerticalMeasurementType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--VerticalMeasurementType:SRD:'],
+        title='Vertical Measurement Type ID',
+    )
+    """
+    Specifies the type of vertical measurement (SRD, ES, GR, MSL,and many more).
+    """
+    VerticalMeasurementPathID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-VerticalMeasurementPath:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Vertical Measurement Path ID')
+    """
+    When used in context of a Wellbore, this specifies Measured Depth, True Vertical Depth, or Elevation.
+    """
+    VerticalMeasurementSourceID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-VerticalMeasurementSource:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Vertical Measurement Source ID')
+    """
+    When used in context of a Wellbore this specifies Driller vs Logger measurements.
+    """
+    WellboreTVDTrajectoryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellboreTrajectory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Wellbore TVD Trajectory ID')
+    """
+    When used in context of a Wellbore this specifies what directional survey or wellpath was used to calculate the TVD.
+    """
+    VerticalUncertainty: float | None = Field(
+        None, examples=[0.3], title='Vertical Uncertainty'
+    )
+    """
+    The positional uncertainty in the vertical direction.
+    """
+    SeismicReplacementVelocity: float | None = Field(
+        None, examples=[1480], title='Seismic Replacement Velocity'
+    )
+    """
+    The replacement velocity value used to produce vertical static shifts in seismic data.
+    """

osdu_models/abstract/abstract_reference_property_type/__init__.py

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

osdu_models/abstract/abstract_reference_property_type/v1_1_0.py

@@ -0,0 +1,72 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_reference_property_type/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ..abstract_property_type import v1_0_0
+from ..abstract_facet import v1_0_0 as v1_0_0_1
+
+
+class AbstractReferencePropertyType(BaseModel):
+    """
+    The purpose of this schema is best understood in the context of a columnar dataset: the AbstractReferencePropertyType describes a column in a columnar dataset by declaring its value type (number, string), a UnitQuantity if the value type is a number, a kind if the string value is actually a relationship to a e.g. reference-data type.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    ValueType: str | None = Field(None, examples=['string'], title='Value Type')
+    """
+    The type of value to expect for this reference property, either "number" (floating point number), "integer",  "string", or "boolean".
+    """
+    ValueCount: int | None = Field(1, examples=[1], title='Value Count')
+    """
+    The number of values in a tuple, e.g. For coordinates. The default is 1.
+    """
+    UnitQuantityID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitQuantity:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['namespace:reference-data--UnitQuantity:plane%20angle:'],
+        title='Unit Quantity ID',
+    )
+    """
+    Only populated of the ValueType is "number". It holds the UnitQuantity associated with this reference property type. It is a relationship to UnitQuantity record.
+    """
+    PropertyType: v1_0_0.AbstractPropertyType | None = Field(
+        None,
+        examples=[
+            {
+                'PropertyTypeID': 'namespace:reference-data--PropertyType:ace68d4c-7400-431d-9a33-0541b8bfc4b4:',
+                'Name': 'dip azimuth',
+            }
+        ],
+        title='Property Type',
+    )
+    """
+    It holds the PropertyType associated with this reference property type, further defining the semantics of the value. It contains a relationship to PropertyType record and its (de-normalized) name. String or number values can represent e.g. A date or a time by referring to the respective PropertyType record id.
+    """
+    RelationshipTargetKind: (
+        constr(
+            pattern=r'^[\w\-\.]+:[\w\-\.]+:[\w\-\.]+:([0-9]+)?(\.)?([0-9]+)?(\.)?([0-9]+)?$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=['osdu:wks:reference-data--UnitOfMeasure:'],
+        title='Relationship Target Kind',
+    )
+    """
+    Only populated if ValueType=="string" and the values are expected to represent record ids, e.g. to a reference-data type, then this value holds the kind (optionally without the semantic version number).
+    """
+    FacetIDs: list[v1_0_0_1.AbstractFacet] | None = Field(None, title='Facet IDs')
+    """
+    Ordered array with: FacetType, FacetRole, both calling specific references
+
+    FacetType: Enumerations of the type of additional context about the nature of a property type (it may include conditions, direction, qualifiers, or statistics). 
+
+    FacetRole: Additional context about the nature of a property type. The purpose of such attribute is to minimize the need to create specialized property types by mutualizing some well known qualifiers such as "maximum", "minimum" which apply to a lot of different property types.
+    """