completor 1.0.0__tar.gz → 1.1.0__tar.gz

{completor-1.0.0 → completor-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: completor
-Version: 1.0.0
+Version: 1.1.0
 Summary: Advanced mulit-segmented well completion tool.
 Home-page: https://github.com/equinor/completor
 License: LGPL-3.0-only
@@ -14,10 +14,10 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Provides-Extra: ert
 Requires-Dist: docutils (==0.20.1) ; extra == "ert"
-Requires-Dist: ert (>=10.1.2,<11.0.0) ; extra == "ert"
+Requires-Dist: ert (>=11.1.0,<12.0.0) ; extra == "ert"
 Requires-Dist: matplotlib (>=3.9.2,<4.0.0)
-Requires-Dist: numpy (>=1.26.4,<2.0.0)
-Requires-Dist: pandas (>=2.2.2,<3.0.0)
+Requires-Dist: numpy (<2.0.0)
+Requires-Dist: pandas (>=2.1.4,<3.0.0)
 Requires-Dist: pyqt5-qt5 (==5.15.2) ; extra == "ert"
 Requires-Dist: pytest-env (>=1.1.4,<2.0.0)
 Requires-Dist: rstcheck-core (>=1.2.1,<2.0.0) ; extra == "ert"

{completor-1.0.0 → completor-1.1.0}/completor/completion.py

@@ -9,9 +9,9 @@ import numpy.typing as npt
 import pandas as pd
 
 from completor.constants import Content, Headers, Method
-from completor.exceptions import CompletorError
+from completor.exceptions.clean_exceptions import CompletorError
 from completor.logger import logger
-from completor.utils import log_and_raise_exception, shift_array
+from completor.utils import shift_array
 
 
 def well_trajectory(df_well_segments_header: pd.DataFrame, df_well_segments_content: pd.DataFrame) -> pd.DataFrame:
@@ -405,7 +405,7 @@ def get_completion(
 
     if idx0 == -1 or idx1 == -1:
         well_name = df_completion[Headers.WELL].iloc[0]
-        log_and_raise_exception(f"No completion is defined on well {well_name} from {start} to {end}.")
+        raise CompletorError(f"No completion is defined for well {well_name} from {start} to {end}.")
 
     indices = np.arange(idx0, idx1 + 1)
     lengths = np.minimum(end_completion[indices], end) - np.maximum(start_completion[indices], start)
@@ -468,12 +468,6 @@ def complete_the_well(
 
     # loop through the cells
     for i in range(df_tubing_segments.shape[0]):
-        indices = [np.array(completion_index(df_completion, s, e)) for s, e in zip(start, end)]
-
-        if any(idx0 == -1 or idx1 == -1 for idx0, idx1 in indices):
-            well_name = df_completion[Headers.WELL].iloc[0]
-            log_and_raise_exception(f"No completion is defined on well {well_name} from {start} to {end}.")
-
         completion_data = get_completion(start[i], end[i], df_completion, joint_length)
         number_of_devices.append(completion_data[0])
         device_type.append(completion_data[1])

{completor-1.0.0 → completor-1.1.0}/completor/create_output.py

@@ -12,7 +12,7 @@ from matplotlib.backends.backend_pdf import PdfPages  # type: ignore
 
 from completor import prepare_outputs
 from completor.constants import Headers, Keywords
-from completor.exceptions import CompletorError
+from completor.exceptions.clean_exceptions import CompletorError
 from completor.get_version import get_version
 from completor.logger import logger
 from completor.read_casefile import ReadCasefile
@@ -76,7 +76,8 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
         if df_annulus.empty:
             logger.info("No annular flow in Well : %s Lateral : %d", well.well_name, lateral.lateral_number)
 
-        start_segment, start_branch = _update_segmentbranch(lateral.df_device, df_annulus)
+        if not lateral.df_device.empty:
+            start_segment, start_branch = _update_segmentbranch(lateral.df_device, df_annulus)
 
         lateral.df_tubing = _connect_lateral(well.well_name, lateral, top, well, case)
 
@@ -234,15 +235,11 @@ def _update_segmentbranch(df_device: pd.DataFrame, df_annulus: pd.DataFrame) ->
     Returns:
         The numbers for starting segment and branch.
 
-    Raises:
-        ValueError: If there is neither device nor annulus data.
     """
-    if df_annulus.empty and df_device.empty:
-        raise ValueError("Cannot determine starting segment and branch without device and annulus data.")
     if df_annulus.empty and not df_device.empty:
         start_segment = max(df_device[Headers.START_SEGMENT_NUMBER].to_numpy()) + 1
         start_branch = max(df_device[Headers.BRANCH].to_numpy()) + 1
-    else:
+    elif not df_annulus.empty:
         start_segment = max(df_annulus[Headers.START_SEGMENT_NUMBER].to_numpy()) + 1
         start_branch = max(df_annulus[Headers.BRANCH].to_numpy()) + 1
     return start_segment, start_branch

{completor-1.0.0 → completor-1.1.0}/completor/hook_implementations/jobs.py

@@ -1,27 +1,36 @@
-from importlib.resources import files
+import sys
 from pathlib import Path
 
 from completor.logger import logger
 
-SKIP_TESTS = False
 try:
-    from ert.shared.plugins.plugin_manager import hook_implementation  # type: ignore
-    from ert.shared.plugins.plugin_response import plugin_response  # type: ignore
-
+    from ert import plugin as ert_plugin  # type: ignore
 except ModuleNotFoundError:
+
+    def ert_plugin(name: str = ""):
+        """Dummy decorator"""
+
+        def decorator(func):
+            return func
+
+        return decorator
+
     logger.warning("Cannot import ERT, did you install Completor with ert option enabled?")
-    pass
 
 
-@hook_implementation
-@plugin_response(plugin_name="completor")  # type: ignore
+def _get_jobs_from_directory(directory):
+    resources = Path(sys.modules["completor"].__file__).parent / directory
+
+    all_files = [resources / filename for filename in resources.glob("*") if (resources / filename).exists()]
+    return {path.name: str(path) for path in all_files}
+
+
+@ert_plugin(name="completor")
 def installable_jobs():
-    config_file = Path(files("completor") / "config_jobs/run_completor")
-    return {config_file.name: config_file}
+    return _get_jobs_from_directory("config_jobs")
 
 
-@hook_implementation
-@plugin_response(plugin_name="completor")  # type: ignore  # pylint: disable=no-value-for-parameter
+@ert_plugin(name="completor")
 def job_documentation(job_name):
     if job_name != "run_completor":
         return None

{completor-1.0.0 → completor-1.1.0}/completor/input_validation.py

@@ -6,7 +6,7 @@ import numpy as np
 import pandas as pd
 
 from completor.constants import Content, Headers
-from completor.exceptions import CompletorError
+from completor.exceptions.clean_exceptions import CompletorError
 
 
 def set_default_packer_section(df_comp: pd.DataFrame) -> pd.DataFrame:

{completor-1.0.0 → completor-1.1.0}/completor/main.py

@@ -7,12 +7,11 @@ import os
 import re
 import time
 
-import pandas as pd
 from tqdm import tqdm
 
 from completor import create_output, parse, read_schedule, utils
 from completor.constants import Keywords, ScheduleData
-from completor.exceptions import CompletorError
+from completor.exceptions.clean_exceptions import CompletorError
 from completor.get_version import get_version
 from completor.launch_args_parser import get_parser
 from completor.logger import handle_error_messages, logger
@@ -27,8 +26,6 @@ from completor.utils import (
 )
 from completor.wells import Well
 
-pd.set_option("future.no_silent_downcasting", True)
-
 
 def get_content_and_path(case_content: str, file_path: str | None, keyword: str) -> tuple[str | None, str | None]:
     """Get the contents of a file from a path defined by user or case file.

{completor-1.0.0 → completor-1.1.0}/completor/prepare_outputs.py

@@ -9,7 +9,7 @@ import numpy.typing as npt
 import pandas as pd
 
 from completor.constants import Content, Headers, Keywords
-from completor.exceptions import CompletorError
+from completor.exceptions.clean_exceptions import CompletorError
 from completor.logger import logger
 from completor.utils import check_width_lines
 from completor.wells import Lateral, Well

{completor-1.0.0 → completor-1.1.0}/completor/read_casefile.py

@@ -11,7 +11,8 @@ import pandas as pd
 
 from completor import input_validation, parse
 from completor.constants import Content, Headers, Keywords, Method, WellData
-from completor.exceptions import CaseReaderFormatError, CompletorError
+from completor.exceptions.clean_exceptions import CompletorError
+from completor.exceptions.exceptions import CaseReaderFormatError
 from completor.logger import logger
 from completor.utils import clean_file_lines
 

{completor-1.0.0 → completor-1.1.0}/completor/utils.py

@@ -5,14 +5,14 @@ from __future__ import annotations
 import re
 import sys
 from collections.abc import Mapping
-from typing import Any, Literal, NoReturn, overload
+from typing import Any
 
 import numpy as np
 import numpy.typing as npt
 import pandas as pd
 
 from completor.constants import Content, Headers, Keywords
-from completor.exceptions import CompletorError
+from completor.exceptions.clean_exceptions import CompletorError
 from completor.logger import logger
 
 
@@ -57,35 +57,6 @@ def sort_by_midpoint(
     return df.drop([_temp_column], axis=1)
 
 
-@overload
-def log_and_raise_exception(message: str, kind: type = ..., throw: Literal[True] = ...) -> NoReturn: ...
-
-
-@overload
-def log_and_raise_exception(message: str, kind: type = ..., throw: Literal[False] = ...) -> BaseException: ...
-
-
-def log_and_raise_exception(message: str, kind: type = ValueError, throw: bool = False) -> BaseException | None:
-    """Log and throw an exception.
-
-    Arguments:
-        message: The message to be logged, and given to the exception.
-        kind: The type of exception to be thrown.
-        throw: Flag to toggle whether this function actually raises the exception or not.
-
-    Raises:
-        Exception: In general it can be any exception.
-        ValueError: This is the default exception.
-    """
-    logger.error(message)
-    if not isinstance(kind, (Exception, BaseException)):
-        raise ValueError(f"The provided exception type ({kind}) does not inherit from Exception")
-    if throw:
-        raise kind(message)
-    else:
-        return kind(message)
-
-
 def find_quote(string: str) -> re.Match | None:
     """Find single or double quotes in a string.
 
@@ -354,7 +325,7 @@ def find_well_keyword_data(well: str, keyword: str, text: str) -> str:
     """
     matches = find_keyword_data(keyword, text)
 
-    lines = []
+    lines: list[str] = []
     for match in matches:
         if re.search(well, match) is None:
             continue
@@ -375,7 +346,7 @@ def find_well_keyword_data(well: str, keyword: str, text: str) -> str:
                     once = True
                     # Remove contiguous comments above the first line by looking backwards,
                     # adding it to the replaceable text match.
-                    comments = []
+                    comments: list[str] = []
                     for prev_line in matchlines[i - 1 :: -1]:
                         if not prev_line.strip().startswith("--") or not prev_line:
                             break

{completor-1.0.0 → completor-1.1.0}/completor/wells.py

@@ -121,8 +121,6 @@ class Lateral:
         self.df_device = pd.DataFrame()
 
         self.df_reservoir = self._select_well(well_name, well_data, lateral_number)
-        if self.df_reservoir.empty:
-            print("")
         self.df_measured_true_vertical_depth = completion.well_trajectory(
             self.df_welsegs_header, self.df_welsegs_content
         )

{completor-1.0.0 → completor-1.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "completor"
-version = "1.0.0"
+version = "1.1.0"
 description = "Advanced mulit-segmented well completion tool."
 authors = ["Equinor ASA <opensource@equinor.com>"]
 repository = "https://github.com/equinor/completor"
@@ -21,22 +21,22 @@ classifiers = [
 [tool.poetry.dependencies]
 python = ">=3.11, <3.12"
 matplotlib = "^3.9.2"
-numpy = "^1.26.4"
-pandas = "^2.2.2"
+numpy = "<2.0.0"
+pandas = "^2.1.4"
 scipy = "^1.14.1"
 tqdm = "^4.66.5"
 pytest-env = "^1.1.4"
 
 docutils = {version="0.20.1", optional=true} # Pinned due to problems with OS spesific builds
 rstcheck-core = {version="^1.2.1", optional=true}
-ert = {version="^10.1.2", optional=true}
+ert = {version="^11.1.0", optional=true}
 pyqt5-qt5 = {version="5.15.2", optional=true} # Pinned due to problems with OS spesific builds
 
 [tool.poetry.group.dev.dependencies]
 black = "^24.4.2"
 flake8 = "^7.0.0"
-pre-commit = ">3"
-pytest = "^8.2.0"
+pre-commit = "^4.0.1"
+pytest = "^8.3.3"
 pytest-xdist = "^3.6.1"
 
 [tool.poetry.extras]

completor-1.0.0/completor/exceptions/__init__.py

@@ -1,4 +0,0 @@
-from completor.exceptions.clean_exceptions import CompletorError
-from completor.exceptions.exceptions import CaseReaderFormatError
-
-__all__ = ["CompletorError", "CaseReaderFormatError"]