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

osdu_models/abstract/abstract_facility/v1_1_0.py

@@ -0,0 +1,91 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_facility/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ..abstract_facility_operator import v1_1_0
+from ..abstract_alias_names import v1_0_0
+from ..abstract_facility_state import v1_1_0 as v1_1_0_1
+from ..abstract_facility_event import v1_1_0 as v1_1_0_2
+from ..abstract_facility_specification import v1_0_0 as v1_0_0_1
+
+
+class AbstractFacility(BaseModel):
+    """
+    The schema fragment included by facilities. A facility is a grouping of equipment that is located within a specific geographic boundary or site and that is used in the context of energy-related activities such as exploration, extraction, generation, storage, processing, disposal, supply, or transfer. Clarifications: (1) A facility may be surface or subsurface located. (2) Usually facility equipment is commonly owned or operated. (3) Industry definitions may vary and differ from this one. This schema fragment is included by Well, Wellbore, Rig, as well as Tank Batteries, Compression Stations, Storage Facilities, Wind Farms, Wind Turbines, Mining Facilities, etc., once these types are included in to the OSDU.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FacilityID: str | None = Field(None, title='External Facility 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.
+    """
+    FacilityTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FacilityType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The definition of a kind of capability to perform a business function or a service.
+    """
+    FacilityOperators: list[v1_1_0.AbstractFacilityOperator] | None = None
+    """
+    The history of operator organizations of the facility.
+    """
+    InitialOperatorID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Initial Operator ID')
+    """
+    A initial operator organization ID; the organization ID may also be found in the FacilityOperatorOrganisationID of the FacilityOperator array providing the actual dates.
+    """
+    CurrentOperatorID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = Field(None, title='Current Operator ID')
+    """
+    The current operator organization ID; the organization ID may also be found in the FacilityOperatorOrganisationID of the FacilityOperator array providing the actual dates.
+    """
+    DataSourceOrganisationID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    The main source of the header information.
+    """
+    OperatingEnvironmentID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-OperatingEnvironment:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Identifies the Facility's general location as being onshore vs. offshore.
+    """
+    FacilityName: str | None = None
+    """
+    Name of the Facility.
+    """
+    FacilityDescription: str | None = Field(None, title='Facility Description')
+    """
+    A descriptive text or remark about the Facility.
+    """
+    FacilityNameAliases: list[v1_0_0.AbstractAliasNames] | None = None
+    """
+    DEPRECATED: please use data.NameAliases. Alternative names, including historical, by which this facility is/has been known.
+    """
+    FacilityStates: list[v1_1_0_1.AbstractFacilityState] | None = None
+    """
+    The history of life cycle states the facility has been through.
+    """
+    FacilityEvents: list[v1_1_0_2.AbstractFacilityEvent] | None = None
+    """
+    A list of key facility events.
+    """
+    FacilitySpecifications: list[v1_0_0_1.AbstractFacilitySpecification] | None = None
+    """
+    facilitySpecification maintains the specification like slot name, wellbore drilling permit number, rig name etc.
+    """

osdu_models/abstract/abstract_facility_event/__init__.py

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

osdu_models/abstract/abstract_facility_event/v1_0_0.py

@@ -0,0 +1,32 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_facility_event/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, constr
+
+
+class AbstractFacilityEvent(BaseModel):
+    """
+    A significant occurrence in the life of a facility, which often changes its state, or the state of one of its components. It can describe a point-in-time (event) or a time interval of a specific type (FacilityEventType).
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FacilityEventTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FacilityEventType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The facility event type is a picklist. Examples: 'Permit', 'Spud', 'Abandon', etc.
+    """
+    EffectiveDateTime: str | None = None
+    """
+    The date and time at which the event took place or takes effect.
+    """
+    TerminationDateTime: str | None = None
+    """
+    The date and time at which the event is no longer in effect. For point-in-time events the 'TerminationDateTime' must be set equal to 'EffectiveDateTime'. Open time intervals have an absent 'TerminationDateTime'.
+    """

osdu_models/abstract/abstract_facility_event/v1_1_0.py

@@ -0,0 +1,36 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_facility_event/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, constr
+
+
+class AbstractFacilityEvent(BaseModel):
+    """
+    A significant occurrence in the life of a facility, which often changes its state, or the state of one of its components. It can describe a point-in-time (event) or a time interval of a specific type (FacilityEventType).
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FacilityEventTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FacilityEventType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The facility event type is a picklist. Examples: 'Permit', 'Spud', 'Abandon', etc.
+    """
+    EffectiveDateTime: str | None = None
+    """
+    The date and time at which the event took place or takes effect.
+    """
+    TerminationDateTime: str | None = None
+    """
+    The date and time at which the event is no longer in effect. For point-in-time events the 'TerminationDateTime' must be set equal to 'EffectiveDateTime'. Open time intervals have an absent 'TerminationDateTime'.
+    """
+    Remark: str | None = None
+    """
+    A comment or remark about the facility event.
+    """

osdu_models/abstract/abstract_facility_operator/__init__.py

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

osdu_models/abstract/abstract_facility_operator/v1_0_0.py

@@ -0,0 +1,34 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_facility_operator/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractFacilityOperator(BaseModel):
+    """
+    The organisation that was responsible for a facility at some point in time.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FacilityOperatorID: str | None = Field(None, title='Facility Operator ID')
+    """
+    Internal, unique identifier for an item 'AbstractFacilityOperator'. This identifier is used by 'AbstractFacility.CurrentOperatorID' and 'AbstractFacility.InitialOperatorID'.
+    """
+    FacilityOperatorOrganisationID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    The company that currently operates, or previously operated the facility
+    """
+    EffectiveDateTime: str | None = None
+    """
+    The date and time at which the facility operator becomes effective.
+    """
+    TerminationDateTime: str | None = None
+    """
+    The date and time at which the facility operator is no longer in effect. If the operator is still effective, the 'TerminationDateTime' is left absent.
+    """

osdu_models/abstract/abstract_facility_operator/v1_1_0.py

@@ -0,0 +1,38 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_facility_operator/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractFacilityOperator(BaseModel):
+    """
+    The organisation that was responsible for a facility at some point in time.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FacilityOperatorID: str | None = Field(None, title='Facility Operator ID')
+    """
+    Internal, unique identifier for an item 'AbstractFacilityOperator'. This identifier is used by 'AbstractFacility.CurrentOperatorID' and 'AbstractFacility.InitialOperatorID'.
+    """
+    FacilityOperatorOrganisationID: (
+        constr(pattern=r'^[\w\-\.]+:master-data\-\-Organisation:[\w\-\.\:\%]+:[0-9]*$')
+        | None
+    ) = None
+    """
+    The company that currently operates, or previously operated the facility
+    """
+    EffectiveDateTime: str | None = None
+    """
+    The date and time at which the facility operator becomes effective.
+    """
+    TerminationDateTime: str | None = None
+    """
+    The date and time at which the facility operator is no longer in effect. If the operator is still effective, the 'TerminationDateTime' is left absent.
+    """
+    Remark: str | None = None
+    """
+    A comment or remark about the facility operator.
+    """

osdu_models/abstract/abstract_facility_specification/__init__.py

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

osdu_models/abstract/abstract_facility_specification/v1_0_0.py

@@ -0,0 +1,57 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_facility_specification/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, constr
+
+
+class AbstractFacilitySpecification(BaseModel):
+    """
+    A property, characteristic, or attribute about a facility that is not described explicitly elsewhere.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EffectiveDateTime: str | None = None
+    """
+    The date and time at which the facility specification instance becomes effective.
+    """
+    TerminationDateTime: str | None = None
+    """
+    The date and time at which the facility specification instance is no longer in effect.
+    """
+    FacilitySpecificationQuantity: float | None = None
+    """
+    The value for the specified parameter type.
+    """
+    FacilitySpecificationDateTime: str | None = None
+    """
+    The actual date and time value of the parameter.
+    """
+    FacilitySpecificationIndicator: bool | None = None
+    """
+    The actual indicator value of the parameter.
+    """
+    FacilitySpecificationText: str | None = None
+    """
+    The actual text value of the parameter.
+    """
+    UnitOfMeasureID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The unit for the quantity parameter, like metre (m in SI units system) for quantity Length.
+    """
+    ParameterTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-ParameterType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Parameter type of property or characteristic.
+    """

osdu_models/abstract/abstract_facility_state/__init__.py

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

osdu_models/abstract/abstract_facility_state/v1_0_0.py

@@ -0,0 +1,32 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_facility_state/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, constr
+
+
+class AbstractFacilityState(BaseModel):
+    """
+    The life cycle status of a facility at some point in time.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EffectiveDateTime: str | None = None
+    """
+    The date and time at which the facility state becomes effective.
+    """
+    TerminationDateTime: str | None = None
+    """
+    The date and time at which the facility state is no longer in effect.
+    """
+    FacilityStateTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FacilityStateType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Life Cycle [Facility State Type] is a set of major phases that are significant to regulators and/or business stakeholders. Life Cycle may apply to a well or its components [or other facility].
+    """

osdu_models/abstract/abstract_facility_state/v1_1_0.py

@@ -0,0 +1,36 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_facility_state/v1_1_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, constr
+
+
+class AbstractFacilityState(BaseModel):
+    """
+    The life cycle status of a facility at some point in time.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EffectiveDateTime: str | None = None
+    """
+    The date and time at which the facility state becomes effective.
+    """
+    TerminationDateTime: str | None = None
+    """
+    The date and time at which the facility state is no longer in effect.
+    """
+    FacilityStateTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-FacilityStateType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Life Cycle [Facility State Type] is a set of major phases that are significant to regulators and/or business stakeholders. Life Cycle may apply to a well or its components [or other facility].
+    """
+    Remark: str | None = None
+    """
+    A comment or remark about the facility state.
+    """

osdu_models/abstract/abstract_facility_vertical_measurement/__init__.py

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

osdu_models/abstract/abstract_facility_vertical_measurement/v1_0_0.py

@@ -0,0 +1,98 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_facility_vertical_measurement/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, constr
+
+
+class AbstractFacilityVerticalMeasurement(BaseModel):
+    """
+    A location along a wellbore, _usually_ associated with some aspect of the drilling of the wellbore, but not with any intersecting _subsurface_ natural surfaces.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    EffectiveDateTime: str | None = None
+    """
+    The date and time at which a vertical measurement instance becomes effective.
+    """
+    VerticalMeasurement: float | None = None
+    """
+    The value of the elevation or depth. Depth is positive downwards from a vertical reference or geodetic datum along a path, which can be vertical; elevation is positive upwards from a geodetic datum along a vertical path. Either can be negative.
+    """
+    TerminationDateTime: str | None = None
+    """
+    The date and time at which a vertical measurement instance is no longer in effect.
+    """
+    VerticalMeasurementTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-VerticalMeasurementType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Specifies the type of vertical measurement (TD, Plugback, Kickoff, Drill Floor, Rotary Table...).
+    """
+    VerticalMeasurementPathID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-VerticalMeasurementPath:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Specifies Measured Depth, True Vertical Depth, or Elevation.
+    """
+    VerticalMeasurementSourceID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-VerticalMeasurementSource:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Specifies Driller vs Logger.
+    """
+    WellboreTVDTrajectoryID: (
+        constr(
+            pattern=r'^[\w\-\.]+:work-product-component\-\-WellboreTrajectory:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    Specifies what directional survey or wellpath was used to calculate the TVD.
+    """
+    VerticalMeasurementUnitOfMeasureID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    The unit of measure for the vertical measurement. If a unit of measure and a vertical CRS are provided, the unit of measure provided is taken over the unit of measure from the CRS.
+    """
+    VerticalCRSID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-CoordinateReferenceSystem:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    A vertical coordinate reference system defines the origin for height or depth values. It is expected that either VerticalCRSID or VerticalReferenceID reference is provided in a given vertical measurement array object, but not both.
+    """
+    VerticalReferenceID: str | None = None
+    """
+    The reference point from which the relative vertical measurement is made. This is only populated if the measurement has no VerticalCRSID specified. The value entered must match the VerticalMeasurementID for another vertical measurement array element in Wellbore or Well or in a related parent facility. The relationship should be  declared explicitly in VerticalReferenceEntityID. Any chain of measurements must ultimately resolve to a Vertical CRS. It is expected that a VerticalCRSID or a VerticalReferenceID is provided in a given vertical measurement array object, but not both.
+    """
+    VerticalReferenceEntityID: (
+        constr(
+            pattern=r'^[\w\-\.]+:(master-data\-\-Wellbore|master-data\-\-Well|master-data\-\-Rig):[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = None
+    """
+    This relationship identifies the entity (aka record) in which the VerticalReferenceID is found; It could be a different OSDU entity or a self-reference. For example, a Wellbore VerticalMeasurement may reference a member of a VerticalMeasurements[] array in its parent Well record. Alternatively, VerticalReferenceEntityID may be populated with the ID of its own Wellbore record to make explicit that VerticalReferenceID is intended to be found in this record, not another.
+    """
+    VerticalMeasurementDescription: str | None = None
+    """
+    Text which describes a vertical measurement in detail.
+    """

osdu_models/abstract/abstract_feature_collection/__init__.py

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