res2df 1.3.1__tar.gz → 1.3.3__tar.gz

{res2df-1.3.1 → res2df-1.3.3}/.github/workflows/codecov.yml

@@ -16,6 +16,12 @@ jobs:
       PYTHON: '3.11'
 
     steps:
+
+    - name: Install Ubuntu dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install libegl1
+
     - uses: actions/checkout@v4
 
     - name: Setup Python

{res2df-1.3.1 → res2df-1.3.3}/.github/workflows/res2df.yml

@@ -28,6 +28,12 @@ jobs:
             install-ert: true
 
     steps:
+
+      - name: Install Ubuntu dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install libegl1
+
       - name: Checkout commit locally
         uses: actions/checkout@v4
 

{res2df-1.3.1 → res2df-1.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: res2df
-Version: 1.3.1
+Version: 1.3.3
 Summary: Convert reservoir simulator input and output to DataFrames
 Home-page: http://github.com/equinor/res2df
 Author: Håvard Berland
@@ -47,6 +47,7 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: license
+Dynamic: license-file
 Dynamic: provides-extra
 Dynamic: requires-dist
 Dynamic: requires-python

{res2df-1.3.1 → res2df-1.3.3}/res2df/csv2res.py

@@ -19,21 +19,6 @@ from .summary import summary_reverse_main
 from .vfp import fill_reverse_parser as vfp_fill_reverse_parser
 from .vfp import vfp_reverse_main
 
-# String constants in use for generating ERT forward model documentation:
-DESCRIPTION: str = """Convert CSV files into include files. Uses the command
-line utility ``csv2res``. Run ``csv2res --help`` to see which subcommands are supported.
-No options other than the output file is possible when used directly as a forward model.
-When writing synthetic summary files, the ECLBASE with no filename suffix is expected
-as the OUTPUT argument."""
-CATEGORY: str = "utility.eclipse"
-EXAMPLES: str = (
-    "``FORWARD_MODEL "
-    "CSV2RES(<SUBCOMMAND>=equil, <CSVFILE>=equil.csv, "
-    "<OUTPUT>=eclipse/include/equil.inc)``"
-    "CSV2RES(<SUBCOMMAND>=summary, <CSVFILE>=summary-monthly.csv, "
-    "<OUTPUT>=eclipse/model/MONTHLYSUMMARY)``"
-)
-
 
 def get_parser() -> argparse.ArgumentParser:
     """Make parser"""

{res2df-1.3.1 → res2df-1.3.3}/res2df/fipreports.py

@@ -66,10 +66,10 @@ def report_block_lineparser(line: str) -> tuple:
         (liquid_oil, vapour_oil, total_oil) = map(
             float_or_nan, colonsections[2].split()
         )
+    elif len(colonsections[2].split()) == 2:
+        (liquid_oil, total_oil) = map(float_or_nan, colonsections[2].split())
     elif len(colonsections[2].split()) == 1:
         total_oil = float_or_nan(colonsections[2])
-    else:
-        (liquid_oil, total_oil) = map(float_or_nan, colonsections[2].split())
 
     total_water = float_or_nan(colonsections[3])
 
@@ -135,9 +135,6 @@ def df(prtfile: Union[str, ResdataFiles], fipname: str = "FIPNUM") -> pd.DataFra
         ".+" + fipname + r"\s+REPORT\s+REGION\s+(\d+)", re.IGNORECASE
     )
 
-    # Flag for whether we are supposedly parsing a PRT file made by OPM Flow:
-    opm = False
-
     with open(prtfile, encoding="utf-8") as prt_fh:
         logger.info(
             "Parsing file %s for blocks starting with %s REPORT REGION",
@@ -148,8 +145,6 @@ def df(prtfile: Union[str, ResdataFiles], fipname: str = "FIPNUM") -> pd.DataFra
             matcheddate = re.match(ecl_datematcher, line)
             if matcheddate is None:
                 matcheddate = re.match(opm_datematcher, line)
-                if matcheddate is not None:
-                    opm = True
             if matcheddate is not None:
                 newdate = datetime.date(
                     year=int(matcheddate.group(3)),
@@ -176,15 +171,19 @@ def df(prtfile: Union[str, ResdataFiles], fipname: str = "FIPNUM") -> pd.DataFra
                     # Skip if we are not on an interesting line.
                     continue
 
-                if opm is False:
-                    # The colons in the report block are not reliably included
-                    # (differs by Eclipse version), even in the same PRT file. We
-                    # insert them in fixed positions and hope for the best (if the
-                    # ASCII table is actually dynamic with respect to content, this
-                    # will fail)
+                # The colons in the report block are not reliably included
+                # (differs by Eclipse version), even in the same PRT file. We
+                # insert them in fixed positions and hope for the best (if the
+                # ASCII table is actually dynamic with respect to content, this
+                # will fail)
+                line = line.strip()
+                if line[0] != ":":
+                    line = ":" + line
+                # There should another colon somewhere between 25 - 27
+                # (depend on OPM/Eclipse version)
+                if ":" not in line[25:27] and len(line) > 26:
                     linechars = list(line)
-                    linechars[1] = ":"
-                    linechars[27] = ":"
+                    linechars[26] = ":"
                     line = "".join(linechars)
 
                 records.append(

{res2df-1.3.1 → res2df-1.3.3}/res2df/grid.py

@@ -726,9 +726,9 @@ def df2res(
             raise ValueError(f"Keyword {keyword} not found in grid dataframe")
         vector = np.zeros(global_size)
         vector[grid_df["GLOBAL_INDEX"].astype(int).values] = grid_df[keyword]
-        if dtype == int:
+        if dtype is int:
             vector = vector.astype(int)
-        if dtype == float:
+        if dtype is float:
             vector = vector.astype(float)
         if len(vector) != global_size:
             logger.warning(

{res2df-1.3.1 → res2df-1.3.3}/res2df/gruptree.py

@@ -340,7 +340,7 @@ def _add_to_tree_from_dict(
         _add_to_tree_from_dict(nested_dict=value, name=key, tree=tree, parent=name)
 
 
-def tree_from_dict(nested_dict: dict) -> treelib.Tree:
+def tree_from_dict(nested_dict: dict) -> treelib.Tree | str:
     """Convert a dictionary to a treelib Tree.
 
     The treelib representation of the trees is used

res2df-1.3.3/res2df/hook_implementations/forward_model_steps.py

@@ -0,0 +1,138 @@
+import shutil
+
+try:
+    from ert import (  # type: ignore
+        ForwardModelStepDocumentation,
+        ForwardModelStepJSON,
+        ForwardModelStepPlugin,
+        ForwardModelStepValidationError,
+    )
+    from ert import plugin as ert_plugin  # type: ignore
+except ModuleNotFoundError:
+    # ert is not installed, use dummy/transparent function decorator:
+    def ert_plugin(name: str = ""):
+        def decorator(func):
+            return func
+
+        return decorator
+
+    class ForwardModelStepDocumentation:  # type: ignore
+        pass
+
+    class ForwardModelStepJSON:  # type: ignore
+        pass
+
+    class ForwardModelStepPlugin:  # type: ignore
+        pass
+
+    class ForwardModelStepValidationError:  # type: ignore
+        pass
+
+
+class Res2Csv(ForwardModelStepPlugin):
+    def __init__(self) -> None:
+        super().__init__(
+            name="RES2CSV",
+            command=[
+                shutil.which("res2csv"),
+                "<SUBCOMMAND>",
+                "--verbose",
+                "--output",
+                "<OUTPUT>",
+                *[f"<XARG{num + 1}>" for num in range(10)],
+                "--",
+                "<ECLBASE>",
+            ],
+            default_mapping={f"<XARG{num + 1}>": "" for num in range(10)},
+        )
+
+    def validate_pre_experiment(self, fm_json: ForwardModelStepJSON) -> None:
+        if fm_json["argList"][0] == "<SUBCOMMAND>":
+            raise ForwardModelStepValidationError(
+                "You must supply a value for SUBCOMMAND to RES2CSV"
+            )
+        if fm_json["argList"][3] == "<OUTPUT>":
+            raise ForwardModelStepValidationError(
+                "You must supply a value for OUTPUT to RES2CSV"
+            )
+
+    @staticmethod
+    def documentation() -> ForwardModelStepDocumentation | None:
+        return ForwardModelStepDocumentation(
+            description="""Convert reservoir simulator input and output files into CSV
+files, with the command line utility ``res2csv``. Run ``res2csv --help`` to see
+which subcommands are supported.
+
+For supplying options to subcommands, you can use the arguments ``<XARGn>``
+where ``n`` goes from 1 to 10.
+
+For more documentation, see https://equinor.github.io/res2df/.
+""",
+            category="utility.eclipse",
+            examples="""Outputting the EQUIL data from a .DATA file. This is implicitly
+supplied in ERT configs::
+
+   FORWARD_MODEL RES2CSV(<SUBCOMMAND>=equil, <OUTPUT>=equil.csv)
+
+For a yearly summary export of the realization, options have to be supplied
+with the XARG options::
+
+  FORWARD_MODEL RES2CSV(<SUBCOMMAND>=summary, \
+    <OUTPUT>=yearly.csv, <XARG1>="--time_index", <XARG2>="yearly")
+
+The quotes around double-dashed options are critical to avoid ERT taking for a
+comment. For more options, use ``<XARG3>`` etc.
+""",
+        )
+
+
+class Csv2Res(ForwardModelStepPlugin):
+    def __init__(self) -> None:
+        super().__init__(
+            name="CSV2RES",
+            command=[
+                shutil.which("csv2res"),
+                "<SUBCOMMAND>",
+                "--verbose",
+                "--output",
+                "<OUTPUT>",
+                "<CSVFILE>",
+            ],
+        )
+
+    def validate_pre_experiment(self, fm_json: ForwardModelStepJSON) -> None:
+        if fm_json["argList"][0] == "<SUBCOMMAND>":
+            raise ForwardModelStepValidationError(
+                "You must supply a value for SUBCOMMAND to CSV2RES"
+            )
+        if fm_json["argList"][3] == "<OUTPUT>":
+            raise ForwardModelStepValidationError(
+                "You must supply a value for OUTPUT to CSV2RES"
+            )
+        if fm_json["argList"][4] == "<CSVFILE>":
+            raise ForwardModelStepValidationError(
+                "You must supply a value for CSVFILE to CSV2RES"
+            )
+
+    @staticmethod
+    def documentation() -> ForwardModelStepDocumentation | None:
+        return ForwardModelStepDocumentation(
+            description="""Convert CSV files into include files. Uses the command
+line utility ``csv2res``. Run ``csv2res --help`` to see which subcommands are supported.
+No options other than the output file is possible when used directly as a forward model.
+When writing synthetic summary files, the ECLBASE with no filename suffix is expected
+as the OUTPUT argument.""",
+            category="utility.eclipse",
+            examples=(
+                "``FORWARD_MODEL "
+                "CSV2RES(<SUBCOMMAND>=equil, <CSVFILE>=equil.csv, "
+                "<OUTPUT>=eclipse/include/equil.inc)``"
+                "CSV2RES(<SUBCOMMAND>=summary, <CSVFILE>=summary-monthly.csv, "
+                "<OUTPUT>=eclipse/model/MONTHLYSUMMARY)``"
+            ),
+        )
+
+
+@ert_plugin(name="RES2CSV")
+def installable_forward_model_steps() -> list[type[ForwardModelStepPlugin]]:
+    return [Res2Csv, Csv2Res]

{res2df-1.3.1 → res2df-1.3.3}/res2df/res2csv.py

@@ -12,33 +12,6 @@ from typing import Optional
 
 from .__version__ import __version__
 
-# String constants in use for generating ERT forward model documentation:
-DESCRIPTION: str = """Convert reservoir simulator input and output files into CSV files,
-with the command line utility ``res2csv``. Run ``res2csv --help`` to see
-which subcommands are supported.
-
-For supplying options to subcommands, you can use the arguments ``<XARGn>``
-where ``n`` goes from 1 to 10.
-
-For more documentation, see https://equinor.github.io/res2df/.
-"""
-CATEGORY: str = "utility.eclipse"
-EXAMPLES: str = """
-
-Outputting the EQUIL data from a .DATA file. This is implicitly
-supplied in ERT configs::
-
-   FORWARD_MODEL RES2CSV(<SUBCOMMAND>=equil, <OUTPUT>=equil.csv)
-
-For a yearly summary export of the realization, options have to be supplied
-with the XARG options::
-
-  FORWARD_MODEL RES2CSV(<SUBCOMMAND>=summary, <OUTPUT>=yearly.csv, <XARG1>="--time_index", <XARG2>="yearly")
-
-The quotes around double-dashed options are critical to avoid ERT taking for a
-comment. For more options, use ``<XARG3>`` etc.
-"""  # noqa
-
 
 def get_parser() -> argparse.ArgumentParser:
     """Make parser"""

{res2df-1.3.1 → res2df-1.3.3}/res2df/summary.py

@@ -814,6 +814,11 @@ def summary_main(args) -> None:
         paramfile=args.paramfile,
         datetime=False,
     )
+
+    if sum_df.empty:
+        logger.error("No data to write. The input file may be missing or invalid.")
+        return
+
     if args.arrow:
         sum_df = _df2pyarrow(sum_df)
 

{res2df-1.3.1 → res2df-1.3.3}/res2df/version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.3.1'
-__version_tuple__ = version_tuple = (1, 3, 1)
+__version__ = version = '1.3.3'
+__version_tuple__ = version_tuple = (1, 3, 3)

{res2df-1.3.1 → res2df-1.3.3}/res2df/vfp/_vfpinj.py

@@ -116,7 +116,8 @@ def basic_data(
     if no_interp_values != no_tab_records:
         raise ValueError(
             "Dimensions of interpolation ranges does "
-            "not match number of tabulated records"
+            "not match number of tabulated records "
+            f"in vfp table {tableno}"
         )
 
     # Extract interpolation values and tabulated values (BHP values)
@@ -136,7 +137,8 @@ def basic_data(
         if len(bhp_values) != no_flow_values:
             raise ValueError(
                 "Dimension of record of tabulated values "
-                "does not match number of flow values"
+                "does not match number of flow values "
+                f"in vfp table {tableno}"
             )
         bhp_table.append(bhp_values)
 

{res2df-1.3.1 → res2df-1.3.3}/res2df/vfp/_vfpprod.py

@@ -141,7 +141,8 @@ def basic_data(
     if no_interp_values != no_tab_records:
         raise ValueError(
             "Dimensions of interpolation ranges "
-            "does not match number of tabulated records"
+            "does not match number of tabulated records "
+            f"in vfp table {tableno}"
         )
 
     # Extract interpolation values and tabulated values (BHP values)
@@ -171,7 +172,8 @@ def basic_data(
         if len(bhp_values) != no_flow_values:
             raise ValueError(
                 "Dimension of record of tabulated "
-                "values does not match number of flow values"
+                "values does not match number of flow values "
+                f"in vfp table {tableno}"
             )
         bhp_table.append(bhp_values)
 

{res2df-1.3.1 → res2df-1.3.3}/res2df.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: res2df
-Version: 1.3.1
+Version: 1.3.3
 Summary: Convert reservoir simulator input and output to DataFrames
 Home-page: http://github.com/equinor/res2df
 Author: Håvard Berland
@@ -47,6 +47,7 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: license
+Dynamic: license-file
 Dynamic: provides-extra
 Dynamic: requires-dist
 Dynamic: requires-python

{res2df-1.3.1 → res2df-1.3.3}/res2df.egg-info/SOURCES.txt

@@ -1,4 +1,3 @@
-.codacy.yml
 .gitignore
 .pre-commit-config.yaml
 CONTRIBUTING.md
@@ -105,10 +104,8 @@ res2df.egg-info/entry_points.txt
 res2df.egg-info/not-zip-safe
 res2df.egg-info/requires.txt
 res2df.egg-info/top_level.txt
-res2df/config_jobs/CSV2RES
-res2df/config_jobs/RES2CSV
 res2df/hook_implementations/__init__.py
-res2df/hook_implementations/jobs.py
+res2df/hook_implementations/forward_model_steps.py
 res2df/opmkeywords/BRANPROP
 res2df/opmkeywords/COMPDAT
 res2df/opmkeywords/COMPLUMP

{res2df-1.3.1 → res2df-1.3.3}/res2df.egg-info/entry_points.txt

@@ -4,4 +4,4 @@ res2arrow = res2df.res2csv:main
 res2csv = res2df.res2csv:main
 
 [ert]
-res2df_jobs = res2df.hook_implementations.jobs
+res2df_steps = res2df.hook_implementations.forward_model_steps

{res2df-1.3.1 → res2df-1.3.3}/ruff.toml

@@ -4,6 +4,7 @@ line-length = 88
 
 [lint]
 select = [
+  "E",  # pycodestyle
   "W",  # pycodestyle
   "I",  # isort
   "B",  # flake-8-bugbear

{res2df-1.3.1 → res2df-1.3.3}/setup.cfg

@@ -9,10 +9,6 @@ markers =
 	integration: marks a test as an integration test
 	requires_eclipse: A test that requires the Eclipse simulator
 
-[build_sphinx]
-all-files = 1
-warning-is-error = 1
-
 [rstcheck]
 ignore_directives = argparse,automodule
 ignore_messages = Hyperlink target .* is not referenced

{res2df-1.3.1 → res2df-1.3.3}/setup.py

@@ -67,7 +67,6 @@ setup(
     package_data={
         "res2df": [
             "opmkeywords/*",
-            "config_jobs/*",
             "py.typed",
             "svg_color_keyword_names.txt",
         ]
@@ -79,7 +78,7 @@ setup(
             "res2csv=res2df.res2csv:main",
             "res2arrow=res2df.res2csv:main",
         ],
-        "ert": ["res2df_jobs = res2df.hook_implementations.jobs"],
+        "ert": ["res2df_steps = res2df.hook_implementations.forward_model_steps"],
     },
     test_suite="tests",
     install_requires=REQUIREMENTS,

{res2df-1.3.1 → res2df-1.3.3}/tests/data/fipreports/TEST1.PRT

@@ -222,3 +222,55 @@ Randomly generated data
   OUTFLOW TO REGION   3            -87796.                      -87796.:         58859. :           -0.     -1594053.      -1594053.
   OUTFLOW TO REGION   8                 0.                           0.:         21859. :            0.            0.             0.
  ====================================================================================================================================
+
+### Starting from OPM 2025.10, no space at the beginning of the line
+
+                              **************************************************************************
+  BALANCE  AT         0  DAYS *Drogon synthetic reservoir model                                          *
+  REPORT    0    01 Jan 2018  *                                             Flow  version 2025.10-pre  *
+                              **************************************************************************
+
+
+                                                    ==================================================
+                                                    :                  FIELD TOTALS                  :
+                                                    :        PAV  =           300  BARSA             :
+                                                    :        PORV =     512394984  RM3               :
+                                                    : Pressure is weighted by hydrocarbon pore volume:
+                                                    : Pore volumes are taken at reference conditions :
+                          :--------------- OIL  SM3 ------------------:-- WAT    SM3 --:--------------  GAS     SM3 ---------------:
+                          :    LIQUID         VAPOUR        TOTAL     :     TOTAL      :     FREE        DISSOLVED       TOTAL     :
+:-------------------------:-------------------------------------------:----------------:-------------------------------------------:
+:CURRENTLY IN PLACE       :   33773363        162535       33935898   :   444928115    :  1056474997     4805914695    5862389693  :
+:-------------------------:-------------------------------------------:----------------:-------------------------------------------:
+:ORIGINALLY IN PLACE      :   33773363        162535       33935898   :   444928115    :  1056474997     4805914695    5862389693  :
+====================================================================================================================================
+
+
+
+                                                    ==================================================
+                                                    :              FIPOPM REPORT REGION  1           :
+                                                    :        PAV  =           300  BARSA             :
+                                                    :        PORV =      82199852  RM3               :
+                          :--------------- OIL  SM3 ------------------:-- WAT    SM3 --:--------------  GAS     SM3 ---------------:
+                          :    LIQUID         VAPOUR        TOTAL     :     TOTAL      :     FREE        DISSOLVED       TOTAL     :
+:-------------------------:-------------------------------------------:----------------:-------------------------------------------:
+:CURRENTLY IN PLACE       :    311274           0           311274    :    79180976    :       0          43833585      43833585   :
+:-------------------------:-------------------------------------------:----------------:-------------------------------------------:
+:ORIGINALLY IN PLACE      :    311274           0           311274    :    79180976    :       0          43833585      43833585   :
+:-------------------------:-------------------------------------------:----------------:-------------------------------------------:
+====================================================================================================================================
+
+
+
+                                                    ==================================================
+                                                    :              FIPOPM REPORT REGION  2           :
+                                                    :        PAV  =           302  BARSA             :
+                                                    :        PORV =      21191418  RM3               :
+                          :--------------- OIL  SM3 ------------------:-- WAT    SM3 --:--------------  GAS     SM3 ---------------:
+                          :    LIQUID         VAPOUR        TOTAL     :     TOTAL      :     FREE        DISSOLVED       TOTAL     :
+:-------------------------:-------------------------------------------:----------------:-------------------------------------------:
+:CURRENTLY IN PLACE       :    4893558          0          4893558    :    13735096    :       0         689110895     689110895   :
+:-------------------------:-------------------------------------------:----------------:-------------------------------------------:
+:ORIGINALLY IN PLACE      :    4893558          0          4893558    :    13735096    :       0         689110895     689110895   :
+:-------------------------:-------------------------------------------:----------------:-------------------------------------------:
+====================================================================================================================================

{res2df-1.3.1 → res2df-1.3.3}/tests/test_ert_hooks.py

@@ -5,7 +5,6 @@ from pathlib import Path
 import pandas as pd
 import pytest
 import res2df
-from res2df.hook_implementations import jobs
 
 try:
     # pylint: disable=unused-import
@@ -108,42 +107,9 @@ def test_res2csv_through_ert(tmp_path):
         assert Path(subcommand + ".inc").is_file()
 
 
-@pytest.mark.skipif(not HAVE_ERT, reason="ERT is not installed")
-def test_job_documentation():
-    """Test that for registered ERT forward models the documentation is non-empty"""
-    if HAVE_ERT:
-        assert (
-            type(jobs.job_documentation("RES2CSV"))
-            == ert.plugins.plugin_response.PluginResponse
-        )
-        assert (
-            type(jobs.job_documentation("CSV2RES"))
-            == ert.plugins.plugin_response.PluginResponse
-        )
-
-    else:
-        assert jobs.job_documentation("RES2CSV") is None
-        assert jobs.job_documentation("CSV2RES") is None
-
-    assert jobs.job_documentation("foobar") is None
-
-
-def test_get_module_variable():
-    """Test that we can robustly peek into jobs for metadata.
-
-    This is independent whether ERT is installed or not
-    """
-    # pylint: disable=protected-access
-    assert not jobs._get_module_variable_if_exists("foo", "bar")
-    assert jobs._get_module_variable_if_exists(
-        "res2df.res2csv", "DESCRIPTION"
-    ).startswith("Convert reservoir simulator input and output")
-    assert not jobs._get_module_variable_if_exists("res2df.res2csv", "NOPE")
-
-
 @pytest.mark.skipif(HAVE_ERT, reason="Tested only when ERT is not available")
 def test_no_erthooks():
     """Test that we can import the hook implementations even when ERT is unavailable."""
     # pylint: disable=redefined-outer-name, unused-import
     # pylint: disable=reimported, import-outside-toplevel
-    from res2df.hook_implementations import jobs  # noqa
+    from res2df.hook_implementations import forward_model_steps  # noqa