completor 1.2.0__py3-none-any.whl → 1.4.0__py3-none-any.whl

completor/constants.py

@@ -254,6 +254,7 @@ class _Keywords:
     INFLOW_CONTROL_VALVE = "WSEGICV"
     INFLOW_CONTROL_DEVICE = "WSEGSICD"
     DENSITY = "WSEGDENSITY"
+    PYTHON_DEPENDENT = "PYTHON"
     DENSITY_ACTIVATED_RECOVERY = "WSEGDAR"
     INJECTION_VALVE = "WSEGINJV"
     LATERAL_TO_DEVICE = "LATERAL_TO_DEVICE"

completor/create_output.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 import getpass
 from datetime import datetime
 
+import matplotlib.pyplot as plt  # type: ignore
 import numpy as np
 import numpy.typing as npt
 import pandas as pd
@@ -20,13 +21,13 @@ from completor.visualize_well import visualize_well
 from completor.wells import Lateral, Well
 
 
-def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None) -> tuple[str, str, str, str]:
+def format_output(well: Well, case: ReadCasefile, pdf: PdfPages | None = None) -> tuple[str, str, str, str]:
     """Formats the finished output string to be written to a file.
 
     Args:
         well: Well data.
         case: Case data.
-        figure_name: The name of the figure, if None, no figure is printed. Defaults to None.
+        pdf: The name of the figure, if None, no figure is printed. Defaults to None.
 
     Returns:
         Properly formatted output data for completion data, well segments, completion segments, and bonus.
@@ -41,8 +42,10 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
     print_autonomous_inflow_control_device = ""
     print_inflow_control_device = ""
     print_density_driven = ""
+    print_density_driven_include = ""
     print_injection_valve = ""
     print_dual_rate_controlled_production = ""
+    print_density_driven_pyaction = ""
 
     start_segment = 2
     start_branch = 1
@@ -147,23 +150,35 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
         print_inflow_control_valve += _format_inflow_control_valve(
             well.well_name, lateral.lateral_number, df_inflow_control_valve, first
         )
-        print_density_driven += _format_density_driven(well.well_number, df_density_driven)
         print_injection_valve += _format_injection_valve(well.well_number, df_injection_valve)
         print_dual_rate_controlled_production += _format_dual_rate_controlled_production(
             well.well_number, df_dual_rate_controlled_production
         )
+        # output using ACTIONX (if-else) logic is dual RCP, density driven, and injection valve
+        if case.python_dependent:
+            # print the python file out
+            # append all laterals for density driven, dual RCP, and injection valve
+            # TODO(#274): Add functionality for dual RCP
+            print_density_driven_pyaction = _format_density_driven_pyaction(df_density_driven)
+            output_directory = prepare_outputs.print_python_file(
+                print_density_driven_pyaction, str(case.output_file), well.well_name, lateral.lateral_number
+            )
+            print_density_driven_include += prepare_outputs.print_wsegdensity_include(
+                output_directory, well.well_name, lateral.lateral_number
+            )
+        else:
+            print_density_driven += _format_density_driven(well.well_number, df_density_driven)
 
-        if figure_name is not None:
-            logger.info(f"Creating figure for lateral {lateral.lateral_number}.")
-            with PdfPages(figure_name) as figure:
-                figure.savefig(
-                    visualize_well(
-                        well.well_name, well.df_well_all_laterals, well.df_reservoir_all_laterals, case.segment_length
-                    ),
-                    orientation="landscape",
-                )
-            logger.info("Creating schematics: %s.pdf", figure_name)
+        if pdf is not None:
+            logger.info(f"Creating figure for well {well.well_name}, lateral {lateral.lateral_number}.")
+            fig = visualize_well(
+                well.well_name, well.df_well_all_laterals, well.df_reservoir_all_laterals, case.segment_length
+            )
+            pdf.savefig(fig, orientation="landscape")
+            plt.close(fig)
+            logger.info("Creating schematics: %s", pdf)
         first = False
+
     print_completion_data = "\n".join(completion_data_list)
     if print_well_segments:
         print_well_segments = f"{print_well_segments}\n/\n\n"
@@ -185,7 +200,7 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
     if print_density_driven:
         metadata = (
             f"{'-' * 100}\n"
-            "-- This is how we model DENSITY technology using sets of ACTIONX keywords.\n"
+            "-- This is how we model density driven technology using sets of ACTIONX keywords.\n"
             "-- The segment dP curves changes according to the segment water-\n"
             "-- and gas volume fractions at downhole condition.\n"
             "-- The value of Cv is adjusted according to the segment length and the number of\n"
@@ -197,7 +212,7 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
     if print_injection_valve:
         metadata = (
             f"{'-' * 100}\n"
-            "-- This is how we model INJV technology using sets of ACTIONX keywords.\n"
+            "-- This is how we model autonomous injection valve technology using sets of ACTIONX keywords.\n"
             "-- The DP paramaters changes according to the trigger parameter.-\n"
             "-- The value of Cv is adjusted according to the segment length and the number of\n"
             "-- devices per joint. The constriction area will change if the parameter is triggered.\n"
@@ -207,12 +222,24 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
     if print_dual_rate_controlled_production:
         metadata = (
             f"{'-' * 100}\n"
-            "-- This is how we model DUALRCP technology using sets of ACTIONX keyword\n"
+            "-- This is how we model dual RCP curves using sets of ACTIONX keyword\n"
             "-- the DP parameters change according to the segment water cut (at downhole condition )\n"
             "-- and gas volume fraction (at downhole condition)\n"
             f"{'-' * 100}\n\n\n"
         )
         bonus.append(metadata + print_dual_rate_controlled_production + "\n\n\n\n")
+    if print_density_driven_pyaction:
+        metadata = (
+            f"{'-' * 100}\n"
+            "-- This is how we model density driven technology for python dependent keyword.\n"
+            "-- The segment dP curves changes according to the segment water-\n"
+            "-- and gas volume fractions at downhole condition.\n"
+            "-- The value of Cv is adjusted according to the segment length and the number of\n"
+            "-- devices per joint. The constriction area varies according to values of\n"
+            "-- volume fractions.\n"
+            f"{'-' * 100}\n\n\n"
+        )
+        bonus.append(metadata + print_density_driven_include + "\n\n\n\n")
 
     return print_completion_data, print_well_segments, print_completion_segments, "".join(bonus)
 
@@ -463,6 +490,20 @@ def _format_density_driven(well_number: int, df_wsegdensity: pd.DataFrame) -> st
     return prepare_outputs.print_wsegdensity(df_wsegdensity, well_number + 1)
 
 
+def _format_density_driven_pyaction(df_wsegdensity: pd.DataFrame) -> str:
+    """Formats well-segments for density driven valve.
+
+    Args:
+        df_wsegdensity: Data to print.
+
+    Returns:
+        Formatted string.
+    """
+    if df_wsegdensity.empty:
+        return ""
+    return prepare_outputs.print_wsegdensity_pyaction(df_wsegdensity)
+
+
 def _format_injection_valve(well_number: int, df_wseginjv: pd.DataFrame) -> str:
     """Formats well-segments for injection valve.
 

completor/hook_implementations/__init__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from .run_completor import RunCompletor
+
+__all__ = ["RunCompletor"]

completor/hook_implementations/forward_model_steps.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+import ert  # type: ignore
+
+from completor.hook_implementations import RunCompletor
+from completor.logger import logger
+
+PLUGIN_NAME = "completor"
+
+try:
+    from ert.plugins.plugin_manager import ErtPluginManager  # type: ignore # noqa: F401
+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?")
+
+
+@ert.plugin(name=PLUGIN_NAME)
+def installable_workflow_jobs() -> dict[str, str]:
+    return {}
+
+
+@ert.plugin(name=PLUGIN_NAME)
+def installable_forward_model_steps() -> list[ert.ForwardModelStepPlugin]:
+    return [RunCompletor]

completor/hook_implementations/run_completor.py

@@ -0,0 +1,61 @@
+from __future__ import annotations
+
+from ert import ForwardModelStepDocumentation, ForwardModelStepJSON, ForwardModelStepPlugin  # type: ignore
+
+desc = """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.
+
+"""
+
+
+class RunCompletor(ForwardModelStepPlugin):
+    def __init__(self) -> None:
+        super().__init__(
+            name="run_completor",
+            command=[
+                "completor",
+                "-i",
+                "<CASE>",
+                "-s",
+                "<INPUT_SCH>",
+                "-o",
+                "<OUTPUT_SCH>",
+            ],
+        )
+
+    def validate_pre_realization_run(self, fm_step_json: ForwardModelStepJSON) -> ForwardModelStepJSON:
+        return fm_step_json
+
+    def validate_pre_experiment(self, fm_step_json: ForwardModelStepJSON) -> None:
+        pass
+
+    @staticmethod
+    def documentation() -> ForwardModelStepDocumentation | None:
+        return ForwardModelStepDocumentation(
+            category="modelling.reservoir",
+            source_package="completor",
+            source_function_name="RunCompletor",
+            description=desc,
+            examples="""
+.. code-block:: console
+  FORWARD_MODEL run_completor(<CASE>=case_completor.case, <INPUT_SCH>=drogon_pred.sch, <OUTPUT_SCH>=drogon_pred_ict.sch)
+""",
+        )

completor/main.py

@@ -5,8 +5,10 @@ from __future__ import annotations
 import logging
 import os
 import re
+import sys
 import time
 
+from matplotlib.backends.backend_pdf import PdfPages  # type: ignore
 from tqdm import tqdm
 
 from completor import create_output, parse, read_schedule, utils
@@ -89,6 +91,7 @@ def create(
     """
     case = ReadCasefile(case_file=case_file, schedule_file=schedule, output_file=new_file)
     active_wells = utils.get_active_wells(case.completion_table, case.gp_perf_devicelayer)
+    pdf = None
     figure_name = None
     if show_fig:
         figure_no = 1
@@ -96,6 +99,7 @@ def create(
         while os.path.isfile(figure_name):
             figure_no += 1
             figure_name = f"Well_schematic_{figure_no:03d}.pdf"
+        pdf = PdfPages(figure_name)
 
     err: Exception | None = None
     well = None
@@ -122,13 +126,13 @@ def create(
         for chunk in find_keyword_data(Keywords.COMPLETION_SEGMENTS, schedule):
             clean_data = clean_raw_data(chunk, Keywords.COMPLETION_SEGMENTS)
             meaningful_data = read_schedule.set_compsegs(meaningful_data, clean_data)
-        for i, well_name in tqdm(enumerate(active_wells.tolist()), total=len(active_wells)):
+        for i, well_name in tqdm(enumerate(active_wells.tolist()), total=len(active_wells), file=sys.stdout):
             try:
                 well = Well(well_name, i, case, meaningful_data[well_name])
             except KeyError:
                 logger.warning(f"Well '{well_name}' is written in case file but does not exist in schedule file.")
                 continue
-            compdat, welsegs, compsegs, bonus = create_output.format_output(well, case, figure_name)
+            compdat, welsegs, compsegs, bonus = create_output.format_output(well, case, pdf)
             for keyword in [Keywords.COMPLETION_SEGMENTS, Keywords.WELL_SEGMENTS, Keywords.COMPLETION_DATA]:
                 old_data = find_well_keyword_data(well_name, keyword, schedule)
                 if not old_data:
@@ -156,6 +160,8 @@ def create(
         schedule = replace_preprocessing_names(schedule, case.mapper)
         with open(new_file, "w", encoding="utf-8") as file:
             file.write(schedule)
+        if pdf is not None:
+            pdf.close()
 
     if err is not None:
         raise err

completor/prepare_outputs.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import math
 from collections.abc import MutableMapping
+from pathlib import Path
 from typing import Any
 
 import numpy as np
@@ -1828,3 +1829,143 @@ def print_wsegdualrcp(df_wsegdualrcp: pd.DataFrame, well_number: int) -> str:
             print_df = Keywords.AUTONOMOUS_INFLOW_CONTROL_DEVICE + "\n" + dataframe_tostring(print_df, True)
             action += f"{print_df}\n/\nENDACTIO\n\n"
     return action
+
+
+def print_wsegdensity_pyaction(df_wsegdensity: pd.DataFrame) -> str:
+    """Create PYACTION code.
+
+    Args:
+        df_wsegdensity: Output from function prepare_wsegdensity.
+
+    Returns:
+        Final code output formatted in PYACTION.
+    """
+    data_dict = df_wsegdensity.to_dict(orient="list")
+    final_code = f"""
+import opm_embedded
+
+ecl_state = opm_embedded.current_ecl_state
+schedule = opm_embedded.current_schedule
+report_step = opm_embedded.current_report_step
+summary_state = opm_embedded.current_summary_state
+
+if 'setup_done' not in locals():
+    execution_counter = dict()
+    executed = False
+    setup_done = True
+
+data={data_dict}
+
+for i in range(len(data["WELL"])):
+    well_name = data["WELL"][i]
+    segment_number = data["START_SEGMENT_NUMBER"][i]
+    flow_coefficient = data["FLOW_COEFFICIENT"][i]
+    oil_flow_area = data["OIL_FLOW_CROSS_SECTIONAL_AREA"][i]
+    gas_flow_area = data["GAS_FLOW_CROSS_SECTIONAL_AREA"][i]
+    water_flow_area = data["WATER_FLOW_CROSS_SECTIONAL_AREA"][i]
+    max_flow_area = data["MAX_FLOW_CROSS_SECTIONAL_AREA"][i]
+    water_low = data["WATER_HOLDUP_FRACTION_LOW_CUTOFF"][i]
+    water_high = data["WATER_HOLDUP_FRACTION_HIGH_CUTOFF"][i]
+    gas_low = data["GAS_HOLDUP_FRACTION_LOW_CUTOFF"][i]
+    gas_high = data["GAS_HOLDUP_FRACTION_HIGH_CUTOFF"][i]
+    defaults = data["DEFAULTS"][i]
+
+    swhf = summary_state[f"SWHF:{{well_name}}:{{segment_number}}"]
+    sghf = summary_state[f"SGHF:{{well_name}}:{{segment_number}}"]
+    suvtrig = summary_state[f"SUVTRIG:{{well_name}}:{{segment_number}}"]
+
+    keyword_oil = (
+        f"WSEGVALV\\n"
+        f"  '{{well_name}}' {{segment_number}} {{flow_coefficient}} {{oil_flow_area}} {{defaults}} {{max_flow_area}} /\\n/"
+    )
+    keyword_water = (
+        f"WSEGVALV\\n"
+        f"  '{{well_name}}' {{segment_number}} {{flow_coefficient}} {{water_flow_area}} {{defaults}} {{max_flow_area}} /\\n/"
+    )
+    keyword_gas = (
+        f"WSEGVALV\\n"
+        f"  '{{well_name}}' {{segment_number}} {{flow_coefficient}} {{gas_flow_area}} {{defaults}} {{max_flow_area}} /\\n/"
+    )
+
+    key = (well_name, segment_number)
+    execution_counter.setdefault(key, 0)
+
+    if execution_counter[key] == 0:
+        schedule.insert_keywords(keyword_oil, report_step)
+        summary_state[f"SUVTRIG:{{well_name}}:{{segment_number}}"] = 0
+
+    if execution_counter[key] < 1000000:
+        if swhf is not None and sghf is not None:
+            if swhf <= water_high and sghf > gas_high and suvtrig == 0:
+                schedule.insert_keywords(keyword_gas, report_step)
+                summary_state[f"SUVTRIG:{{well_name}}:{{segment_number}}"] = 1
+                execution_counter[key] += 1
+
+            elif swhf > water_high and sghf <= gas_high and suvtrig == 0:
+                schedule.insert_keywords(keyword_water, report_step)
+                summary_state[f"SUVTRIG:{{well_name}}:{{segment_number}}"] = 2
+                execution_counter[key] += 1
+
+            elif sghf < gas_low and suvtrig == 1:
+                schedule.insert_keywords(keyword_oil, report_step)
+                summary_state[f"SUVTRIG:{{well_name}}:{{segment_number}}"] = 0
+                execution_counter[key] += 1
+
+            elif swhf < water_low and suvtrig == 2:
+                schedule.insert_keywords(keyword_oil, report_step)
+                summary_state[f"SUVTRIG:{{well_name}}:{{segment_number}}"] = 0
+                execution_counter[key] += 1
+    """
+    return final_code
+
+
+def print_python_file(code: str, dir: str, well_name: str, lateral_number: int) -> str:
+    """Print Python PYACTION file.
+
+    Args:
+        code: Final code output formatted in PYACTION.
+        dir: Output path.
+        well_name: Well name.
+        lateral_number: Lateral number.
+
+    Returns:
+        Python file with PYACTION format, output directory with FMU format.
+    """
+    base_dir = Path.cwd() if Path(dir).parent == Path(".") else Path(dir).parent
+    fmu_path = Path("eclipse/include/")
+    if str(fmu_path) in str(base_dir):
+        base_include_path = Path("../include/schedule")
+    else:
+        base_include_path = Path("")
+    output_directory = f"{base_include_path}/wsegdensity_{well_name}_{lateral_number}.py"
+    python_file = base_dir / f"wsegdensity_{well_name}_{lateral_number}.py"
+    with open(python_file, "w") as file:
+        file.writelines(code)
+    return output_directory
+
+
+def print_wsegdensity_include(output_directory: str, well_name: str, lateral_number: int) -> str:
+    """Formatted PYACTION include in the output file.
+
+    Args:
+        output_directory: Include file path in FMU relative format.
+        well_name: Well name.
+        lateral_number: Lateral number.
+
+    Returns:
+        Include file output for the output file.
+    """
+    action = f"""
+-------------------------------------
+-- START OF PYACTION SECTION
+
+PYACTION
+WSEGDENSITY_{well_name}_{lateral_number} UNLIMITED /
+
+'{output_directory}' /
+
+-- END OF PYACTION SECTION
+-------------------------------------
+"""
+
+    return action

completor/read_casefile.py

@@ -91,6 +91,7 @@ class ReadCasefile:
         self.minimum_segment_length: float = 0.0
         self.strict = True
         self.gp_perf_devicelayer = False
+        self.python_dependent = False
         self.schedule_file = schedule_file
         self.output_file = output_file
         self.completion_table = pd.DataFrame()
@@ -119,6 +120,7 @@ class ReadCasefile:
         self.read_wsegvalv()
         self.read_wsegsicd()
         self.read_wsegdensity()
+        self.read_python_dependent()
         self.read_wseginjv()
         self.read_wsegdualrcp()
         self.read_wsegicv()
@@ -555,6 +557,18 @@ class ReadCasefile:
             if not check_contents(device_checks, self.wseginjv_table[Headers.DEVICE_NUMBER].to_numpy()):
                 raise CompletorError(f"Not all device in COMPLETION is specified in {Keywords.INJECTION_VALVE}")
 
+    def read_python_dependent(self) -> None:
+        """Read PYTHON keyword. Accepts TRUE or just '/' as True."""
+        start_index, end_index = parse.locate_keyword(self.content, Keywords.PYTHON_DEPENDENT)
+
+        if end_index == start_index + 1:
+            # Keyword followed directly by '/', no value = True
+            self.python_dependent = True
+        elif end_index == start_index + 2:
+            val = self.content[start_index + 1]
+            if val.upper() == "TRUE":
+                self.python_dependent = True
+
     def read_wsegdualrcp(self) -> None:
         """Read the DUALRCP keyword in the case file.
 

{completor-1.2.0.dist-info → completor-1.4.0.dist-info}/METADATA

@@ -1,29 +1,29 @@
 Metadata-Version: 2.1
 Name: completor
-Version: 1.2.0
+Version: 1.4.0
 Summary: Advanced multi-segmented well completion tool.
 Home-page: https://github.com/equinor/completor
 License: LGPL-3.0-only
 Author: Equinor ASA
 Author-email: opensource@equinor.com
-Requires-Python: >=3.11,<4.0
+Requires-Python: >=3.11,<3.14
 Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: ert
 Provides-Extra: test
-Requires-Dist: ert (>=12,<13) ; extra == "ert"
+Requires-Dist: ert (>=14,<15) ; extra == "ert"
 Requires-Dist: matplotlib (>=3.9,<4.0)
-Requires-Dist: numpy (>=1.26,<3.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
@@ -44,7 +44,7 @@ Detailed documentation for usage of completor can be found at https://equinor.gi
 ## Getting started as a user
 
 ### Prerequisites
-* [Python](https://www.python.org/), version 3.11
+* [Python](https://www.python.org/), version 3.11 or 3.13.
 * [ERT](https://github.com/equinor/ert) (optional, and only available on Linux.)
 
 ### Installation
@@ -85,7 +85,7 @@ and making a pull request.
 See [Contribution Document](documentation/docs/contribution_guide.mdx) on how to contribute.
 
 ### Install completor as dev
-In order to run Completor® you need to have versions of [Python 3.11](https://www.python.org/downloads/) installed.
+In order to run Completor® you need to have versions of [Python 3.11, 3.12 or 3.13](https://www.python.org/downloads/) installed.
 #### Source code
 Clone the [Completor® repository](https://github.com/equinor/completor) to get the source code.
 ```bash

{completor-1.2.0.dist-info → completor-1.4.0.dist-info}/RECORD

@@ -1,27 +1,29 @@
 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=eZPe6cbP8see9f_sJdUkdy6J6HM2eXulgqRCzTCBAqY,13489
-completor/create_output.py,sha256=T0hPnCOns86q2lvRMNuOz8Nz-8zlliYBtxNiiEPMRWs,24101
+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/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/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=ipARMDXXqPYRtBxYQnlj5MohepwkgrQkX3s2IJEaEcI,9151
+completor/main.py,sha256=HlQzv5gpBYdDbYTBLSkAnK7o6d2QfTQnjrNizq3Ym6s,9343
 completor/parse.py,sha256=EGlt9CgkrXPqa7woyWQ5t_nh6OWsFrc2SJr8aFr_KsQ,20133
-completor/prepare_outputs.py,sha256=YS6p_kfTw_zXi0jKPwxrx45_54wrUaD0ryuZ2qe_S5Q,82582
-completor/read_casefile.py,sha256=qs39CkpwyNXV4cm0tpMi9NOyehBQKOBWmsCjSrWEauM,37578
+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.2.0.dist-info/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-completor-1.2.0.dist-info/METADATA,sha256=4C5L62K_4i2YRU-SuQxVlcStnd03iTd0bZzVscKJWTg,7979
-completor-1.2.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-completor-1.2.0.dist-info/entry_points.txt,sha256=co5L2_CC2QQWVdEALeMp-NIC4mx4nRpcLcvpVXMYdeI,106
-completor-1.2.0.dist-info/RECORD,,
+completor-1.4.0.dist-info/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+completor-1.4.0.dist-info/METADATA,sha256=CahCvh1VKD17-UNNyhV6DhsmMLkg1pmES92__OETFDc,8018
+completor-1.4.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+completor-1.4.0.dist-info/entry_points.txt,sha256=rhRKVhqh_ItG-tD5YrCfMvsGnfv-h0TXP0jX_fB6Kbc,121
+completor-1.4.0.dist-info/RECORD,,

completor-1.4.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.2.0.dist-info/entry_points.txt

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