completor 1.3.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

completor/utils.py

@@ -5,13 +5,14 @@ from __future__ import annotations
 import re
 import sys
 from collections.abc import Mapping
+from pathlib import Path
 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.constants import Content, Headers, ICVMethod, Keywords
 from completor.exceptions.clean_exceptions import CompletorError
 from completor.logger import logger
 
@@ -234,7 +235,7 @@ def check_width_lines(result: str, limit: int) -> list[tuple[int, str]]:
         cleaned_line = cleaned_line.rsplit("--")[0]
 
         if len(cleaned_line) > limit:
-            too_long_lines.append((line_index, lines[line_index]))
+            too_long_lines.append((int(line_index), lines[line_index]))
     return too_long_lines
 
 
@@ -386,3 +387,133 @@ def replace_preprocessing_names(text: str, mapper: Mapping[str, str] | None) ->
                 my_value = start + str(value) + end
                 text = text.replace(my_key, my_value)
     return text
+
+
+def sort_string_with_assign_first(input_string: str) -> str:
+    """Sort string such that lines starting with "ASSIGN" come before other lines preserving remaining lines.
+
+    Args:
+        input_string: The input string to be sorted.
+
+    Returns:
+        String starting with "ASSIGN" appearing before other lines.
+    """
+
+    assign_lines = []
+    other_lines = []
+    for line in input_string.splitlines():
+        if line.lstrip().startswith("ASSIGN"):
+            assign_lines.append(line)
+        elif line.strip() != "":
+            other_lines.append(line)
+
+    sorted_lines = assign_lines + other_lines
+    return "\n".join(sorted_lines) + "\n"
+
+
+def reduce_newlines(data: str) -> str:
+    """Reduces consecutive occurrences of three or more newline characters to just two newline characters.
+
+    Args:
+        data: String to process.
+
+    Returns:
+        The processed string with reduced newline characters.
+    """
+
+    return re.sub(r"\n{3}", r"\n\n", data)
+
+
+def remove_duplicates(data: list[str]) -> list[str]:
+    """Remove duplicates from a list while preserving the original order.
+
+    Exclude empty strings from the resulting list.
+
+    Args:
+        data: The input list.
+
+    Returns:
+        The data with duplicates removed inline.
+    """
+
+    return [x for x in dict.fromkeys(data) if x]
+
+
+def insert_comment_custom_content() -> str:
+    """Writes a comment to schedule when loglevel is <= 10.
+
+    Returns:
+        A string to be inserted before the output in format:
+        "METHOD_NAME with step 'STEP' and criteria 'CRITERIA'."
+    """
+
+    if logger.level > 10:
+        return ""
+    return "\n  -- This is custom content from CONTROL_CRITERIA keyword:\n"
+
+
+def insert_comment(method: str | ICVMethod, step: str | int | None = None, criteria: str | int | None = None) -> str:
+    """Writes a comment to schedule when loglevel is <= 10.
+
+    Args:
+        method: The method that is producing the current output.
+        step: The current step (if applicable).
+        criteria: The current criteria (if applicable).
+
+    Returns:
+        A string to be inserted before the output in format:
+        "METHOD_NAME with step 'STEP' and criteria 'CRITERIA'."
+    """
+
+    if logger.level > 10:
+        return ""
+    msg = f"-- {ICVMethod(method).name}"
+    if step is not None:
+        msg += f" with step '{step}'"
+    if criteria is not None:
+        if step is None:
+            msg += " with"
+        else:
+            msg += " and"
+        msg += f" criteria '{criteria}'"
+    return msg + ".\n"
+
+
+def icvc_keyword_in_file(path: Path | str) -> bool:
+    """If file contains ICV keyword.
+
+    Args:
+        path: Path to file to check.
+
+    Returns:
+        True if file contains ICV keyword.
+    """
+
+    path = Path(path)
+    with open(path, encoding="utf-8") as file:
+        case_file_content = file.read()
+
+    if Keywords.ICVC_KEYWORD in case_file_content:
+        return True
+    else:
+        return False
+
+
+def completion_keyword_in_file(path: Path | str) -> bool:
+    """If file contains COMPLETION keyword.
+
+    Args:
+        path: Path to file to check.
+
+    Returns:
+        True if file contains COMPLETION keyword.
+    """
+
+    path = Path(path)
+    with open(path, encoding="utf-8") as file:
+        case_file_content = file.read()
+
+    if Keywords.COMPLETION in case_file_content:
+        return True
+    else:
+        return False

{completor-1.3.0.dist-info → completor-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: completor
-Version: 1.3.0
+Version: 1.5.0
 Summary: Advanced multi-segmented well completion tool.
 Home-page: https://github.com/equinor/completor
 License: LGPL-3.0-only
@@ -16,14 +16,14 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: ert
 Provides-Extra: test
-Requires-Dist: ert (>=14,<15) ; extra == "ert"
+Requires-Dist: ert (>14) ; extra == "ert"
 Requires-Dist: matplotlib (>=3.9,<4.0)
 Requires-Dist: numpy (>=2.0,<3.0)
 Requires-Dist: pandas (>=2.2,<3.0)
 Requires-Dist: pytest (>=8.3,<9.0) ; extra == "test"
 Requires-Dist: pytest-env (>=1,<2) ; extra == "test"
 Requires-Dist: pytest-xdist (>=3.6,<4.0) ; extra == "test"
-Requires-Dist: rstcheck-core (>=1.2,<2.0) ; extra == "test"
+Requires-Dist: scipy (>=1.14,<2.0)
 Requires-Dist: tqdm (>=4.66,<5.0)
 Project-URL: Bug Tracker, https://github.com/equinor/completor/issues
 Project-URL: Documentation, https://equinor.github.io/completor
@@ -76,6 +76,14 @@ This should run for some time and display a help message.
 ### Create and run your first model
 Some examples of Completor case file are available in [Examples](documentation/docs/about/examples.mdx) and detailed explanation is available in [Configuration](documentation/docs/about/configuration.mdx).
 
+### References
+Some technical paper related to Completor and ICV Control applications are available to read and cite:
+- Handita Sutoyo, Filippo Panini, Cuthbert Shang Wui Ng, Martin Halvorsen, Geir Elseth, Ingvild Berg Martiniussen, Corentin Cochard, Erik Johan Helland, Sean Robert Smith, and Lene Amundsen.
+"Maximize Value from Inflow Control Technology Implementations Through Novel Standardized Workflow and Open-Source Modelling Tool."
+Paper presented at the OTC Brasil, Rio de Janeiro, Brazil, October 2025. doi: [10.4043/36167-MS](https://doi.org/10.4043/36167-MS)
+- Handita Sutoyo, Mathias Bellout, Margrete Hånes, and Rodolfo Oliveira. "Ensemble-Based Proactive Optimization using a Reactive Strategy
+for ICV Control." Paper presented at the SPE Norway Subsurface Conference, Bergen, Norway, April 2024. doi: [10.2118/218472-MS](https://doi.org/10.2118/218472-MS)
+
 ## Getting started as a contributor
 ### Contribution guide
 We welcome all kinds of contributions, including code, bug reports, issues, feature requests, and documentation.

completor-1.5.0.dist-info/RECORD

@@ -0,0 +1,32 @@
+completor/__init__.py,sha256=k6amf7jhp7KkBIlaw93-NZITxyZjPSzA5McFAZh8yv8,76
+completor/completion.py,sha256=quhQOdQREv8MsHW5amT0sG-84Y12KVdT0eylbKCul3g,31177
+completor/config_jobs/run_completor,sha256=XePKj2xocfGF0XFRqr7sqfpZGrjgWcfaZLHIhVvGFCQ,600
+completor/constants.py,sha256=y6nEtv-u8W-OFz84przKXVhS4as8SL8fwMMlJ38_WRA,13963
+completor/create_output.py,sha256=7B3mx9xFc2Pq8Qo0GYWO3GNgylEa8pvfiHVV_3fs5Hs,26226
+completor/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+completor/exceptions/clean_exceptions.py,sha256=uQ2jgGfvUDAoS56JBWh-8ZCPIMB4hvYxLF-snA-_-pg,373
+completor/exceptions/exceptions.py,sha256=eS00mVzmC4gQ7MUyGSknvKotmo2XzNGyp007mhjLMy0,5081
+completor/get_version.py,sha256=LMzybu7m-O203lUSZvyu86J4bMobbjE9A23fWLDlxaM,168
+completor/hook_implementations/__init__.py,sha256=4tdNpVj3MNfzTMIGkp2MjP1_z3grIlwJikiA-f1a24g,104
+completor/hook_implementations/forward_model_steps.py,sha256=48tKeQUE8Kx1jhxs1MCGFR_ndgciuOxe27T74qE4GQM,776
+completor/hook_implementations/run_completor.py,sha256=WZhry4KmzxIaufXduYa6EO8BQHY3wNJ_gDXRRnPma6Y,2164
+completor/icv_file_handling.py,sha256=PeZ6eACM38iy7smhViaV5gA8BhddPux-5psnkJeOTnY,15722
+completor/icv_functions.py,sha256=yde_-FsFLG0_TXy3qk4wjDhAOSdaOzQ6elAOgXXcf3I,35156
+completor/initialization.py,sha256=MyKDvvL_ZNJp_KxXivdvxndpMlrF66XU8H6vOAoaSfI,24627
+completor/input_validation.py,sha256=vieorj4Onx4EZPA_nvIkpLkY3LRKS9LaIo5I0NRBC9A,16692
+completor/launch_args_parser.py,sha256=gb3FcyufZlRnKS3BZkFmgVH1VoSxMD0MbCLsHZKmz4c,1413
+completor/logger.py,sha256=-sIxcYfnk6CFbBP1BqZtEpnS3NVO0uxXxWx0Fw4HpSw,4791
+completor/main.py,sha256=JDGnVa5CFBh-ytUUlqgMjcTbFXALEpxEyAyUnKKv-NM,12456
+completor/parse.py,sha256=XUCWbhKQeBIBfj8s3p7TNsggQ3Z1euxgQ5Vet9dJIxQ,20118
+completor/prepare_outputs.py,sha256=o-7SLD0F5jiw5_lnq5kewB1tYOiLa0u2TxGz6kRIO-8,87613
+completor/read_casefile.py,sha256=Pxub_EzfR_5pB00pKqH9jK9EkXln7r2pLQkOE_jyASA,56248
+completor/read_schedule.py,sha256=IYyCubOggFGg664h1flTl7MUJhJWyibr6JsptnURjUA,18101
+completor/utils.py,sha256=1goaoJ_vZuCq_QC_BrVcI6agQp-zlzKEeGvRTfrfwQQ,17027
+completor/visualization.py,sha256=ObxThqIyW3fsvVIupxVsgySFI_54n_Di-HTzFtDMSgo,4580
+completor/visualize_well.py,sha256=HLglSN2ce-u9nklJelqwhSxwwaj7n-aU6o8lUScbiI0,8790
+completor/wells.py,sha256=Q2detK0FxIBgusYkCRmomRIfcScBNvNTYX43GFyAHGw,12246
+completor-1.5.0.dist-info/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+completor-1.5.0.dist-info/METADATA,sha256=mYt9RURkbLLOSfZJKhUYSwpGfnmW3nB3flF3oZH6uF8,8863
+completor-1.5.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+completor-1.5.0.dist-info/entry_points.txt,sha256=rhRKVhqh_ItG-tD5YrCfMvsGnfv-h0TXP0jX_fB6Kbc,121
+completor-1.5.0.dist-info/RECORD,,

completor-1.5.0.dist-info/entry_points.txt

@@ -0,0 +1,6 @@
+[console_scripts]
+completor=completor.main:main
+
+[ert]
+run_completor=completor.hook_implementations.forward_model_steps
+

completor/hook_implementations/jobs.py

@@ -1,71 +0,0 @@
-import sys
-from pathlib import Path
-
-from completor.logger import logger
-
-try:
-    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?")
-
-
-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():
-    return _get_jobs_from_directory("config_jobs")
-
-
-@ert_plugin(name="completor")
-def job_documentation(job_name):
-    if job_name != "run_completor":
-        return None
-
-    description = """Completor is a script for modelling
-wells with advanced completion.
-It generates a well schedule to be included in reservoir simulator,
-by combining the multi-segment tubing definition (from pre-processor reservoir modelling tools)
-with a user defined file specifying the completion design.
-The resulting well schedule comprises all keywords and parameters required by
-reservoir simulator. See the Completor documentation for details.
-
-Required:
----------
--i   : followed by name of file specifying completion design (e.g. completion.case).
--s   : followed by name of schedule file with multi-segment tubing definition,
-       including COMPDAT, COMPSEGS and WELSEGS (required if not specified in case file).
-
-Optional:
----------
---help   : how to run completor.
---about  : about completor.
--o       : followed by name of completor output file.
---figure  : generates a pdf file with a schematics of the well segment structure.
-
-"""
-
-    examples = """.. code-block:: console
-  FORWARD_MODEL run_completor(
-    <CASE>=path/to/completion.case,
-    <INPUT_SCH>=path/to/input.sch,
-    <OUTPUT_SCH>path/to/output.sch
-)
-"""
-
-    category = "modelling.reservoir"
-
-    return {"description": description, "examples": examples, "category": category}

completor-1.3.0.dist-info/RECORD

@@ -1,27 +0,0 @@
-completor/__init__.py,sha256=k6amf7jhp7KkBIlaw93-NZITxyZjPSzA5McFAZh8yv8,76
-completor/completion.py,sha256=quhQOdQREv8MsHW5amT0sG-84Y12KVdT0eylbKCul3g,31177
-completor/config_jobs/run_completor,sha256=XePKj2xocfGF0XFRqr7sqfpZGrjgWcfaZLHIhVvGFCQ,600
-completor/constants.py,sha256=2e1o5Env5lHyhopkrs_C__9DksS5xml1-Ea_X3cLl0E,13521
-completor/create_output.py,sha256=6ygglcCUYYII5sWr_ey4cvUCCsXb0UGqXY5GQAzX8fQ,25969
-completor/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-completor/exceptions/clean_exceptions.py,sha256=uQ2jgGfvUDAoS56JBWh-8ZCPIMB4hvYxLF-snA-_-pg,373
-completor/exceptions/exceptions.py,sha256=eS00mVzmC4gQ7MUyGSknvKotmo2XzNGyp007mhjLMy0,5081
-completor/get_version.py,sha256=LMzybu7m-O203lUSZvyu86J4bMobbjE9A23fWLDlxaM,168
-completor/hook_implementations/jobs.py,sha256=8Ao8UadfJzEY7jWzj6C_OXm18fHmfXrbCB2_jS7KHiU,2180
-completor/input_validation.py,sha256=F17AWi-qR6cX5_1lEFgtYOMOO0Xo3gTtL2ETM5P_uGE,15022
-completor/launch_args_parser.py,sha256=gb3FcyufZlRnKS3BZkFmgVH1VoSxMD0MbCLsHZKmz4c,1413
-completor/logger.py,sha256=gYDbPL8ca5qT_MqYlDKEMKcSfIXW_59QklX8Gss5b2U,4784
-completor/main.py,sha256=HlQzv5gpBYdDbYTBLSkAnK7o6d2QfTQnjrNizq3Ym6s,9343
-completor/parse.py,sha256=EGlt9CgkrXPqa7woyWQ5t_nh6OWsFrc2SJr8aFr_KsQ,20133
-completor/prepare_outputs.py,sha256=o-7SLD0F5jiw5_lnq5kewB1tYOiLa0u2TxGz6kRIO-8,87613
-completor/read_casefile.py,sha256=NebZRrO35aqrZIJ7eHcS6buBbAaDWw8wUtc4kBHsV2U,38184
-completor/read_schedule.py,sha256=IYyCubOggFGg664h1flTl7MUJhJWyibr6JsptnURjUA,18101
-completor/utils.py,sha256=9Qayt7xMsimpoVDo5sL86gVaQBbIOezMBRyMXd3haXw,13598
-completor/visualization.py,sha256=ObxThqIyW3fsvVIupxVsgySFI_54n_Di-HTzFtDMSgo,4580
-completor/visualize_well.py,sha256=HLglSN2ce-u9nklJelqwhSxwwaj7n-aU6o8lUScbiI0,8790
-completor/wells.py,sha256=Q2detK0FxIBgusYkCRmomRIfcScBNvNTYX43GFyAHGw,12246
-completor-1.3.0.dist-info/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-completor-1.3.0.dist-info/METADATA,sha256=IL5-ncKANt09P_kbEZeJu0DV3YpjAS4RiFtCThhHBKM,8018
-completor-1.3.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-completor-1.3.0.dist-info/entry_points.txt,sha256=co5L2_CC2QQWVdEALeMp-NIC4mx4nRpcLcvpVXMYdeI,106
-completor-1.3.0.dist-info/RECORD,,

completor-1.3.0.dist-info/entry_points.txt

@@ -1,6 +0,0 @@
-[console_scripts]
-completor=completor.main:main
-
-[ert]
-run_completor=completor.hook_implementations.jobs
-