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

copy_orchid_examples.py

@@ -1,88 +0,0 @@
-#! /usr/bin/env python
-#
-# 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 argparse
-import glob
-import pathlib
-import shutil
-import site
-import sys
-from typing import Optional, Sequence
-
-
-def site_packages_path() -> pathlib.Path:
-    candidate_site_packages = [pn for pn in site.getsitepackages() if pn.find('site-packages') != -1]
-    assert len(candidate_site_packages) == 1
-
-    result = pathlib.Path(candidate_site_packages[0])
-    return result
-
-
-def copy_examples_to(target_dir: str, overwrite: bool) -> None:
-    """
-    Copy the Orchid Python API examples into the specified, `target_dir`.
-    Args:
-        target_dir: The target for the examples.
-        overwrite: Flag: true if script will overwrite existing files with the same name in the target_dir.
-    """
-
-    def example_candidates(filename_glob):
-        example_glob = str(site_packages_path().joinpath('orchid_python_api', 'examples', filename_glob))
-        return glob.glob(example_glob), example_glob
-
-    example_notebook_candidates, example_notebook_glob = example_candidates('*.ipynb')
-    if not example_notebook_candidates:
-        print(f'No example notebooks matching "{example_notebook_glob}"')
-        return
-
-    example_script_candidates, example_script_glob = example_candidates('*.py')
-    if not example_script_candidates:
-        print(f'No example scripts matching "{example_script_glob}"')
-        return
-
-    candidates = example_notebook_candidates + example_script_candidates
-    for src in candidates:
-        target_path = pathlib.Path(target_dir).joinpath(pathlib.Path(src).name)
-        duplicate_in_target = target_path.exists()
-        if duplicate_in_target and not overwrite:
-            print(f'Skipping "{src}". Already exists.')
-        else:
-            shutil.copy2(src, target_dir)
-            print(f'Copied "{src}" to "{target_dir}"')
-
-
-def main(cli_args: Optional[Sequence[str]] = None):
-    """
-    Entry point for copy Orchid examples utility.
-    Args:
-        cli_args: The command line arguments.
-    """
-    cli_args = cli_args if cli_args else sys.argv[1:]
-
-    parser = argparse.ArgumentParser(
-        description='Copy Orchid Python API examples from installed package to specified directory')
-    parser.add_argument('-t', '--target-dir', default='.',
-                        help='Directory into which to copy the Orchid Python API examples '
-                             '(default: current directory)')
-    parser.add_argument('-o', '--overwrite', action='store_true', default=False,
-                        help='Overwrite existing files in target directory',)
-
-    args = parser.parse_args(cli_args)
-    copy_examples_to(args.target_dir, args.overwrite)
-
-
-if __name__ == '__main__':
-    main(sys.argv[1:])

copy_orchid_low_level_examples.py

@@ -1,93 +0,0 @@
-#! /usr/bin/env python
-#
-# 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 argparse
-import glob
-import pathlib
-import shutil
-import site
-import sys
-from typing import Optional, Sequence
-
-
-def site_packages_path() -> pathlib.Path:
-    candidate_site_packages = [pn for pn in site.getsitepackages() if pn.find('site-packages') != -1]
-    assert len(candidate_site_packages) == 1
-
-    result = pathlib.Path(candidate_site_packages[0])
-    return result
-
-
-def copy_examples_to(target_dir: str, overwrite: bool) -> None:
-    """
-    Copy the Orchid Python API low-level examples into `target_dir`.
-
-    Args:
-        target_dir: The target for the examples.
-        overwrite: Flag: true if script will overwrite existing files with the same name in the target_dir.
-    """
-
-    def example_candidates(filename_glob):
-        low_level_dirname = pathlib.Path('examples').joinpath('low_level')
-        example_glob = str(site_packages_path().joinpath('orchid_python_api',
-                                                         low_level_dirname,
-                                                         filename_glob))
-        return glob.glob(example_glob), example_glob
-
-    example_notebook_candidates, example_notebook_glob = example_candidates('*.ipynb')
-    if not example_notebook_candidates:
-        print(f'No example notebooks matching "{example_notebook_glob}"')
-        return
-
-    example_script_candidates, example_script_glob = example_candidates('*.py')
-    if not example_script_candidates:
-        print(f'No example scripts matching "{example_script_glob}"')
-        return
-
-    candidates = example_notebook_candidates + example_script_candidates
-    for src in candidates:
-        target_path = pathlib.Path(target_dir).joinpath(pathlib.Path(src).name)
-        duplicate_in_target = target_path.exists()
-        if duplicate_in_target and not overwrite:
-            print(f'Skipping "{src}". Already exists.')
-        else:
-            shutil.copy2(src, target_dir)
-            print(f'Copied "{src}" to "{target_dir}"')
-
-
-def main(cli_args: Optional[Sequence[str]] = None):
-    """
-    Entry point for copy Orchid examples utility.
-
-    Args:
-        cli_args: The command line arguments.
-    """
-    cli_args = cli_args if cli_args else sys.argv[1:]
-
-    parser = argparse.ArgumentParser(
-        description='Copy Orchid Python API low-level examples from installed package to specified directory')
-    parser.add_argument('-t', '--target-dir', default='.',
-                        help='Directory into which to copy the Orchid Python API low-level examples '
-                             '(default: current directory)')
-    parser.add_argument('-o', '--overwrite', action='store_true', default=False,
-                        help='Overwrite existing files in target directory',)
-
-    args = parser.parse_args(cli_args)
-    copy_examples_to(args.target_dir, args.overwrite)
-
-
-if __name__ == '__main__':
-    main(sys.argv[1:])

copy_orchid_manual_examples.py

@@ -1,93 +0,0 @@
-#! /usr/bin/env python
-#
-# 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 argparse
-import glob
-import pathlib
-import shutil
-import site
-import sys
-from typing import Optional, Sequence
-
-
-def site_packages_path() -> pathlib.Path:
-    candidate_site_packages = [pn for pn in site.getsitepackages() if pn.find('site-packages') != -1]
-    assert len(candidate_site_packages) == 1
-
-    result = pathlib.Path(candidate_site_packages[0])
-    return result
-
-
-def copy_examples_to(target_dir: str, overwrite: bool) -> None:
-    """
-    Copy the Orchid Python API manual examples into `target_dir`.
-
-    Args:
-        target_dir: The target for the examples.
-        overwrite: Flag: true if script will overwrite existing files with the same name in the target_dir.
-    """
-
-    def example_candidates(filename_glob):
-        manual_dirname = pathlib.Path('examples').joinpath('manual')
-        example_glob = str(site_packages_path().joinpath('orchid_python_api',
-                                                         manual_dirname,
-                                                         filename_glob))
-        return glob.glob(example_glob), example_glob
-
-    example_notebook_candidates, example_notebook_glob = example_candidates('*.ipynb')
-    if not example_notebook_candidates:
-        print(f'No example notebooks matching "{example_notebook_glob}"')
-        return
-
-    example_script_candidates, example_script_glob = example_candidates('*.py')
-    if not example_script_candidates:
-        print(f'No example scripts matching "{example_script_glob}"')
-        return
-
-    candidates = example_notebook_candidates + example_script_candidates
-    for src in candidates:
-        target_path = pathlib.Path(target_dir).joinpath(pathlib.Path(src).name)
-        duplicate_in_target = target_path.exists()
-        if duplicate_in_target and not overwrite:
-            print(f'Skipping "{src}". Already exists.')
-        else:
-            shutil.copy2(src, target_dir)
-            print(f'Copied "{src}" to "{target_dir}"')
-
-
-def main(cli_args: Optional[Sequence[str]] = None):
-    """
-    Entry point for copy Orchid examples utility.
-
-    Args:
-        cli_args: The command line arguments.
-    """
-    cli_args = cli_args if cli_args else sys.argv[1:]
-
-    parser = argparse.ArgumentParser(
-        description='Copy Orchid Python API manual examples from installed package to specified directory')
-    parser.add_argument('-t', '--target-dir', default='.',
-                        help='Directory into which to copy the Orchid Python API manual examples '
-                             '(default: current directory)')
-    parser.add_argument('-o', '--overwrite', action='store_true', default=False,
-                        help='Overwrite existing files in target directory',)
-
-    args = parser.parse_args(cli_args)
-    copy_examples_to(args.target_dir, args.overwrite)
-
-
-if __name__ == '__main__':
-    main(sys.argv[1:])

copy_orchid_tutorials.py

@@ -1,88 +0,0 @@
-#! /usr/bin/env python
-#
-# 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 argparse
-import glob
-import pathlib
-import shutil
-import site
-import sys
-from typing import Optional, Sequence
-
-
-def site_packages_path() -> pathlib.Path:
-    candidate_site_packages = [pn for pn in site.getsitepackages() if pn.find('site-packages') != -1]
-    assert len(candidate_site_packages) == 1
-
-    result = pathlib.Path(candidate_site_packages[0])
-    return result
-
-
-def copy_tutorials_to(target_dir: str, overwrite: bool) -> None:
-    """
-    Copy the Orchid Python API tutorials into the specified, `target_dir`.
-    Args:
-        target_dir: The target for the examples.
-        overwrite: Flag: true if script will overwrite existing files with the same name in the target_dir.
-    """
-
-    def tutorial_candidates(filename_glob):
-        tutorial_glob = str(site_packages_path().joinpath('orchid_python_api', 'tutorials', filename_glob))
-        return glob.glob(tutorial_glob), tutorial_glob
-
-    tutorial_notebook_candidates, tutorial_notebook_glob = tutorial_candidates('*.ipynb')
-    if not tutorial_notebook_candidates:
-        print(f'No tutorial notebooks matching "{tutorial_notebook_glob}"')
-        return
-
-    tutorial_script_candidates, tutorial_script_glob = tutorial_candidates('*.py')
-    if not tutorial_script_candidates:
-        print(f'No tutorial scripts matching "{tutorial_script_glob}"')
-        return
-
-    candidates = tutorial_notebook_candidates + tutorial_script_candidates
-    for src in candidates:
-        target_path = pathlib.Path(target_dir).joinpath(pathlib.Path(src).name)
-        duplicate_in_target = target_path.exists()
-        if duplicate_in_target and not overwrite:
-            print(f'Skipping "{src}". Already exists.')
-        else:
-            shutil.copy2(src, target_dir)
-            print(f'Copied "{src}" to "{target_dir}"')
-
-
-def main(cli_args: Optional[Sequence[str]] = None):
-    """
-    Entry point for copy Orchid tutorials utility.
-    Args:
-        cli_args: The command line arguments.
-    """
-    cli_args = cli_args if cli_args else sys.argv[1:]
-
-    parser = argparse.ArgumentParser(
-        description='Copy Orchid Python API tutorial from installed package to specified directory')
-    parser.add_argument('-t', '--target-dir', default='.',
-                        help='Directory into which to copy the Orchid Python API tutorials '
-                             '(default: current directory)')
-    parser.add_argument('-o', '--overwrite', action='store_true', default=False,
-                        help='Overwrite existing files in target directory',)
-
-    args = parser.parse_args(cli_args)
-    copy_tutorials_to(args.target_dir, args.overwrite)
-
-
-if __name__ == '__main__':
-    main(sys.argv[1:])

orchid/VERSION

@@ -1 +0,0 @@
-5.25.3

orchid/__init__.py

@@ -1,42 +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.
-#
-
-
-# Load the appropriate runtime **before** executing `import clr`
-import pythonnet
-pythonnet.load('coreclr')
-
-from .dot_net import prepare_imports
-prepare_imports()
-
-# High-level API
-from .core import load_project, save_project, optimized_but_possibly_unsafe_save
-
-# Helpful constants
-from .native_treatment_curve_adapter import TreatmentCurveTypes
-from .native_time_series_adapter import TimeSeriesCurveTypes
-from .net_date_time import UTC
-
-# Helpful functions
-from .convert import to_unit
-from .measurement import registry as unit_registry
-from .native_treatment_calculations import (median_treating_pressure, pumped_fluid_volume, total_proppant_mass)
-from .reference_origins import WellReferenceFrameXy
-from .unit_system import abbreviation, make_measurement
-
-# Only for training data
-from .configuration import training_data_path

orchid/__version__.py

@@ -1,18 +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.
-#
-
-__version__ = '2020.4.0'

orchid/base.py

@@ -1,31 +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.
-#
-from toolz import curried as toolz
-
-
-def constantly(x):
-    """
-    Creates a function that always returns the value, `x`, independent of **all** arguments passed to it..
-    Args:
-        x: The value to return
-
-    Returns:
-        Returns a function takes any arguments yet always returns `x`.
-    """
-
-    # noinspection PyUnusedLocal
-    def make_constantly(*args, **kwargs):
-        return toolz.identity(x)
-
-    return make_constantly

orchid/base_time_series_adapter.py

@@ -1,91 +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.
-#
-
-
-from abc import ABCMeta, abstractmethod
-from typing import Callable, Union
-
-import numpy as np
-import pandas as pd
-
-from orchid import (
-    dom_project_object as dpo,
-    dot_net_dom_access as dna,
-    project_store as loader,
-    unit_system as units,
-)
-
-# noinspection PyUnresolvedReferences
-from Orchid.FractureDiagnostics.SDKFacade import ScriptAdapter
-# noinspection PyUnresolvedReferences
-from Orchid.FractureDiagnostics.TimeSeries import IQuantityTimeSeries
-
-
-class BaseTimeSeriesAdapter(dpo.DomProjectObject, metaclass=ABCMeta):
-    def __init__(self, adaptee: IQuantityTimeSeries, net_project_callable: Callable):
-        """
-        Construct an instance that adapts a .NET `IStageSampledQuantityTimeSeries` instance.
-
-        Args:
-            adaptee: The .NET stage time series to be adapted.
-        """
-        super().__init__(adaptee, net_project_callable)
-
-    sampled_quantity_name = dna.dom_property('sampled_quantity_name',
-                                             'Return the sampled quantity name for this curve.')
-
-    @abstractmethod
-    def quantity_name_unit_map(self, project_units):
-        """
-        Return a map (dictionary) between quantity names and units (from `unit_system`) of the data_points.
-
-        This method plays the role of "Primitive Operation" in the *Template Method* design pattern. In this
-        role, the "Template Method" defines an algorithm and delegates some steps of the algorithm to derived
-        classes through invocation of "Primitive Operations".
-
-        Args:
-            project_units: The unit system of the project.
-        """
-        pass
-
-    def sampled_quantity_unit(self) -> Union[units.UsOilfield, units.Metric]:
-        """
-        Return the measurement unit of the data_points in this curve.
-
-        This method plays the role of "Template Method" in the *Template Method* design pattern. In this role
-        it specifies an algorithm to calculate the units of the sampled quantity of the curve delegating some
-        algorithm steps to derived classes by invoking the "Primitive Operation-", `quantity_name_unit_map()`
-        and `get_net_project_units()`.
-
-        Returns:
-            A `UnitSystem` member containing the unit for the sample in this curve.
-        """
-        quantity_name_unit_map = self.quantity_name_unit_map(self.expect_project_units)
-        return quantity_name_unit_map[self.sampled_quantity_name]
-
-    def data_points(self) -> pd.Series:
-        """
-        Return the time series for this curve.
-
-        Returns
-            The `pandas` time `Series` for this curve.
-        """
-        python_time_series_arrays = loader.as_python_time_series_arrays(self.dom_object)
-
-        result = pd.Series(data=np.fromiter(python_time_series_arrays.SampleMagnitudes, dtype='float'),
-                           index=pd.DatetimeIndex(np.fromiter(python_time_series_arrays.UnixTimeStampsInSeconds,
-                                                              dtype='datetime64[s]'), tz='UTC'),
-                           name=self.name)
-
-        return result