orchid-python-api 5.24.4__tar.gz → 5.25.2__tar.gz

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: orchid-python-api
-Version: 5.24.4
+Version: 5.25.2
 Summary: Defines and implements the Python API for Orchid*. (*Orchid is a mark of KAPPA.)
 Home-page: https://github.com/Reveal-Energy-Services/orchid-python-api
 License: Apache-2.0
@@ -24,22 +24,24 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Dist: deal (>=4.23.4,<5.0.0)
-Requires-Dist: ipython (>=8.7.0,<9.0.0)
-Requires-Dist: matplotlib (>=3.6.2,<4.0.0)
-Requires-Dist: numpy (>=1.23.5,<2.0.0)
+Provides-Extra: examples
+Requires-Dist: clr (==1.0.3)
+Requires-Dist: deal (>=4.24.4,<5.0.0)
+Requires-Dist: ipython (>=8.0,<9.0) ; extra == "examples"
+Requires-Dist: jupyterlab-vim ; extra == "examples"
+Requires-Dist: matplotlib (>=3.7,<4.0) ; extra == "examples"
+Requires-Dist: numpy (>=1.26.4,<2.0.0)
 Requires-Dist: option (>=2.1.0,<3.0.0)
 Requires-Dist: packaging (>=24.1,<25.0)
 Requires-Dist: pandas (>=2.2.2,<3.0.0)
 Requires-Dist: pendulum (>=3.0.0,<4.0.0)
 Requires-Dist: pint (>=0.20.1,<0.21.0)
-Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
-Requires-Dist: pythonnet (==3.0.3)
-Requires-Dist: pyyaml (>=6.0,<7.0)
-Requires-Dist: scipy (>=1.9.3,<2.0.0)
-Requires-Dist: seaborn (>=0.12.1,<0.13.0)
-Requires-Dist: toolz (>=0.12.0,<0.13.0)
-Requires-Dist: typing-extensions (>=4.4.0,<5.0.0)
+Requires-Dist: python-dateutil (>=2.9.0,<3.0.0)
+Requires-Dist: pythonnet (>=3.0.3,<4.0.0)
+Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
+Requires-Dist: scipy (>=1.10,<2.0) ; extra == "examples"
+Requires-Dist: seaborn (>=0.12,<0.13) ; extra == "examples"
+Requires-Dist: toolz (>=0.12.1,<0.13.0)
 Project-URL: Documentation, https://github.com/Reveal-Energy-Services/orchid-python-api/wiki
 Project-URL: Issues, https://github.com/Reveal-Energy-Services/orchid-python-api/issues
 Project-URL: Repository, https://github.com/Reveal-Energy-Services/orchid-python-api

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/ReleaseNotes.md

@@ -13,6 +13,55 @@ the [Python grip utility](https://pypi.org/project/grip/). This application allo
 files before sending off to GitHub". Although you need not send any of these file to `GitHub`, by using `grip` 
 to render the file, you can much more easily navigate the document links.
 
+### Release notes for 5.25.2
+
+This release is the production release of the Orchid Python API corresponding to Orchid 5.25.2. We have made the necessary
+updates to the Python API to remain compatible with the .NET API.
+
+A minor change has been made where we've split the dependencies between the example files and the sdk dependencies for a smaller footprint when installing the API. There are probably
+many ways to do this, but when installing the new package, if you want to install the example dependencies you can run `pip install .[examples]` or if using poetry `poetry install -E examples`
+
+#### Possible breaking .NET API changes
+
+- None
+
+#### Resolved Issues
+
+- None
+
+#### Features
+
+- None
+
+#### Known Issues
+
+- None
+
+### Release notes for 5.25.1
+
+This release is the production release of the Orchid Python API corresponding to Orchid 5.25.1. We have made the necessary
+updates to the Python API to remain compatible with the .NET API.
+
+Additionally, we have added a simple high level API to access fiber data. See `fiber_data_example.py` in the `examples\` folder.
+Note that even with a small fiber data set, converting the fiber data into a `pandas` data frame takes quite
+a while. Getting the data in .NET objects is fairly quick, so there may be room for other ideas there.
+
+#### Possible breaking .NET API changes
+
+- None
+
+#### Resolved Issues
+
+- None
+
+#### Features
+
+- None
+
+#### Known Issues
+
+- None
+
 ### Release notes for 5.24.4
 
 This release is the production release of the Orchid Python API corresponding to Orchid 5.24.3. We have made the necessary

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/copy_orchid_examples.py

@@ -2,7 +2,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/copy_orchid_low_level_examples.py

@@ -2,7 +2,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/copy_orchid_manual_examples.py

@@ -2,7 +2,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/copy_orchid_tutorials.py

@@ -2,7 +2,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

orchid_python_api-5.25.2/orchid/VERSION

@@ -0,0 +1 @@
+5.25.2

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/__init__.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/__version__.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/base.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/base_time_series_adapter.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/configuration.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/convert.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/core.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/dom_project_object.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/dot_net.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/dot_net_disposable.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/dot_net_dom_access.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/measurement.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/native_data_frame_adapter.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

orchid_python_api-5.25.2/orchid/native_fiber_data.py

@@ -0,0 +1,73 @@
+# noinspection PyUnresolvedReferences,PyPackageRequirements
+from Orchid.FractureDiagnostics.FiberDataSet import IFiberDataSet
+import orchid.base
+from orchid import (
+    dom_project_object as dpo,
+    native_fiber_data_set_info as info
+)
+from .utils import convert_dotnet_datetime_to_python_datetime
+from typing import List, Optional
+from datetime import datetime
+import pandas as pd
+
+INT32_MAX = 2147483647
+
+
+class NativeFiberData(dpo.DomProjectObject):
+    """Adapts a native IFiberDataSet to python."""
+
+    def __init__(self, net_fiber_data_set: IFiberDataSet):
+        """
+        Constructs an instance adapting a .NET IFiberDataSet.
+        Args:
+            net_fiber_data_set: The .NET fiber data set to be adapted.
+        """
+        super().__init__(net_fiber_data_set, orchid.base.constantly(net_fiber_data_set.Project))
+
+    @property
+    def file_path(self) -> str:
+        return self.dom_object.FilePath
+
+    @property
+    def depth_unit(self) -> str:
+        return self.dom_object.DepthUnit
+
+    @property
+    def timezone_info(self) -> str:
+        return self.dom_object.TimeZoneInfo
+
+    @property
+    def times_data_set(self) -> str:
+        return self.dom_object.TimesDataSet
+
+    @property
+    def data_sets_info(self) -> List[info.NativeFiberDataSetInfo]:
+        return [info.NativeFiberDataSetInfo(x) for x in self.dom_object.FiberDataSets]
+
+    def get_data_set(self, data_set_name: Optional[str] = None):
+        try:
+            data_set_info = next(x for x in self.dom_object.FiberDataSets if x.name == data_set_name) if data_set_name is not None else self.dom_object.FiberDataSets[0]
+        except StopIteration:
+            raise ValueError("No Data Set with this name in this fiber data object")
+        data = self.dom_object.GetDataSet(data_set_info)
+        data_list = [[data[i, j] for j in range(data.GetLength(1))] for i in range(data.GetLength(0))]
+        return pd.DataFrame(data_list)
+
+    def get_data_table(self, start_index: int = 0, end_index: int = INT32_MAX):
+        if end_index == INT32_MAX:
+            print("We strongly recommend that you avoid loading the entire data table and instead work with chunks, "
+                  "specifying the start and end indexes. You can also use the get_data_set method, which is faster.")
+        print("Retrieving the data table... This may take a few minutes")
+        data_table = self.dom_object.GetDataTable(self.dom_object.DepthUnit, start_index, end_index)
+        data_dict = {column: [row[column] for row in data_table.Rows] for column in data_table.Columns}
+        df = pd.DataFrame(data_dict)
+        print("Data table Retrieved")
+        return df
+
+    @property
+    def dates(self) -> List[datetime]:
+        return [convert_dotnet_datetime_to_python_datetime(x.ToString()) for x in self.dom_object.Times]
+
+    @property
+    def depths(self) -> List[float]:
+        return [x.Value for x in self.dom_object.Depths]

orchid_python_api-5.25.2/orchid/native_fiber_data_set_info.py

@@ -0,0 +1,28 @@
+# noinspection PyUnresolvedReferences,PyPackageRequirements
+from Orchid.FractureDiagnostics.FiberDataSet import IFiberDataSetInfo
+import orchid.base
+from orchid import (
+    dot_net_dom_access as dna,
+    dom_project_object as dpo,
+    dot_net_disposable as dnd,
+    net_date_time as ndt,
+)
+import json
+
+
+class NativeFiberDataSetInfo(dpo.DomProjectObject):
+    """Adapts a native IFiberDataSet to python."""
+
+    def __init__(self, net_fiber_data_set_info: IFiberDataSetInfo):
+        """
+        Constructs an instance adapting a .NET IFiberDataSet.
+        Args:
+            net_fiber_data_set_info: The .NET fiber data set to be adapted.
+        """
+        super().__init__(net_fiber_data_set_info)
+
+    description = dna.dom_property('description', 'Description')
+    type = dna.dom_property('type', 'Type')
+    unit = dna.dom_property('unit', 'Unit of this data set')
+    min = dna.dom_property('min', 'Minimum value of this data set')
+    max = dna.dom_property('max', 'Maximum value of this data set')

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/native_monitor_adapter.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/native_project_user_data_adapter.py

@@ -1,4 +1,4 @@
-#  Copyright 2017-2024 KAPPA
+#  Copyright 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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/native_stage_adapter.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/native_stage_part_adapter.py

@@ -1,4 +1,4 @@
-#  Copyright 2017-2024 KAPPA
+#  Copyright 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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/native_subsurface_point.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/native_time_series_adapter.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/native_trajectory_adapter.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/native_treatment_calculations.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/native_treatment_curve_adapter.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/native_well_adapter.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/net_date_time.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/net_enumerable.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/net_fracture_diagnostics_factory.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/net_quantity.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/net_stage_qc.py

@@ -1,4 +1,4 @@
-#  Copyright 2017-2024 KAPPA
+#  Copyright 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.

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/physical_quantity.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/project.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 
@@ -25,6 +25,7 @@ import toolz.curried as toolz
 from orchid import (
     dot_net_dom_access as dna,
     native_data_frame_adapter as dfa,
+    native_fiber_data as nfd,
     native_monitor_adapter as nma,
     native_time_series_adapter as tsa,
     native_project_user_data_adapter as uda,
@@ -105,6 +106,15 @@ class Project(dna.IdentifiedDotNetAdapter):
         """
         return spo.SearchableProjectObjects(nma.NativeMonitorAdapter, self.dom_object.Monitors.Items)
 
+    def fiber_data(self) -> List[nfd.NativeFiberData]:
+        """
+        Return a `spo.SearchableProjectObjects` instance of all the fiber data for this project.
+
+        Returns:
+            An `spo.SearchableProjectObjects` for all the monitors of this project.
+        """
+        return list(spo.SearchableProjectObjects(nfd.NativeFiberData, self.dom_object.FiberDataSets.Items))
+
     def project_bounds(self) -> ProjectBounds:
         result = toolz.pipe(self.dom_object.GetProjectBounds(),
                             toolz.map(option.maybe),

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/project_store.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/reference_origins.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/script_adapter_context.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/searchable_data_frames.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/searchable_project_objects.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/searchable_stage_parts.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/searchable_stages.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/unit_system.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # This file is part of Orchid and related technologies.
 #

orchid_python_api-5.25.2/orchid/utils.py

@@ -0,0 +1,14 @@
+from datetime import datetime
+
+FORMATS = [
+    '%d/%m/%Y %H:%M:%S',       # e.g., 16/04/2019 23:45:10
+    '%m/%d/%Y %I:%M:%S %p',    # e.g., 4/16/2019 12:02:51 AM
+]
+
+def convert_dotnet_datetime_to_python_datetime(csharp_datetime_str: str) -> datetime:
+    for fmt in FORMATS:
+        try:
+            return datetime.strptime(csharp_datetime_str, fmt)
+        except ValueError:
+            continue
+    raise ValueError(f"Unrecognized datetime format: '{csharp_datetime_str}'")

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/validation.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid/version.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/__init__.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/add_stages.py

@@ -1,4 +1,4 @@
-#  Copyright 2017-2024 KAPPA
+#  Copyright 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. 

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/change_stage_times.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/completion_analysis.ipynb

@@ -14,7 +14,7 @@
    },
    "outputs": [],
    "source": [
-    "#  Copyright (c) 2017-2024 KAPPA\n",
+    "#  Copyright (c) 2017-2025 KAPPA\n",
     "#\n",
     "#  Licensed under the Apache License, Version 2.0 (the \"License\");\n",
     "#  you may not use this file except in compliance with the License.\n",

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/completion_analysis.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/low_level/add_stages_low.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/low_level/auto_pick.ipynb

@@ -9,7 +9,7 @@
     "#\n",
     "# This file is part of Orchid and related technologies.\n",
     "#\n",
-    "# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.\n",
+    "# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.\n",
     "#\n",
     "# LEGAL NOTICE:\n",
     "# Orchid contains trade secrets and otherwise confidential information\n",

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/low_level/auto_pick.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/low_level/auto_pick_and_create_stage_attribute.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/low_level/auto_pick_iterate_example.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/low_level/monitor_time_series.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/low_level/multi_picking_events.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information
@@ -171,7 +171,7 @@ def main(cli_args):
         logging.info(f'{len(observation_sets_items)=}')
         for observation_set in observation_sets_items:
             logging.info(f'{observation_set.Name=}')
-            logging.info(f'{len(dne.as_list(observation_set.LeakOffObservations.Items))=}')
+            logging.info(f'{len(dne.as_list(observation_set.SignalObservations.Items))=}')
             logging.info(f'{len(dne.as_list(observation_set.MultiPickingObservations.Items))=}')
 
     # Save project changes to specified .ifrac file

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/manual/data_frame_with_guid.ipynb

@@ -5,7 +5,7 @@
    "execution_count": null,
    "outputs": [],
    "source": [
-    "#  Copyright (c) 2017-2024 KAPPA\n",
+    "#  Copyright (c) 2017-2025 KAPPA\n",
     "#\n",
     "#  Licensed under the Apache License, Version 2.0 (the \"License\");\n",
     "#  you may not use this file except in compliance with the License.\n",

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/manual/data_frame_with_guid.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/plot_time_series.ipynb

@@ -14,7 +14,7 @@
    },
    "outputs": [],
    "source": [
-    "#  Copyright (c) 2017-2024 KAPPA\n",
+    "#  Copyright (c) 2017-2025 KAPPA\n",
     "#\n",
     "#  Licensed under the Apache License, Version 2.0 (the \"License\");\n",
     "#  you may not use this file except in compliance with the License.\n",

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/plot_time_series.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/plot_trajectories.ipynb

@@ -14,7 +14,7 @@
    },
    "outputs": [],
    "source": [
-    "#  Copyright (c) 2017-2024 KAPPA\n",
+    "#  Copyright (c) 2017-2025 KAPPA\n",
     "#\n",
     "#  Licensed under the Apache License, Version 2.0 (the \"License\");\n",
     "#  you may not use this file except in compliance with the License.\n",

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/plot_trajectories.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/plot_treatment.ipynb

@@ -14,7 +14,7 @@
    },
    "outputs": [],
    "source": [
-    "#  Copyright (c) 2017-2024 KAPPA\n",
+    "#  Copyright (c) 2017-2025 KAPPA\n",
     "#\n",
     "#  Licensed under the Apache License, Version 2.0 (the \"License\");\n",
     "#  you may not use this file except in compliance with the License.\n",

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/plot_treatment.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/pythonnet3/internal_tests.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/pythonnet3/low_level.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/search_data_frames.ipynb

@@ -14,7 +14,7 @@
    },
    "outputs": [],
    "source": [
-    "#  Copyright (c) 2017-2024 KAPPA\n",
+    "#  Copyright (c) 2017-2025 KAPPA\n",
     "#\n",
     "#  Licensed under the Apache License, Version 2.0 (the \"License\");\n",
     "#  you may not use this file except in compliance with the License.\n",

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/search_data_frames.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/stage_qc_results.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/volume_2_first_response.ipynb

@@ -10,7 +10,7 @@
    },
    "outputs": [],
    "source": [
-    "#  Copyright (c) 2017-2024 KAPPA\n",
+    "#  Copyright (c) 2017-2025 KAPPA\n",
     "#\n",
     "#  Licensed under the Apache License, Version 2.0 (the \"License\");\n",
     "#  you may not use this file except in compliance with the License.\n",

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/examples/volume_2_first_response.py

@@ -1,7 +1,7 @@
 #
 # This file is part of Orchid and related technologies.
 #
-# Copyright (c) 2017-2024 KAPPA.  All Rights Reserved.
+# Copyright (c) 2017-2025 KAPPA.  All Rights Reserved.
 #
 # LEGAL NOTICE:
 # Orchid contains trade secrets and otherwise confidential information
@@ -135,9 +135,9 @@ def calculate_volume_2_first_response():
             derive_1_time = first_derivative_threshold(p_stg, 0.2)
             derive_2_time = second_derivative_peak(p_stg)
             if derive_1_time is not None:
-                derive_1_time = dt.datetime.utcfromtimestamp(derive_1_time.tolist() * 1e-9).replace(tzinfo=orchid.UTC)
+                derive_1_time = derive_1_time.astype(dt.datetime).replace(tzinfo=dt.timezone.utc)
             if derive_2_time is not None:
-                derive_2_time = dt.datetime.utcfromtimestamp(derive_2_time.tolist() * 1e-9).replace(tzinfo=orchid.UTC)
+                derive_2_time = derive_2_time.astype(dt.datetime).replace(tzinfo=dt.timezone.utc)
             vfr_d1, _, _ = (compute_stage_treatment_aggregates(stage, derive_1_time) if derive_1_time is not None
                             else (None, None, None))
             vfr_d2, _, _ = (compute_stage_treatment_aggregates(stage, derive_2_time) if derive_2_time is not None

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/tutorials/dom_navigation_tutorial.ipynb

@@ -14,7 +14,7 @@
    },
    "outputs": [],
    "source": [
-    "#  Copyright (c) 2017-2024 KAPPA\n",
+    "#  Copyright (c) 2017-2025 KAPPA\n",
     "#\n",
     "#  Licensed under the Apache License, Version 2.0 (the \"License\");\n",
     "#  you may not use this file except in compliance with the License.\n",

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/orchid_python_api/tutorials/dom_navigation_tutorial.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2017-2024 KAPPA
+#  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.

{orchid_python_api-5.24.4 → orchid_python_api-5.25.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "orchid-python-api"
-version = "5.24.4"
+version = "5.25.2"
 description = "Defines and implements the Python API for Orchid*. (*Orchid is a mark of KAPPA.)"
 authors = [ "KAPPA. <support@kappaeng.com>",]
 maintainers = [ "KAPPA. <support@kappaeng.com>",]
@@ -55,24 +55,25 @@ exclude=["orchid/.ipynb_checkpoints/", "**/*py~"]
 
 [tool.poetry.dependencies]
 python = ">=3.10,<3.13"
-pythonnet = "3.0.3"
-numpy = "^1.23.5"
-# Allow consumers to create `datetime` instances using `dateutil`, for example, by calling `dateutil.parse()`, and
-# accept those instances when supplying a time point as a function/method argument.
-python-dateutil = "^2.8.2"
-matplotlib = "^3.6.2"
-pandas = "^2.2.2"
-pendulum = "^3.0.0"
+# Essential dependencies
+clr = "1.0.3"
+deal = "^4.24.4"
+numpy = "^1.26.4"
 option = "^2.1.0"
-deal = "^4.23.4"
-ipython = "^8.7.0"
 packaging = "^24.1"
+pandas = "^2.2.2"
+pendulum = "^3.0.0"
 pint = "^0.20.1"
-pyyaml = "^6.0"
-seaborn = "^0.12.1"
-toolz = "^0.12.0"
-typing-extensions = "^4.4.0"
-scipy = "^1.9.3"
+python-dateutil = "^2.9.0"
+pythonnet = "^3.0.3"
+pyyaml = "^6.0.1"
+toolz = "^0.12.1"
+# optional dependencies
+matplotlib = { version = "^3.7", optional = true }
+ipython = { version = "^8.0", optional = true }
+seaborn = { version = "^0.12", optional = true }
+scipy = { version = "^1.10", optional = true }
+jupyterlab-vim = { version = "*", optional = true }
 
 [tool.poetry.scripts]
 copy_orchid_examples = "copy_orchid_examples:main"
@@ -84,21 +85,22 @@ copy_orchid_manual_examples = "copy_orchid_manual_examples:main"
 Issues = "https://github.com/Reveal-Energy-Services/orchid-python-api/issues"
 
 [tool.poetry.group.dev.dependencies]
-platformdirs = "^4.2.2"
-fastjsonschema = "^2.20.0"
-pyhamcrest = "^2.0.4"
-behave = "^1.2.6"
-invoke = "^1.7.3"
-toml = "^0.10.2"
-grip = "^4.6.1"
-parsy = "^2.0"
-icecream = "^2.1.3"
-m2r2 = "^0.3.3"
-codetiming = "^1.4.0"
-sphinx = "^5.3.0"
-jupyterlab-vim = "^0.15.1"
-pytest = "^7.2.0"
-pytest-benchmark = "^4.0.0"
+# Development tools for project contributors
+# Testing frameworks
+pyhamcrest = "*"
+behave = "*"
+pytest = "*"
+pytest-benchmark = "*"
+
+# Documentation and code quality tools
+invoke = "*"
+toml = "*"
+grip = "*"
+parsy = "*"
+icecream = "*"
+m2r2 = "*"
+codetiming = "*"
+sphinx = "*"
 
 [tool.pytest.ini_options]
 addopts = [
@@ -111,3 +113,13 @@ testpaths = [
     "tests",
     "benchmark_tests",
 ]
+
+[tool.poetry.extras]
+# Optional dependencies needed to run examples and tutorials
+examples = [
+    "matplotlib",
+    "ipython",
+    "seaborn", 
+    "scipy",
+    "jupyterlab-vim"
+]

orchid_python_api-5.24.4/orchid/VERSION

@@ -1 +0,0 @@
-5.24.4