completor 1.3.0__tar.gz → 1.4.0__tar.gz

{completor-1.3.0 → completor-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: completor
-Version: 1.3.0
+Version: 1.4.0
 Summary: Advanced multi-segmented well completion tool.
 Home-page: https://github.com/equinor/completor
 License: LGPL-3.0-only

completor-1.4.0/completor/hook_implementations/__init__.py

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

completor-1.4.0/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-1.4.0/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-1.3.0 → completor-1.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "completor"
-version = "1.3.0"
+version = "1.4.0"
 description = "Advanced multi-segmented well completion tool."
 authors = ["Equinor ASA <opensource@equinor.com>"]
 repository = "https://github.com/equinor/completor"
@@ -54,7 +54,7 @@ requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry.plugins."ert"]
-run_completor = "completor.hook_implementations.jobs"
+run_completor = "completor.hook_implementations.forward_model_steps"
 
 [tool.black]
 line-length = 120

completor-1.3.0/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}