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

osdu_models/masterdata/organisation/__init__.py

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

osdu_models/masterdata/organisation/v1_0_0.py

@@ -0,0 +1,61 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/organisation/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_alias_names import v1_0_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_0_0 import AbstractMaster
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for Organisation 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    OrganisationID: str | None = Field(None, title='External Organisation Identifier')
+    """
+    Native identifier from a Master Data Management System or other trusted source external to OSDU - stored here in order to allow for multi-system connection and synchronization. If used, the "Source" property should identify that source system.
+    """
+    OrganisationName: str | None = None
+    """
+    Text which identifies an organisation.
+    """
+    OrganisationNameAliases: list[v1_0_0.AbstractAliasNames] | None = None
+    """
+    DEPRECATED: please use data.NameAliases. Alternative names, including historical, by which this organisation entity is/has been known.
+    """
+    InternalOrganisationIndicator: bool | None = None
+    """
+    Indicates if the organisation is internal to the enterprise.
+    """
+    OrganisationPurposeDescription: str | None = None
+    """
+    The reason why the organization was formed.
+    """
+    OrganisationDescription: str | None = None
+    """
+    Textual description of the nature of the organisation.
+    """
+    EffectiveDate: str | None = None
+    """
+    The date and time at which a given organisation becomes effective.
+    """
+    TerminationDate: str | None = None
+    """
+    The date and time at which a given organisation is no longer in effect.
+    """
+    OrganisationTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-OrganisationType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Category the organisational structure fits into. Possible values - Operating Unit, Operating sub Unit, A Business, A Department, Government Agency, etc.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/organisation/v1_1_0.py

@@ -0,0 +1,68 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/organisation/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_alias_names import v1_0_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_0_0 import AbstractMaster
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for Organisation 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    OrganisationID: str | None = Field(None, title='External Organisation Identifier')
+    """
+    Native identifier from a Master Data Management System or other trusted source external to OSDU - stored here in order to allow for multi-system connection and synchronization. If used, the "Source" property should identify that source system.
+    """
+    OrganisationName: str | None = None
+    """
+    Text which identifies an organisation.
+    """
+    OrganisationNameAliases: list[v1_0_0.AbstractAliasNames] | None = None
+    """
+    DEPRECATED: please use data.NameAliases. Alternative names, including historical, by which this organisation entity is/has been known.
+    """
+    InternalOrganisationIndicator: bool | None = None
+    """
+    Indicates if the organisation is internal to the enterprise.
+    """
+    OrganisationPurposeDescription: str | None = None
+    """
+    The reason why the organization was formed.
+    """
+    OrganisationDescription: str | None = None
+    """
+    Textual description of the nature of the organisation.
+    """
+    EffectiveDate: str | None = None
+    """
+    The date and time at which a given organisation becomes effective.
+    """
+    TerminationDate: str | None = None
+    """
+    The date and time at which a given organisation is no longer in effect.
+    """
+    OrganisationTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-OrganisationType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Category the organisational structure fits into. Possible values - Operating Unit, Operating sub Unit, A Business, A Department, Government Agency, etc.
+    """
+    ParentOrganisationID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Parent Organisation ID')
+    """
+    If populated, this is the parent organisation of the current organisation.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/organisation/v1_2_0.py

@@ -0,0 +1,68 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/organisation/v1_2_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_alias_names import v1_0_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_2_0 import AbstractMaster
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for Organisation 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    OrganisationID: str | None = Field(None, title='External Organisation Identifier')
+    """
+    Native identifier from a Master Data Management System or other trusted source external to OSDU - stored here in order to allow for multi-system connection and synchronization. If used, the "Source" property should identify that source system.
+    """
+    OrganisationName: str | None = None
+    """
+    Text which identifies an organisation.
+    """
+    OrganisationNameAliases: list[v1_0_0.AbstractAliasNames] | None = None
+    """
+    DEPRECATED: please use data.NameAliases. Alternative names, including historical, by which this organisation entity is/has been known.
+    """
+    InternalOrganisationIndicator: bool | None = None
+    """
+    Indicates if the organisation is internal to the enterprise.
+    """
+    OrganisationPurposeDescription: str | None = None
+    """
+    The reason why the organization was formed.
+    """
+    OrganisationDescription: str | None = None
+    """
+    Textual description of the nature of the organisation.
+    """
+    EffectiveDate: str | None = None
+    """
+    The date and time at which a given organisation becomes effective.
+    """
+    TerminationDate: str | None = None
+    """
+    The date and time at which a given organisation is no longer in effect.
+    """
+    OrganisationTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-OrganisationType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Category the organisational structure fits into. Possible values - Operating Unit, Operating sub Unit, A Business, A Department, Government Agency, etc.
+    """
+    ParentOrganisationID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Parent Organisation ID')
+    """
+    If populated, this is the parent organisation of the current organisation.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/perforation_interval/__init__.py

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

osdu_models/masterdata/perforation_interval/v1_0_0.py

@@ -0,0 +1,305 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/perforation_interval/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_facility_vertical_measurement import v1_0_0
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_1_0 import AbstractMaster
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for PerforationInterval 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore')
+    """
+    Business natural key or code of the parent Wellbore to which this record belongs
+    """
+    PerforationJobID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-PerforationJob:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Perforation Job ID')
+    """
+    SRN to Job performed to construct the Perf Intervals
+    """
+    SequenceNumber: int = Field(..., title='Sequence Number')
+    """
+    Sequence Number (guns fired sequence)
+    """
+    ClusterRefNo: float | None = Field(None, title='Cluster Reference #')
+    """
+    Cluster reference number
+    """
+    IntervalDateTime: str = Field(..., title='Perforation Interval Date/Time')
+    """
+    Perforation interval date/time
+    """
+    IntervalTypeID: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-PerforationIntervalType:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Perforation Interval Type')
+    """
+    Perforated interval type
+    """
+    VerticalMeasurement: v1_0_0.AbstractFacilityVerticalMeasurement | None = Field(
+        None, title='Depth Reference Elevation'
+    )
+    """
+    ID to the Zero Depth Point elevation for depths contained in the perf job incl intervals, depth correction used to correlate MDs to original drilling rig MD. References an entry in the Vertical Measurement array for the Well parented by the wellbore via WellboreID.
+    """
+    IntervalTopMD: float = Field(..., title='Perforation Interval Top MD')
+    """
+    MD at top of perfed interval
+    """
+    IntervalBaseMD: float | None = Field(None, title='Perforation Interval Base MD')
+    """
+    MD at base of perfed interval
+    """
+    IntervalLength: float | None = Field(None, title='Interval Length')
+    """
+    Distance between MD top and base of interval (net distance) aka 'Top Shot to Bottom Shot' Interval.
+    """
+    WirelineDiameterTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationIntervalWLSize:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Wireline Diameter')
+    """
+    Wireline diameter
+    """
+    IntervalReasonTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationIntervalReason:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Reason')
+    """
+    Interval Reason
+    """
+    GunDiameter: float | None = Field(None, title='Gun Diameter')
+    """
+    Gun diameter
+    """
+    GunCarrierManufacturerID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Gun Carrier Manufacturer')
+    """
+    Gun Carrier Manufacturer
+    """
+    GunCarrierTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunCarrierType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Gun Carrier Type')
+    """
+    Gun Carrier Type
+    """
+    GunCarrierModelID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunCarrierModel:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Gun Carrier Model')
+    """
+    Gun Carrier Model
+    """
+    GunCarrierCategoryTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunCarrierCategory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Gun Carrier Category')
+    """
+    Gun Carrier Category
+    """
+    GunCarrierPhasing: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunPhasingType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Gun Carrier Phasing')
+    """
+    Gun Carrier Phasing (angle between perfs). Implemented via a reference list in order to standardize the values.
+    """
+    GunFiringHeadTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunFiringHeadType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Gun Firing Head Type')
+    """
+    Gun Firing Head Type
+    """
+    GunMetallurgyTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunMetallurgyType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Gun Metallurgy Type')
+    """
+    Metallurgy of the gun
+    """
+    ChargeManufacturerID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Charge Manufacturer')
+    """
+    Charge Make/Manufacturer
+    """
+    ChargeTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunChargeType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Charge Type')
+    """
+    Charge Type
+    """
+    ChargeShapeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunChargeShape:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Charge Shape')
+    """
+    Charge Shape
+    """
+    ChargeSize: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-PerforationGunChargeSize:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Charge Size')
+    """
+    Charge Size
+    """
+    GunSwellDiameter: float | None = Field(None, title='Gun Swell Diameter')
+    """
+    Gun Swell Diameter
+    """
+    ShotDensity: float | None = Field(None, title='Shot Density')
+    """
+    Gun Shot Density (shots per foot)
+    """
+    EntranceHoleDiameter: float | None = Field(
+        None, title='Perforation Entrance Hole Diameter'
+    )
+    """
+    Perforation Entrance Hole Diameter
+    """
+    PenetrationDepth: float | None = Field(None, title='Perforation Penetration Depth')
+    """
+    Estimated perforation penetration distance
+    """
+    IsAdditionalShot: bool | None = Field(None, title='Additional Shot')
+    """
+    Additional shot Y/N (+1 to Tot Shots calc)
+    """
+    Misfires: int | None = Field(None, title='Misfires')
+    """
+    Total number of gun / charge misfires
+    """
+    ReservoirTemperature: float | None = Field(None, title='Reservoir Temperature')
+    """
+    Reservoir Temperature
+    """
+    CasingCollarLocatorMD: float | None = Field(None, title='Casing Collar Locator MD')
+    """
+    Measured Depth of the Casing Collar Locator used to align perforating guns on depth
+    """
+    CCLTopShotDistance: float | None = Field(None, title='CCL Top Shot Distance')
+    """
+    Distance from CCL to Interval Top
+    """
+    FluidBeforeMD: float | None = Field(None, title='Fluid Depth Before Shot')
+    """
+    Static fluid level before perforating
+    """
+    FluidAfterMD: float | None = Field(None, title='Fluid Depth After Shot')
+    """
+    Static fluid level after perforating
+    """
+    GaugeMD: float | None = Field(None, title='Gauge Measured Depth')
+    """
+    Depth of gauge(s) run while perforating.
+    """
+    BHPressureTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-BottomHolePressureType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='BH Pressure Type')
+    """
+    How was the bottom hole pressure determined?  Measured, estimated, etc.
+    """
+    DuringPerfGaugePressure: float | None = Field(
+        None, title='Gauge Pressure During Perforation'
+    )
+    """
+    Pressure during perforation
+    """
+    InitialSurfPressure: float | None = Field(None, title='Initial Surface Pressure')
+    """
+    Initial surface pressure
+    """
+    FinalSurfPressure: float | None = Field(None, title='Final Surface Pressure')
+    """
+    Final surface pressure
+    """
+    MPPPressure: float | None = Field(None, title='MPP Pressure')
+    """
+    Mid point perf pressure
+    """
+    FluidLossBeforeRate: float | None = Field(None, title='Fluid Rate Before Shot')
+    """
+    Fluid loss rate  before perforating
+    """
+    FluidLossAfterRate: float | None = Field(None, title='Fluid Rate After Shot')
+    """
+    Fluid lossrate after perforating
+    """
+    FrictionFactor: float | None = Field(None, title='Friction Factor')
+    """
+    Friction Factor
+    """
+    FrictionPressure: float | None = Field(None, title='Friction Pressure')
+    """
+    Friction Pressure
+    """
+    DischargeCoefficient: float | None = Field(
+        None, title='Initial Discharge Coefficient'
+    )
+    """
+    Initial discharge coefficient after perforating but prior to hydraulic fracturing.  A coefficient used in the equation for calculation of pressure drop
+    across a perforation set.
+    """
+    CrushZoneDiameter: float | None = Field(None, title='Crush Zone Diameter')
+    """
+    Crush Zone Diameter
+    """
+    CrushDamageRatio: float | None = Field(None, title='Crush Damage Ratio')
+    """
+    Crush Damage Ratio
+    """
+    TechnicalResult: str | None = Field(None, title='Technical Result')
+    """
+    Technical Result
+    """
+    IntervalComments: str | None = Field(None, title='Interval Comments')
+    """
+    Interval Comments
+    """
+    Name: str | None = Field(None, title='Name')
+    """
+    The name under which this perforation job is known.
+    """
+    ExtensionProperties: dict[str, Any] | None = None