orchid-python-api 5.25.3__py3-none-any.whl → 5.25.4__py3-none-any.whl

orchid/native_well_adapter.py

@@ -1,134 +0,0 @@
-#  Copyright (c) 2017-2025 KAPPA
-#
-#  Licensed under the Apache License, Version 2.0 (the "License"); 
-#  you may not use this file except in compliance with the License. 
-#  You may obtain a copy of the License at 
-#
-#      http://www.apache.org/licenses/LICENSE-2.0 
-#
-#  Unless required by applicable law or agreed to in writing, software 
-#  distributed under the License is distributed on an "AS IS" BASIS, 
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
-#  See the License for the specific language governing permissions and 
-#  limitations under the License. 
-#
-# This file is part of Orchid and related technologies.
-#
-
-from collections import namedtuple
-from typing import Iterable
-
-import option
-import toolz.curried as toolz
-
-import orchid.base
-from orchid import (
-    dot_net_dom_access as dna,
-    dot_net_disposable as dnd,
-    dom_project_object as dpo,
-    searchable_stages as oss,
-    measurement as om,
-    native_stage_adapter as nsa,
-    native_subsurface_point as nsp,
-    native_trajectory_adapter as nta,
-    net_quantity as onq,
-    reference_origins as origins,
-)
-
-# noinspection PyUnresolvedReferences
-from Orchid.FractureDiagnostics import IStage, IWell
-# noinspection PyUnresolvedReferences
-import UnitsNet
-# noinspection PyUnresolvedReferences
-from System import Array, UInt32
-
-WellHeadLocation = namedtuple('WellHeadLocation',
-                              ['easting', 'northing', 'depth'])
-
-
-def replace_no_uwi_with_text(uwi):
-    return uwi if uwi else 'No UWI'
-
-
-class NativeWellAdapter(dpo.DomProjectObject):
-    """Adapts a native IWell to python."""
-
-    def __init__(self, net_well: IWell):
-        """
-        Constructs an instance adapting a .NET IWell.
-
-        Args:
-            net_well: The .NET well to be adapted.
-        """
-        super().__init__(net_well, orchid.base.constantly(net_well.Project))
-
-    trajectory = dna.transformed_dom_property('trajectory', 'The trajectory of the adapted .NET well.',
-                                              nta.NativeTrajectoryAdapterIdentified)
-    uwi = dna.transformed_dom_property('uwi', 'The UWI of the adapted .', replace_no_uwi_with_text)
-
-    # The formation property **does not** check when a `None` value is passed from Orchid.
-    # Although it is possible, it is very unlikely to occur from IWell.Formation.
-    formation = dna.dom_property('formation', 'The production formation the well is landed')
-
-    @property
-    def ground_level_elevation_above_sea_level(self) -> om.Quantity:
-        return onq.as_measurement(self.expect_project_units.LENGTH,
-                                  option.maybe(self.dom_object.GroundLevelElevationAboveSeaLevel))
-
-    @property
-    def kelly_bushing_height_above_ground_level(self) -> om.Quantity:
-        return onq.as_measurement(self.expect_project_units.LENGTH,
-                                  option.maybe(self.dom_object.KellyBushingHeightAboveGroundLevel))
-
-    @property
-    def wellhead_location(self):
-        dom_whl = self.dom_object.WellHeadLocation
-        result = toolz.pipe(dom_whl,
-                            toolz.map(option.maybe),
-                            toolz.map(onq.as_measurement(self.expect_project_units.LENGTH)),
-                            list, )
-        return WellHeadLocation(*result)
-
-    def stages(self) -> oss.SearchableStages:
-        """
-        Return a `spo.SearchableProjectObjects` instance of all the stages for this project.
-
-        Returns:
-            An `spo.SearchableProjectObjects` for all the stages of this project.
-        """
-        return oss.SearchableStages(nsa.NativeStageAdapter, self.dom_object.Stages.Items)
-
-    def locations_for_md_kb_values(self,
-                                   md_kb_values: Iterable[om.Quantity],
-                                   well_reference_frame_xy: origins.WellReferenceFrameXy,
-                                   depth_origin: origins.DepthDatum) -> Iterable[nsp.SubsurfacePoint]:
-        sample_at = Array[UnitsNet.Length](toolz.map(onq.as_net_quantity(self.expect_project_units.LENGTH),
-                                                     md_kb_values))
-        result = toolz.pipe(
-            self.dom_object.GetLocationsForMdKbValues(sample_at, well_reference_frame_xy.value, depth_origin.value),
-            toolz.map(nsp.make_subsurface_point(self.expect_project_units.LENGTH)),
-            list,
-        )
-        return result
-
-    def add_stages(self, create_stage_dtos: Iterable[nsa.CreateStageDto]):
-        created_stages = [csd.create_stage(self) for csd in create_stage_dtos]
-
-        with dnd.disposable(self.dom_object.ToMutable()) as mutable_well:
-            native_created_stages = self._create_net_stages(created_stages)
-            mutable_well.AddStages(native_created_stages)
-
-    @staticmethod
-    def _create_net_stages(created_stages):
-        """
-        Create a .NET `Array<IStage>`.
-
-        This method primarily exists so that I can mock the call in unit tests.
-
-        Args:
-            created_stages: The `NativeStageAdapter` iterable over the created stages to add.
-
-        Returns:
-            The newly created .NET `Array<IStage>` instance.
-        """
-        return Array[IStage]([created_stage.dom_object for created_stage in created_stages])

orchid/net_date_time.py

@@ -1,328 +0,0 @@
-#
-# This file is part of Orchid and related technologies.
-#
-# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
-#
-# LEGAL NOTICE:
-# Orchid contains trade secrets and otherwise confidential information
-# owned by KAPPA. Access to and use of this information is
-# strictly limited and controlled by the Company. This file may not be copied,
-# distributed, or otherwise disclosed outside of the Company's facilities 
-# except under appropriate precautions to maintain the confidentiality hereof, 
-# and may not be used in any way not expressly authorized by the Company.
-#
-
-"""
-Functions to convert between .NET `DateTime` and similar instances and Python `pendulum` instances.
-"""
-
-
-import datetime as dt
-import enum
-import functools
-from typing import Tuple, Union
-
-import dateutil.tz as duz
-import pendulum as pdt
-
-from orchid import base
-
-# noinspection PyUnresolvedReferences,PyPackageRequirements
-from System import (DateTime, DateTimeKind, DateTimeOffset, TimeSpan)
-
-
-# Encapsulate the use of pendulum and DateTime.
-UTC = pdt.UTC
-NET_NAT = DateTime.MinValue
-NAT = pdt.DateTime.min
-
-
-class TimePointTimeZoneKind(enum.Enum):
-    """Models the kind of time point.
-
-    This class eases conversions to the .NET `DateTime` class by providing Python with similar capabilities as
-    the .NET `Enum`. (See
-    [DateTimeKind](https://docs.microsoft.com/en-us/dotnet/api/system.datetimekind?view=net-5.0) for details).
-    """
-    UTC = DateTimeKind.Utc  # Time zone is UTC
-    LOCAL = DateTimeKind.Local  # Time zone is specified to be local
-    UNSPECIFIED = DateTimeKind.Unspecified  # Time zone is unspecified
-
-
-class NetDateTimeError(ValueError):
-    """
-    Raised when an error occurs accessing the .NET `TimeZoneInfo` of a .NET `DateTime` instance.
-    """
-    pass
-
-
-class NetDateTimeLocalDateTimeKindError(NetDateTimeError):
-    """
-    Raised when the `DateTime.Kind` property of a .NET `DateTime` instance is `DateTimeKind.Local`.
-    """
-    def __init__(self, net_time_point: Union[DateTime, DateTimeOffset]):
-        """
-        Construct an instance from a .NET DateTime point in time.
-
-        Args:
-            net_time_point: A .NET DateTime representing a specific point in time.
-        """
-        super().__init__(self, '.NET DateTimeKind cannot be Local.', net_time_point.ToString("O"))
-
-
-class NetDateTimeUnspecifiedDateTimeKindError(NetDateTimeError):
-    """
-    Raised when the `DateTimeKind` property of a .NET `DateTime` instance is not recognized.
-    """
-    ERROR_PREFACE = '.NET DateTimeKind is unexpectedly Unspecified.'
-
-    ERROR_SUFFIX = """
-    Although .NET DateTime.Kind should not be Unspecified, it may be
-    safe to ignore this error by catching the exception.
-
-    However, because it unexpected, **please** report the issue to
-    Reveal Energy Services. 
-    """
-
-    def __init__(self, net_time_point: Union[DateTime, DateTimeOffset]):
-        """
-        Construct an instance from a .NET DateTime point in time.
-
-        Args:
-            net_time_point: A .NET DateTime representing a specific point in time.
-        """
-        super().__init__(self, NetDateTimeUnspecifiedDateTimeKindError.ERROR_PREFACE,
-                         net_time_point.ToString("O"), NetDateTimeUnspecifiedDateTimeKindError.ERROR_SUFFIX)
-
-
-class NetDateTimeNoTzInfoError(NetDateTimeError):
-    """
-    Raised when the `DateTimeKind` property of a .NET `DateTime` instance is
-    `DateTimeKind.Unspecified`.
-    """
-    def __init__(self, time_point):
-        """
-        Construct an instance from a Python point in time.
-
-        Args:
-            time_point: A `pdt.DateTime` representing a specific point in time.
-        """
-        super().__init__(self, f'The Python time point must specify the time zone.', time_point.isoformat())
-
-
-class NetDateTimeOffsetNonZeroOffsetError(NetDateTimeError):
-    """
-    Raised when the `Offset` property of a .NET `DateTimeOffset` is non-zero.
-    """
-    def __init__(self, net_date_time_offset):
-        """
-        Construct an instance from a .NET `DateTimeOffset`.
-
-        Args:
-            net_date_time_offset: A .NET `DateTimeOffset` representing a specific point in time.
-        """
-        super().__init__(self,
-                         f'The `Offset` of the .NET `DateTimeOffset`, {net_date_time_offset.ToString("o")},'
-                         ' cannot be non-zero.')
-
-
-@functools.singledispatch
-def as_date_time(net_time_point: object) -> pdt.DateTime:
-    raise NotImplementedError
-
-
-@as_date_time.register(type(None))
-def _(net_time_point) -> pdt.DateTime:
-    """
-    Convert a .NET `DateTime` instance to a `pdt.DateTime` instance.
-
-    Args:
-        net_time_point: A point in time of type .NET `DateTime`.
-
-    Returns:
-        The `pdt.DateTime` equivalent to the `to_test`.
-
-        If `net_time_point` is `DateTime.MaxValue`, returns `pdt.DateTime.max`. If `net_time_point` is
-        `DateTime.MinValue`, returns `DATETIME_NAT`.
-    """
-    return NAT
-
-
-@as_date_time.register
-def _(net_time_point: DateTime) -> pdt.DateTime:
-    """
-    Convert a .NET `DateTime` instance to a `pdt.DateTime` instance.
-
-    Args:
-        net_time_point: A point in time of type .NET `DateTime`.
-
-    Returns:
-        The `pdt.DateTime` equivalent to the `to_test`.
-
-        If `net_time_point` is `DateTime.MaxValue`, returns `pdt.DateTime.max`. If `net_time_point` is
-        `DateTime.MinValue`, returns `DATETIME_NAT`.
-    """
-    if net_time_point == DateTime.MaxValue:
-        return pdt.DateTime.max
-
-    if net_time_point == DateTime.MinValue:
-        return NAT
-
-    if net_time_point.Kind == DateTimeKind.Utc:
-        return _net_time_point_to_datetime(base.constantly(pdt.UTC), net_time_point)
-
-    if net_time_point.Kind == DateTimeKind.Unspecified:
-        raise NetDateTimeUnspecifiedDateTimeKindError(net_time_point)
-
-    if net_time_point.Kind == DateTimeKind.Local:
-        raise NetDateTimeLocalDateTimeKindError(net_time_point)
-
-    raise ValueError(f'Unknown .NET DateTime.Kind, {net_time_point.Kind}.')
-
-
-@as_date_time.register
-def _(net_time_point: DateTimeOffset) -> pdt.DateTime:
-    """
-    Convert a .NET `DateTimeOffset` instance to a `pdt.DateTime` instance.
-
-    Args:
-        net_time_point: A point in time of type .NET `DateTimeOffset`.
-
-    Returns:
-        The `pdt.DateTime` equivalent to the `net_time_point`.
-    """
-    if net_time_point == DateTimeOffset.MaxValue:
-        return pdt.DateTime.max
-
-    if net_time_point == DateTimeOffset.MinValue:
-        return NAT
-
-    def net_date_time_offset_to_timezone(ntp):
-        integral_offset = int(ntp.Offset.TotalSeconds)
-        if integral_offset == 0:
-            return pdt.UTC
-
-        return pdt.timezone(integral_offset)
-
-    return _net_time_point_to_datetime(net_date_time_offset_to_timezone, net_time_point)
-
-
-def as_net_date_time(time_point: pdt.DateTime) -> DateTime:
-    """
-    Convert a `pdt.DateTime` instance to a .NET `DateTime` instance.
-
-    Args:
-        time_point: The `pdt.DateTime` instance to covert.
-
-    Returns:
-        The equivalent .NET `DateTime` instance.
-
-        If `time_point` is `pdt.DateTime.max`, return `DateTime.MaxValue`. If `time_point` is
-        `DATETIME_NAT`, return `DateTime.MinValue`.
-    """
-    if time_point == pdt.DateTime.max:
-        return DateTime.MaxValue
-
-    if time_point == NAT:
-        return DateTime.MinValue
-
-    if not time_point.tzinfo == pdt.UTC:
-        raise NetDateTimeNoTzInfoError(time_point)
-
-    carry_seconds, milliseconds = microseconds_to_milliseconds_with_carry(time_point.microsecond)
-    result = DateTime(time_point.year, time_point.month, time_point.day,
-                      time_point.hour, time_point.minute, time_point.second + carry_seconds,
-                      milliseconds, DateTimeKind.Utc)
-    return result
-
-
-def as_net_date_time_offset(time_point: pdt.DateTime) -> DateTimeOffset:
-    """
-    Convert a `pdt.DateTime` instance to a .NET `DateTimeOffset` instance.
-
-    Args:
-        time_point: The `pdt.DateTime` instance to covert.
-
-    Returns:
-        The equivalent .NET `DateTimeOffset` instance.
-
-        If `time_point` is `pdt.DateTime.max`, return `DateTime.MaxValue`. If `time_point` is
-        `DATETIME_NAT`, return `DateTime.MinValue`.
-    """
-    if time_point == pdt.DateTime.max:
-        return DateTimeOffset.MaxValue
-
-    if time_point == NAT:
-        return DateTimeOffset.MinValue
-
-    date_time = as_net_date_time(time_point)
-    result = DateTimeOffset(date_time)
-    return result
-
-
-def as_net_time_span(to_convert: pdt.Duration):
-    """
-    Convert a `pdt.Duration` instance to a .NET `TimeSpan`.
-
-    Args:
-        to_convert: The `pdt.Duration` instance to convert.
-
-    Returns:
-        The .NET `TimeSpan` equivalent to `to_convert`.
-    """
-    return TimeSpan(round(to_convert.total_seconds() * TimeSpan.TicksPerSecond))
-
-
-def as_duration(to_convert: TimeSpan) -> pdt.Duration:
-    """
-    Convert a .NET `TimeSpan` to a python `pdt.Duration`
-
-    Args:
-        to_convert: The .NET `TimeSpan` to convert.
-
-    Returns:
-        The `pdt.Duration` equivalent to `to_convert`.
-
-    """
-    return pdt.duration(seconds=to_convert.TotalSeconds)
-
-
-def as_time_delta(net_time_span: TimeSpan):
-    """
-    Convert a .NET `TimeSpan` to a Python `dt.timedelta`.
-
-    Args:
-        net_time_span: The .NET `TimeSpan` to convert.
-
-    Returns:
-        The equivalent dt.time_delta value.
-
-    """
-    return dt.timedelta(seconds=net_time_span.TotalSeconds)
-
-
-def microseconds_to_milliseconds_with_carry(to_convert: int) -> Tuple[int, int]:
-    """
-    Convert microseconds to an integral number of milliseconds with a number of seconds to carry.
-
-    Args:
-        to_convert: The microseconds to convert.
-
-    Returns:
-        A tuple of the form, (number of seconds to "carry",  number of the integral milliseconds).
-    """
-
-    raw_milliseconds = round(to_convert / 1000)
-    return divmod(raw_milliseconds, 1000)
-
-
-def is_utc(time_point):
-    return (time_point.tzinfo == pdt.UTC or
-            time_point.tzinfo == dt.timezone.utc or
-            time_point.tzinfo == duz.UTC)
-
-
-def _net_time_point_to_datetime(time_zone_func, net_time_point):
-    return pdt.datetime(net_time_point.Year, net_time_point.Month, net_time_point.Day,
-                        net_time_point.Hour, net_time_point.Minute, net_time_point.Second,
-                        net_time_point.Millisecond * 1000, tz=time_zone_func(net_time_point))

orchid/net_enumerable.py

@@ -1,72 +0,0 @@
-#
-# This file is part of Orchid and related technologies.
-#
-# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
-#
-# LEGAL NOTICE:
-# Orchid contains trade secrets and otherwise confidential information
-# owned by KAPPA. Access to and use of this information is
-# strictly limited and controlled by the Company. This file may not be copied,
-# distributed, or otherwise disclosed outside of the Company's facilities 
-# except under appropriate precautions to maintain the confidentiality hereof, 
-# and may not be used in any way not expressly authorized by the Company.
-#
-
-"""Defines conversions involving .NET IEnumerable instances."""
-
-from functools import singledispatch
-from typing import List
-
-# noinspection PyUnresolvedReferences
-import orchid  # Only to call `pythonnet.load('netfx')`
-
-from pythonnet import load
-load('coreclr')
-
-# noinspection PyUnresolvedReferences,PyPackageRequirements
-import clr
-# noinspection PyUnresolvedReferences
-clr.AddReference('System.Collections')
-# noinspection PyUnresolvedReferences
-clr.AddReference('DynamicData')
-
-# noinspection PyUnresolvedReferences,PyPackageRequirements
-from System.Collections import IEnumerable
-# noinspection PyUnresolvedReferences,PyPackageRequirements
-from DynamicData import (IObservableCache, IObservableList)
-
-
-@singledispatch
-def as_list(net_object) -> List:
-    raise NotImplementedError
-
-
-@as_list.register(IEnumerable)
-def as_list_from_enumerable(net_object) -> List:
-    """
-    Convert a .NET `IEnumerable` to a Python `list`.
-
-    Args:
-        net_object: An .NET instance implementing the `IEnumerable` (and `IEnumerable<T>`) interfaces.
-
-    Returns:
-        The Python `list` containing the same items as the source .NET `IEnumerable`.
-
-    """
-    return [i for i in net_object]
-
-
-@as_list.register(IObservableCache)
-@as_list.register(IObservableList)
-def as_list_from_dynamic_data(net_object) -> List:
-    """
-    Convert a .NET `IEnumerable` to a Python `list`.
-
-    Args:
-        net_object: An .NET instance implementing the `IEnumerable` (and `IEnumerable<T>`) interfaces.
-
-    Returns:
-        The Python `list` containing the same items as the source .NET `IEnumerable`.
-
-    """
-    return [i for i in net_object.Items]

orchid/net_fracture_diagnostics_factory.py

@@ -1,55 +0,0 @@
-#
-# This file is part of Orchid and related technologies.
-#
-# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
-#
-# LEGAL NOTICE:
-# Orchid contains trade secrets and otherwise confidential information
-# owned by KAPPA. Access to and use of this information is
-# strictly limited and controlled by the Company. This file may not be copied,
-# distributed, or otherwise disclosed outside of the Company's facilities 
-# except under appropriate precautions to maintain the confidentiality hereof, 
-# and may not be used in any way not expressly authorized by the Company.
-#
-
-
-import functools
-
-import pendulum
-
-from orchid import net_date_time as ndt
-
-# noinspection PyUnresolvedReferences
-from Orchid.FractureDiagnostics import IFractureDiagnosticsFactory
-# noinspection PyUnresolvedReferences
-from Orchid.FractureDiagnostics.Factories import FractureDiagnosticsFactory
-# noinspection PyUnresolvedReferences
-from Orchid.FractureDiagnostics.Factories.ReferenceCounting import NullReferenceCounterFactory
-
-
-@functools.lru_cache
-def create() -> IFractureDiagnosticsFactory:
-    """
-    Return an instance of the fracture diagnostics factory used by .NET to construct DOM instances.
-
-    >>> start = pendulum.parse('2022-02-23T15:53:23Z')
-    >>> stop = pendulum.parse('2022-02-24T05:54:11Z')
-    >>> net_start = ndt.as_net_date_time(start)
-    >>> net_stop = ndt.as_net_date_time(stop)
-    >>> factory = create()
-    >>> date_time_offset_range = factory.CreateDateTimeOffsetRange(net_start, net_stop)
-    >>> date_time_offset_range.Start.__implementation__.ToString('o')
-    '2022-02-23T15:53:23.0000000+00:00'
-    >>> date_time_offset_range.Stop.__implementation__.ToString('o')
-    '2022-02-24T05:54:11.0000000+00:00'
-
-    Returns:
-        An instance of the fracture diagnostics factory.
-    """
-    # TODO: We will need a "real" reference counter factory to support deleting DOM instances
-    return FractureDiagnosticsFactory.Create(NullReferenceCounterFactory())
-
-
-if __name__ == '__main__':
-    import doctest
-    doctest.testmod()