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

osdu_models/masterdata/rig/v1_0_0.py

@@ -0,0 +1,38 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/rig/v1_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_0_0 import AbstractMaster
+from ...abstract.abstract_facility.v1_0_0 import AbstractFacility
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractFacility):
+    """
+    `data` payload for Rig 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    OwnerID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Owner ID')
+    """
+    The identifier of the company that owns the rig.
+    """
+    TypeRig: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-RigType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Type Rig')
+    """
+    The type of rig (e.g., semi-submersible, jack-up, etc.)
+    """
+    ClassRig: str | None = Field(None, title='Class Rig')
+    """
+    Classification of the rig.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/rig/v1_1_0.py

@@ -0,0 +1,38 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/rig/v1_1_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_1_0 import AbstractMaster
+from ...abstract.abstract_facility.v1_1_0 import AbstractFacility
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractFacility):
+    """
+    `data` payload for Rig 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    OwnerID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Owner ID')
+    """
+    The identifier of the company that owns the rig.
+    """
+    TypeRig: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-RigType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Type Rig')
+    """
+    The type of rig (e.g., semi-submersible, jack-up, etc.)
+    """
+    ClassRig: str | None = Field(None, title='Class Rig')
+    """
+    Classification of the rig.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/rig/v1_2_0.py

@@ -0,0 +1,38 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/rig/v1_2_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_facility.v1_1_0 import AbstractFacility
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractFacility):
+    """
+    `data` payload for Rig 1.2.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    OwnerID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Owner ID')
+    """
+    The identifier of the company that owns the rig.
+    """
+    TypeRig: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-RigType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Type Rig')
+    """
+    The type of rig (e.g., semi-submersible, jack-up, etc.)
+    """
+    ClassRig: str | None = Field(None, title='Class Rig')
+    """
+    Classification of the rig.
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/rig_utilization/__init__.py

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

osdu_models/masterdata/rig_utilization/v1_0_0.py

@@ -0,0 +1,119 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/rig_utilization/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_0_0 import AbstractMaster
+from ...abstract.abstract_project.v1_0_0 import AbstractProject
+
+
+class MudPump(BaseModel):
+    """
+    Pumps present on the rig
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str | None = Field(None, title='Name')
+    """
+    The name of the mud pump (model)
+    """
+    Number: int | None = Field(None, title='Number')
+    """
+    Number of pump of that type on the rig.
+    """
+    MaxPower: float | None = Field(None, title='Max Power')
+    """
+    Maximum power defined by the manufacturer.
+    """
+    WorkingPower: float | None = Field(None, title='Working Power')
+    """
+    Maximum power authorized by the drilling contractor
+    """
+    MaxPumpPressure: float | None = Field(None, title='Maximum Pump Pressure')
+    """
+    Maximum required/delivered pressure from/by the pump
+    """
+    MaxPumpFlowrate: float | None = Field(None, title='Maximum Pump Flowrate')
+    """
+    Maximum required/delivered flowrate from/by the pump
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractProject):
+    """
+    `data` payload for RigUtilization 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    HoleSectionId: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-HoleSection:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Hole Section ID')
+    """
+    Identifier of the Hole Section that is being drilled
+    """
+    RigID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Rig:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = Field(None, title='Rig ID')
+    """
+    The rig that is being utilized to drill this depth range of this section.
+    """
+    StartHoleDepth: float | None = Field(None, title='Start Hole Depth')
+    """
+    Measured depth of the wellbore when operations performed with this rig started. Depth relative to Planned wellbore ZDP. Navigate via HoleSectionId and WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    EndHoleDepth: float | None = Field(None, title='End Hole Depth')
+    """
+    Measured depth of the wellbore when operations performed with this rig ended. Depth relative to Planned wellbore ZDP. Navigate via HoleSectionId and WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    StartDateActivity: str | None = Field(None, title='Dtm Start')
+    """
+    The start date and time for the activity that this rig was utilized for
+    """
+    EndDateActivity: str | None = Field(None, title='Dtm End')
+    """
+    The end date and time for the activity that this rig was utilized for
+    """
+    RequiredHoistingCapacity: float | None = Field(
+        None, title='Required Hoisting Capacity'
+    )
+    """
+    Required hoisting capacity based on derrick / drawworks
+    """
+    RequiredStandpipePressure: float | None = Field(
+        None, title='Required Standpipe Pressure'
+    )
+    """
+    Required Standpipe pressure
+    """
+    MaxWaterDepth: float | None = Field(None, title='Max Water Depth')
+    """
+    Required maximum workable water depth for the rig.
+    """
+    RiserInsideDiameter: str | None = Field(None, title='Riser Inside Diameter')
+    """
+    Nominal inside diameter of the riser
+    """
+    RiserWorkingPressure: float | None = Field(None, title='Riser Working Pressure')
+    """
+    Designed riser working pressure.
+    """
+    TopDriveTorqueRating: float | None = Field(None, title='Top Drive Torque Rating')
+    """
+    Required maximum torque for the top drive.
+    """
+    RequiredFlowRate: float | None = Field(None, title='Required Flow Rate')
+    """
+    Required mud flow rates delivered by the pump system.
+    """
+    MudPumps: list[MudPump] | None = Field(None, title='Mud Pumps')
+    """
+    Mud pump equipment on the rig
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/rig_utilization/v1_1_0.py

@@ -0,0 +1,119 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/rig_utilization/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, 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_project.v1_0_0 import AbstractProject
+
+
+class MudPump(BaseModel):
+    """
+    Pumps present on the rig
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str | None = Field(None, title='Name')
+    """
+    The name of the mud pump (model)
+    """
+    Number: int | None = Field(None, title='Number')
+    """
+    Number of pump of that type on the rig.
+    """
+    MaxPower: float | None = Field(None, title='Max Power')
+    """
+    Maximum power defined by the manufacturer.
+    """
+    WorkingPower: float | None = Field(None, title='Working Power')
+    """
+    Maximum power authorized by the drilling contractor
+    """
+    MaxPumpPressure: float | None = Field(None, title='Maximum Pump Pressure')
+    """
+    Maximum required/delivered pressure from/by the pump
+    """
+    MaxPumpFlowrate: float | None = Field(None, title='Maximum Pump Flowrate')
+    """
+    Maximum required/delivered flowrate from/by the pump
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster, AbstractProject):
+    """
+    `data` payload for RigUtilization 1.1.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    HoleSectionId: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-HoleSection:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Hole Section ID')
+    """
+    Identifier of the Hole Section that is being drilled
+    """
+    RigID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Rig:[\w\-\.\:\%]+:[0-9]*$') | None
+    ) = Field(None, title='Rig ID')
+    """
+    The rig that is being utilized to drill this depth range of this section.
+    """
+    StartHoleDepth: float | None = Field(None, title='Start Hole Depth')
+    """
+    Measured depth of the wellbore when operations performed with this rig started. Depth relative to Planned wellbore ZDP. Navigate via HoleSectionId and WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    EndHoleDepth: float | None = Field(None, title='End Hole Depth')
+    """
+    Measured depth of the wellbore when operations performed with this rig ended. Depth relative to Planned wellbore ZDP. Navigate via HoleSectionId and WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    StartDateActivity: str | None = Field(None, title='Dtm Start')
+    """
+    The start date and time for the activity that this rig was utilized for
+    """
+    EndDateActivity: str | None = Field(None, title='Dtm End')
+    """
+    The end date and time for the activity that this rig was utilized for
+    """
+    RequiredHoistingCapacity: float | None = Field(
+        None, title='Required Hoisting Capacity'
+    )
+    """
+    Required hoisting capacity based on derrick / drawworks
+    """
+    RequiredStandpipePressure: float | None = Field(
+        None, title='Required Standpipe Pressure'
+    )
+    """
+    Required Standpipe pressure
+    """
+    MaxWaterDepth: float | None = Field(None, title='Max Water Depth')
+    """
+    Required maximum workable water depth for the rig.
+    """
+    RiserInsideDiameter: str | None = Field(None, title='Riser Inside Diameter')
+    """
+    Nominal inside diameter of the riser
+    """
+    RiserWorkingPressure: float | None = Field(None, title='Riser Working Pressure')
+    """
+    Designed riser working pressure.
+    """
+    TopDriveTorqueRating: float | None = Field(None, title='Top Drive Torque Rating')
+    """
+    Required maximum torque for the top drive.
+    """
+    RequiredFlowRate: float | None = Field(None, title='Required Flow Rate')
+    """
+    Required mud flow rates delivered by the pump system.
+    """
+    MudPumps: list[MudPump] | None = Field(None, title='Mud Pumps')
+    """
+    Mud pump equipment on the rig
+    """
+    ExtensionProperties: dict[str, Any] | None = None

osdu_models/masterdata/risk/__init__.py

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

osdu_models/masterdata/risk/v1_0_0.py

@@ -0,0 +1,284 @@
+# generated by datamodel-codegen:
+#   filename:  masterdata/risk/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ...abstract.abstract_contact import v1_0_0
+from typing import Any
+from ...abstract.abstract_common_resources.v1_0_0 import OsduCommonResources
+from ...abstract.abstract_master.v1_0_0 import AbstractMaster
+
+
+class Prevention(BaseModel):
+    """
+    Describe a set of action to prevent for a risk or to mitigate its consequences
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str = Field(..., title='Name')
+    """
+    Name of the response
+    """
+    Description: str = Field(..., title='Description')
+    """
+    General description of the response
+    """
+    Status: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-RiskResponseStatus:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Status')
+    """
+    Describes the status of the action such as (progress, done, canceled)
+    """
+    Responsibles: list[v1_0_0.AbstractContact] = Field(..., title='Responsibles')
+    """
+    List of the staff responsible to proceed with the response
+    """
+    Deadline: float | None = Field(None, title='Deadline')
+    """
+    Date the response must be completed
+    """
+    UpdateDate: float | None = Field(None, title='Update Date')
+    """
+    Date the description of the response has been updated.
+    """
+
+
+class Mitigation(BaseModel):
+    """
+    Describe a set of action to prevent for a risk or to mitigate its consequences
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Name: str = Field(..., title='Name')
+    """
+    Name of the response
+    """
+    Description: str = Field(..., title='Description')
+    """
+    General description of the response
+    """
+    Status: constr(
+        pattern=r'^[\w\-\.]+:reference-data\-\-RiskResponseStatus:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Status')
+    """
+    Describes the status of the action such as (progress, done, canceled)
+    """
+    Responsibles: list[v1_0_0.AbstractContact] = Field(..., title='Responsibles')
+    """
+    List of the staff responsible to proceed with the response
+    """
+    Deadline: float | None = Field(None, title='Deadline')
+    """
+    Date the response must be completed
+    """
+    UpdateDate: float | None = Field(None, title='Update Date')
+    """
+    Date the description of the response has been updated.
+    """
+
+
+class Data(OsduCommonResources, AbstractMaster):
+    """
+    `data` payload for Risk 1.0.0.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    Preventions: list[Prevention] | None = Field(None, title='Preventions')
+    """
+    A textual description of the steps to prevent this risk
+    """
+    Cause: str | None = Field(None, title='Cause')
+    """
+    A textual description of the cause of this risk
+    """
+    Consequence: str | None = Field(None, title='Consequence')
+    """
+    A textual description of the consequence of this risk occurring
+    """
+    ConsequenceCategoryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-RiskConsequenceCategory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Consequence Category ID')
+    """
+    Reference to the name of the category of the loss - equivalent to the "ConsequenceCategory" as defined in Bow Tie.
+    """
+    ConsequenceSubCategoryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-RiskConsequenceSubCategory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Consequence SubCategory ID')
+    """
+    References the consequence sub-category of the risk. Possible effects arising were a risk event to occur.
+    """
+    ResidualSeverity: float | None = Field(None, title='Residual Severity')
+    """
+    Severity Level of the Risk. 
+    					Values of 1 through 5 with 1 being the lowest.
+    """
+    ResidualProbability: float | None = Field(None, title='Residual Probability')
+    """
+    Probability Level of the Risk.
+    					Values of 1 through 5 with 1 being the lowest.
+    """
+    RiskAssociatedObjectIDs: list[str] | None = Field(
+        None, title='Risk Associated Object IDs'
+    )
+    """
+    Array of identifiers from the risk to related objects or documents (such as BHA, Mud design, Activity plans...)
+    """
+    PublicationDate: str | None = Field(None, title='Publication Date')
+    """
+    Date a resource is formed outside of OSDU before loading
+    """
+    InitialSeverity: float | None = Field(None, title='Initial Severity')
+    """
+    Initial Severity Level of the Risk. 
+    					Values of 1 through 5 with 1 being the lowest.
+    """
+    InitialProbability: float | None = Field(None, title='Initial Probability')
+    """
+    Initial Probability Level of the Risk.
+    					Values of 1 through 5 with 1 being the lowest.
+    """
+    InitialRiskScore: float | None = Field(None, title='Initial Risk Score')
+    """
+    Score computed as of "Pre-Mitigation" which is the combination of : 
+    Initial Severity * Initial Probability 
+    Values of 1 through 25 with 1 being the lowest.
+    """
+    ResidualRiskScore: float | None = Field(None, title='Residual Risk')
+    """
+    Score computed as of "Post-Mitigation" which is the combination of : 
+    Combination of Residual Severity * Residual Probability
+    Values of 1 through 25 with 1 being the lowest.
+    """
+    RiskHierarchyLevelID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-RiskHierarchyLevel:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Risk Hierarchy Level ID')
+    """
+    Describes the Hierarchy Level the risk is applying to (such as Well, Field, Global…)
+    """
+    RiskCategoryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-RiskCategory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Risk Category ID')
+    """
+    General category of the described risk such as "Reservoir", "Overburden", "Life of Well", "Drilling", "Completion" or "Opportunity"
+    """
+    RiskSubCategoryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-RiskSubCategory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Risk Sub Category ID')
+    """
+    Detailed category of the described risk such as "BOP", "Casing", "Cementing", "Riserless"
+    """
+    RiskDisciplineID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-RiskDiscipline:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Risk Discipline ID')
+    """
+    Describes the "discipline" that may be affected by the risk
+    """
+    Mitigations: list[Mitigation] | None = Field(None, title='Mitigations')
+    """
+    Describes the measure or measures that may be applied to the risk to mitigate its consequences
+    """
+    Name: str | None = Field(None, title='Name')
+    """
+    The common or preferred name for a risk
+    """
+    Description: str | None = Field(None, title='Description')
+    """
+    Description of the risk
+    """
+    Summary: str | None = Field(None, title='Summary')
+    """
+    Short description of the risk
+    """
+    EffectiveDateTime: str | None = Field(None, title='Effective Data Time')
+    """
+    Date and time that activities started.
+    """
+    TerminationDateTime: str | None = Field(None, title='Termination Date Time')
+    """
+    Date and time that activities were completed.
+    """
+    TypeID: (
+        constr(pattern=r'^[\w\-\.]+:reference-data\-\-RiskType:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Type')
+    """
+    The type of risk.
+    """
+    AffectedPersonnel: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Affected Personnel')
+    """
+    Describes the entity that may be affected by the risk
+    """
+    RiskResponsibles: list[v1_0_0.AbstractContact] | None = Field(
+        None, title='Responsibles'
+    )
+    """
+    Describes the responsibles (person/role/entity) for managing the risk
+    """
+    ExtendedRiskCategory: str | None = Field(None, title='Extended Risk Category')
+    """
+    Custom string to further extend the risk categorization
+    """
+    NetSeverity: float | None = Field(None, title='Net Severity')
+    """
+    Assumes PREVENTION AND MITIGATION barriers are in place to manage the risk event
+    """
+    NetProbability: float | None = Field(None, title='Net Probability')
+    """
+    Assumes PREVENTION AND MITIGATION barriers are in place to manage the risk event
+    """
+    NetRiskScore: float | None = Field(None, title='Net Score')
+    """
+    Assumes PREVENTION AND MITIGATION barriers are in place to manage the risk event  which is the combination of : 
+    Net Severity * Net Probability
+    """
+    RelatedRiskSetID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-PersistedCollection:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(None, title='Related RiskSet ID')
+    """
+    Identifier of the Related Risks collection
+    """
+    WellboreID: constr(
+        pattern=r'^[\w\-\.]+:master-data\-\-Wellbore:[\w\-\.\:\%]+:[0-9]*$'
+    ) = Field(..., title='Wellbore ID')
+    """
+    Identifier of the planned Wellbore
+    """
+    RiskStartDepth: float | None = Field(None, title='Risk Start Depth')
+    """
+    start depth of the risk interval. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    RiskEndDepth: float | None = Field(None, title='Risk End Depth')
+    """
+    end depth of the risk interval. Depth relative to Planned wellbore ZDP. Navigate via WellboreID to the side-car WellPlanningWellbore, which holds the depth reference in data.VerticalMeasurement.
+    """
+    ExtensionProperties: dict[str, Any] | None = None