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

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

@@ -1,15 +1,15 @@
 Metadata-Version: 2.1
 Name: orchid-python-api
-Version: 5.24.1
+Version: 5.24.4
 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
 Keywords: Orchid Integration,Fracture Diagnostics
 Author: KAPPA.
-Author-email: support@reveal-energy.com
+Author-email: support@kappaeng.com
 Maintainer: KAPPA.
-Maintainer-email: support@reveal-energy.com
-Requires-Python: >=3.10,<3.11
+Maintainer-email: support@kappaeng.com
+Requires-Python: >=3.10,<3.13
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Other Audience
 Classifier: Intended Audience :: Science/Research
@@ -18,20 +18,20 @@ Classifier: Operating System :: Microsoft :: Windows :: Windows 10
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 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: jupyter (>=1.0.0,<2.0.0)
-Requires-Dist: jupyterlab (>=3.5.1,<4.0.0)
 Requires-Dist: matplotlib (>=3.6.2,<4.0.0)
 Requires-Dist: numpy (>=1.23.5,<2.0.0)
 Requires-Dist: option (>=2.1.0,<3.0.0)
-Requires-Dist: packaging (>=22.0,<23.0)
-Requires-Dist: pandas (>=1.5.2,<2.0.0)
-Requires-Dist: pendulum (>=2.1.2,<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)

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

@@ -13,6 +13,52 @@ 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.24.4
+
+This release is the production release of the Orchid Python API corresponding to Orchid 5.24.3. We have made the necessary
+updates to the Python API to remain compatible with the .NET API.
+
+We have also updated dependencies on the Python side. Note that we skipped the 5.24.2 release as it was a smaller, quicker release.
+
+#### Possible breaking .NET API changes
+
+- None
+
+#### Resolved Issues
+
+- None
+
+#### Features
+
+- None
+
+#### Known Issues
+
+- None
+
+### Release notes for 5.24.3
+
+This release is the production release of the Orchid Python API corresponding to Orchid 5.24.3. We have made the necessary
+updates to the Python API to remain compatible with the .NET API.
+
+We have also updated dependencies on the Python side. Note that we skipped the 5.24.2 release as it was a smaller, quicker release.
+
+#### Possible breaking .NET API changes
+
+- None
+
+#### Resolved Issues
+
+- None
+
+#### Features
+
+- None
+
+#### Known Issues
+
+- None
+
 ### Release notes for 5.24.1
 
 This release is the production release of the Orchid Python API corresponding to Orchid 5.24.1. We have made the necessary

orchid_python_api-5.24.4/orchid/VERSION

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

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

@@ -19,13 +19,12 @@ import glob
 import logging
 import os
 import pathlib
-from typing import Dict
+from typing import Dict, Any
 import warnings
-
 import toolz.curried as toolz
 import yaml
 
-import orchid.version
+from orchid.version import get_orchid_sdk_version
 
 
 _logger = logging.getLogger(__name__)
@@ -40,28 +39,20 @@ ORCHID_ROOT_ENV_VAR = 'ORCHID_ROOT'
 ORCHID_TRAINING_DATA_ENV_VAR = 'ORCHID_TRAINING_DATA'
 
 
-def get_environment_configuration() -> Dict:
+def get_environment_configuration() -> Dict[str, Dict[str, str]]:
     """
     Gets the API configuration from the system environment.
 
     Returns:
         The configuration, if any, calculated from the system environment.
     """
-    environment_configuration = {}
-    if ORCHID_ROOT_ENV_VAR in os.environ and ORCHID_TRAINING_DATA_ENV_VAR in os.environ:
-        environment_configuration = {'orchid': {'root': os.environ[ORCHID_ROOT_ENV_VAR],
-                                                'training_data': os.environ[ORCHID_TRAINING_DATA_ENV_VAR]}}
-    elif ORCHID_ROOT_ENV_VAR in os.environ:
-        environment_configuration = {'orchid': {'root': os.environ[ORCHID_ROOT_ENV_VAR]}}
-    elif ORCHID_TRAINING_DATA_ENV_VAR in os.environ:
-        environment_configuration = {'orchid': {'training_data': os.environ[ORCHID_TRAINING_DATA_ENV_VAR]}}
-
+    environment_configuration = {'orchid': {key: os.environ[env_var] for key, env_var in
+                                            [('root', ORCHID_ROOT_ENV_VAR), ('training_data', ORCHID_TRAINING_DATA_ENV_VAR)] if env_var in os.environ}}
     _logger.debug(f'environment configuration = {environment_configuration}')
-
     return environment_configuration
 
 
-def get_fallback_configuration() -> Dict:
+def get_fallback_configuration() -> Dict[str, Dict[str, str]]:
     """
     Returns final fallback API configuration.
 
@@ -80,24 +71,25 @@ def get_fallback_configuration() -> Dict:
     # `$ProgramFiles/Reveal Energy Services, Inc/Orchid/<version-specific-directory>`. The following code
     # calculates an actual location by substituting the current version number for the symbol,
     # `<version-specific-directory>`.
-    standard_orchid_dir = pathlib.Path(os.environ['ProgramFiles']).joinpath('Reveal Energy Services',
-                                                                            'Orchid')
-    version_id = orchid.version.api_version()
-    version_dirname = f'Orchid-{version_id.major}.{version_id.minor}.{version_id.micro}'
-    glob_path = standard_orchid_dir.joinpath(f'{version_dirname}*', 'PythonApiLibs')
-    candidate_directories = glob.glob(str(glob_path))
-    if len(candidate_directories) == 1:
-        fallback = {'orchid': {'root': str(candidate_directories[0])}}
-    elif len(candidate_directories) == 0:
-        fallback = {}
-    else:
-        fallback = {}
-        warnings.warn(f'Fallback configuration found multiple matches for {str(glob_path)}')
-    _logger.debug(f'fallback configuration={fallback}')
+    program_files_path = os.environ.get("ProgramFiles")
+    fallback = {}
+    if program_files_path is not None:
+        orchid_version = get_orchid_sdk_version() + '.*'
+        python_api_lib_pattern_path = os.path.join(program_files_path, 'Reveal Energy Services', 'Orchid', orchid_version, 'Orchid-'+orchid_version, 'PythonApiLibs')
+        matching_paths = glob.glob(python_api_lib_pattern_path)
+        if len(matching_paths) == 1:
+            python_api_lib_path = matching_paths[0]
+            _logger.info(f"PythonApiLibs path found : {python_api_lib_path}")
+            fallback = {'orchid': {'root': str(matching_paths[0])}}
+        elif len(matching_paths) == 0:
+            _logger.info(f"PythonApiLibs path not found for {str(python_api_lib_pattern_path)}")
+        else:
+            warnings.warn(f'Fallback configuration found multiple matches for {str(python_api_lib_pattern_path)}')
+        _logger.debug(f'fallback configuration={fallback}')
     return fallback
 
 
-def get_file_configuration() -> Dict:
+def get_file_configuration() -> Dict[str, Any]:
     """
     Returns the API configuration read from the file system.
 
@@ -117,7 +109,7 @@ def get_file_configuration() -> Dict:
     return file
 
 
-def python_api() -> Dict[str, str]:
+def get_configuration() -> Dict[str, Dict[str, Any]]:
     """
     Calculate the configuration for the Python API.
 
@@ -128,12 +120,15 @@ def python_api() -> Dict[str, str]:
     file_configuration = get_file_configuration()
     env_configuration = get_environment_configuration()
 
-    result = merge_configurations(fallback_configuration, file_configuration, env_configuration)
-    _logger.debug(f'result configuration={result}')
-    return result
+    configuration_dict = merge_configurations(fallback_configuration, file_configuration, env_configuration)
+    if not configuration_dict.get('orchid') or (configuration_dict.get('orchid') and not configuration_dict['orchid'].get('root')):
+        raise ConfigurationError("You must create an environment variable ORCHID_ROOT or a config file to set up the path to the PythonApiLibs folder since it's not in the default location")
+
+    _logger.debug(f'result configuration={configuration_dict}')
+    return configuration_dict
 
 
-def merge_configurations(fallback_configuration, file_configuration, env_configuration):
+def merge_configurations(fallback_configuration: Dict[str, Dict[str, str]], file_configuration: Dict[str, Dict[str, Any]], env_configuration: Dict[str, Dict[str, str]]) -> Dict[str, Dict[str, Any]]:
     # The rules for merging these configurations is not the same as a simple dictionary. The rules are:
     # - If two different configurations share a top-level key, merge the second level dictionaries.
     # - Then merge the distinct top-level keys.
@@ -163,5 +158,5 @@ def training_data_path() -> pathlib.Path:
         This function raises KeyError if the training directory path is not available from the package
         configuration.
     """
-    result = pathlib.Path(toolz.get_in(['orchid', 'training_data'], python_api()))
+    result = pathlib.Path(toolz.get_in(['orchid', 'training_data'], get_configuration()))
     return result

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

@@ -54,8 +54,7 @@ def app_settings_path() -> str:
 
     :return: The required pathname.
     """
-    result = os.fspath(pathlib.Path(toolz.get_in(['orchid', 'root'],
-                                                 orchid.configuration.python_api())).joinpath('appSettings.json'))
+    result = os.fspath(pathlib.Path(toolz.get_in(['orchid', 'root'], orchid.configuration.get_configuration())).joinpath('appSettings.json'))
     return result
 
 

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

@@ -13,6 +13,7 @@
 #
 
 import dataclasses
+import traceback
 import uuid
 from typing import Iterable
 
@@ -227,9 +228,13 @@ def _table_row_to_dict(reader):
         except ValueError as ve:
             if 'DateTimeOffset.MinValue' in str(ve):
                 raise DataFrameAdapterDateTimeOffsetMinValueError(column_no, column_name)
+            else:
+                raise Exception(f"Cannot read value from dot net data table column {column_no} named {column_name}, value {value}, {traceback.format_exc()}")
         except TypeError as te:
             if 'System.DateTime' in str(te):
                 raise DataFrameAdapterDateTimeError(value.GetType())
+            else:
+                raise Exception(f"Cannot read value from dot net data table column {column_no} named {column_name}, value {value}, {traceback.format_exc()}")
 
     result = toolz.pipe(
         reader.FieldCount,

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

@@ -61,7 +61,7 @@ class NativeMonitorAdapter(dpo.DomProjectObject):
 
         Returns:
             The time range during which this monitor is active. The type of the returned value is
-            `pendulum.Period`. See the [documentation](https://pendulum.eustace.io/docs/) to understand the
-            methods available from a `pendulum.Period` instance.
+            `pendulum.Interval`. See the [documentation](https://pendulum.eustace.io/docs/) to understand the
+            methods available from a `pendulum.Interval` instance.
         """
-        return pendulum.Period(self.start_time, self.stop_time)
+        return pendulum.Interval(self.start_time, self.stop_time)

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

@@ -141,10 +141,10 @@ class NativeStageAdapter(dpo.DomProjectObject):
     stop_time = dna.transformed_dom_property('stop_time', 'The stop time of the stage treatment',
                                              ndt.as_date_time)
 
-    def _get_time_range(self) -> pdt.Period:
-        return pdt.period(self.start_time, self.stop_time)
+    def _get_time_range(self) -> pdt.Interval:
+        return pdt.Interval(self.start_time, self.stop_time)
 
-    def _set_time_range(self, to_time_range: pdt.Period):
+    def _set_time_range(self, to_time_range: pdt.Interval):
         to_start_net_time = ndt.as_net_date_time(to_time_range.start)
         to_stop_net_time = ndt.as_net_date_time(to_time_range.end)
         if len(self.stage_parts()) == 1:
@@ -486,7 +486,7 @@ class CreateStageDto:
     # issue with Orchid.
     #
     # Note supplying no value (an implicit `None`) results in the largest possible .NET time range.
-    maybe_time_range: Optional[pdt.Period] = None
+    maybe_time_range: Optional[pdt.Interval] = None
     # WARNING: one must currently supply an ISIP for each stage; otherwise, Orchid fails to correctly load
     # the project saved with the added stages.
     maybe_isip: Optional[om.Quantity] = None  # If not `None`, must be a pressure

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

@@ -24,7 +24,6 @@ from typing import Tuple, Union
 
 import dateutil.tz as duz
 import pendulum as pdt
-import pendulum.tz as ptz
 
 from orchid import base
 
@@ -170,7 +169,7 @@ def _(net_time_point: DateTime) -> pdt.DateTime:
         return NAT
 
     if net_time_point.Kind == DateTimeKind.Utc:
-        return _net_time_point_to_datetime(base.constantly(ptz.UTC), net_time_point)
+        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)
@@ -201,9 +200,9 @@ def _(net_time_point: DateTimeOffset) -> pdt.DateTime:
     def net_date_time_offset_to_timezone(ntp):
         integral_offset = int(ntp.Offset.TotalSeconds)
         if integral_offset == 0:
-            return ptz.UTC
+            return pdt.UTC
 
-        return ptz.timezone(integral_offset)
+        return pdt.timezone(integral_offset)
 
     return _net_time_point_to_datetime(net_date_time_offset_to_timezone, net_time_point)
 
@@ -227,7 +226,7 @@ def as_net_date_time(time_point: pdt.DateTime) -> DateTime:
     if time_point == NAT:
         return DateTime.MinValue
 
-    if not time_point.tzinfo == ptz.UTC:
+    if not time_point.tzinfo == pdt.UTC:
         raise NetDateTimeNoTzInfoError(time_point)
 
     carry_seconds, milliseconds = microseconds_to_milliseconds_with_carry(time_point.microsecond)

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

@@ -28,7 +28,7 @@ import uuid
 import toolz.curried as toolz
 
 # noinspection PyUnresolvedReferences,PyPackageRequirements
-from Orchid.Common import CorrectionStatus as NetCorrectionStatus
+from Orchid.FractureDiagnostics import CorrectionStatus as NetCorrectionStatus
 
 
 class CorrectionStatus(enum.Enum):

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

@@ -32,7 +32,7 @@ def append_orchid_assemblies_directory_path() -> None:
     """
     Append the directory containing the required Orchid assemblies to `sys.path`.
     """
-    orchid_bin_dir = toolz.get_in(['orchid', 'root'], orchid.configuration.python_api())
+    orchid_bin_dir = toolz.get_in(['orchid', 'root'], orchid.configuration.get_configuration())
     if orchid_bin_dir not in sys.path:
         sys.path.append(orchid_bin_dir)
 

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

@@ -14,20 +14,24 @@
 #
 # This file is part of Orchid and related technologies.
 #
-
+import re
 import pathlib
 
-import packaging.version as pv
-
 
-def api_version():
+def get_orchid_sdk_version():
     """
     Calculate the Python API version.
 
     Returns:
         The Python API version read from the `VERSION` file.
     """
-    with pathlib.Path(__file__).parent.joinpath('VERSION').open() as version_file:
-        text_version = version_file.read()
-        result = pv.parse(text_version)
-        return result
+    try:
+        with pathlib.Path(__file__).parent.joinpath('VERSION').open() as version_file:
+            text_version = version_file.read()
+            version_match = re.search(r'\d+\.\d+\.\d+(?:\.\d+)?', text_version)
+            if version_match:
+                return version_match.group()
+            else:
+                raise ValueError("Cannot find a correct version number in VERSION file.")
+    except FileNotFoundError:
+        raise FileNotFoundError("Missing VERSION file")

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

@@ -41,11 +41,11 @@ def change_stage_time_range(project):
     # Start time before change
     ante_start_time = stage.start_time
     ante_stop_time = stage.stop_time
-    logging.info(f'Stage time_range before {pendulum.Period(ante_start_time, ante_stop_time)}')
+    logging.info(f'Stage time_range before {pendulum.Interval(ante_start_time, ante_stop_time)}')
 
     post_start_time = ante_start_time.subtract(minutes=10)
     post_stop_time = ante_stop_time.add(minutes=10)
-    stage.time_range = pendulum.Period(post_start_time, post_stop_time)
+    stage.time_range = pendulum.Interval(post_start_time, post_stop_time)
     logging.info(f'Stage time_range after {stage.time_range}')
 
 

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

@@ -74,7 +74,7 @@ class CreateStageDto:
     # issue with Orchid.
     #
     # Note supplying no value (an implicit `None`) results in the largest possible .NET time range.
-    maybe_time_range: Optional[pendulum.Period] = None
+    maybe_time_range: Optional[pendulum.Interval] = None
 
     # WARNING: one must currently supply an ISIP for each stage; otherwise, Orchid fails to correctly load
     # the project saved with the added stages.

orchid_python_api-5.24.4/orchid_python_api/requirements.txt

@@ -0,0 +1,8 @@
+clr==1.0.3
+matplotlib==3.9.1
+numpy==2.0.1
+pandas==2.2.2
+pendulum==3.0.0
+pythonnet==3.0.3
+scipy==1.14.0
+seaborn==0.13.2

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

@@ -4,17 +4,16 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "orchid-python-api"
-version = "5.24.1"
+version = "5.24.4"
 description = "Defines and implements the Python API for Orchid*. (*Orchid is a mark of KAPPA.)"
-authors = [ "KAPPA. <support@reveal-energy.com>",]
-maintainers = [ "KAPPA. <support@reveal-energy.com>",]
+authors = [ "KAPPA. <support@kappaeng.com>",]
+maintainers = [ "KAPPA. <support@kappaeng.com>",]
 license = "Apache-2.0"
 readme = "README.md"
 homepage="https://github.com/Reveal-Energy-Services/orchid-python-api"
 repository="https://github.com/Reveal-Energy-Services/orchid-python-api"
 documentation="https://github.com/Reveal-Energy-Services/orchid-python-api/wiki"
-keywords=["Orchid Integration",
-          "Fracture Diagnostics"]
+keywords=["Orchid Integration", "Fracture Diagnostics"]
 classifiers=[
     # Trove classifiers
     # Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
@@ -55,21 +54,19 @@ include=[
 exclude=["orchid/.ipynb_checkpoints/", "**/*py~"]
 
 [tool.poetry.dependencies]
-python = ">=3.10,<3.11"
+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"
-jupyter = "^1.0.0"
 matplotlib = "^3.6.2"
-pandas = "^1.5.2"
-pendulum = "^2.1.2"
+pandas = "^2.2.2"
+pendulum = "^3.0.0"
 option = "^2.1.0"
 deal = "^4.23.4"
 ipython = "^8.7.0"
-jupyterlab = "^3.5.1"
-packaging = "^22.0"
+packaging = "^24.1"
 pint = "^0.20.1"
 pyyaml = "^6.0"
 seaborn = "^0.12.1"
@@ -87,6 +84,8 @@ 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"

orchid_python_api-5.24.1/orchid/VERSION

@@ -1 +0,0 @@
-5.24.1