res2df 1.1.1__py2.py3-none-any.whl → 1.2.0__py2.py3-none-any.whl

res2df/__init__.py

@@ -1,9 +1,9 @@
 import importlib
 from typing import List
 
-from .__version__ import __version__
-from .res2csvlogger import getLogger_res2csv
-from .resdatafiles import ResdataFiles
+from .__version__ import __version__ as __version__
+from .res2csvlogger import getLogger_res2csv as getLogger_res2csv
+from .resdatafiles import ResdataFiles as ResdataFiles
 
 SUBMODULES: List[str] = [
     "compdat",

res2df/common.py

@@ -540,17 +540,20 @@ def df2res(
     calling_module = inspect.getmodule(from_module[0])
     if dataframe.empty:
         raise ValueError("Empty dataframe")
-    if consecutive is not None and consecutive in dataframe:
-        if not (
+    if (
+        consecutive is not None
+        and consecutive in dataframe
+        and not (
             min(dataframe[consecutive]) == 1
             and len(dataframe[consecutive].unique()) == max(dataframe[consecutive])
-        ):
-            logger.critical(
-                "%s inconsistent in input dataframe, got the values %s",
-                consecutive,
-                str(dataframe[consecutive].unique()),
-            )
-            raise ValueError
+        )
+    ):
+        logger.critical(
+            "%s inconsistent in input dataframe, got the values %s",
+            consecutive,
+            str(dataframe[consecutive].unique()),
+        )
+        raise ValueError
 
     # "KEYWORD" must always be in the dataframe:
     if "KEYWORD" not in dataframe:
@@ -816,7 +819,7 @@ def stack_on_colnames(
     """
     if not inplace:
         dframe = dframe.copy()
-    tuplecolumns = list(map(lambda x: tuple(x.split(sep)), dframe.columns))
+    tuplecolumns = [tuple(x.split(sep)) for x in dframe.columns]
     if max(map(len, tuplecolumns)) < 2:
         logger.info("No columns to stack")
         return dframe

res2df/compdat.py

@@ -1,16 +1,17 @@
 """Parser and dataframe generator for the keywords:
-  * COMPDAT
-  * COMPLUMP
-  * COMPSEGS
-  * WELOPEN
-  * WELSEGS
-  * WLIST
-  * WSEGAICD
-  * WSEGSICD
-  * WSEGVALV
+* COMPDAT
+* COMPLUMP
+* COMPSEGS
+* WELOPEN
+* WELSEGS
+* WLIST
+* WSEGAICD
+* WSEGSICD
+* WSEGVALV
 """
 
 import argparse
+import contextlib
 import datetime
 import logging
 from typing import Dict, List, Optional, Union
@@ -18,12 +19,9 @@ from typing import Dict, List, Optional, Union
 import numpy as np
 import pandas as pd
 
-try:
+with contextlib.suppress(ImportError):
     # pylint: disable=unused-import
     import opm.io.deck
-except ImportError:
-    # Allow parts of res2df to work without OPM:
-    pass
 
 from .common import (
     get_wells_matching_template,
@@ -276,16 +274,16 @@ def deck2dfs(
     if "KEYWORD_IDX" in wsegvalv_df.columns:
         wsegvalv_df.drop(["KEYWORD_IDX"], axis=1, inplace=True)
 
-    return dict(
-        COMPDAT=compdat_df,
-        COMPSEGS=compsegs_df,
-        WELSEGS=welsegs_df,
-        WELOPEN=welopen_df,
-        WLIST=wlist_df,
-        WSEGSICD=wsegsicd_df,
-        WSEGAICD=wsegaicd_df,
-        WSEGVALV=wsegvalv_df,
-    )
+    return {
+        "COMPDAT": compdat_df,
+        "COMPSEGS": compsegs_df,
+        "WELSEGS": welsegs_df,
+        "WELOPEN": welopen_df,
+        "WLIST": wlist_df,
+        "WSEGSICD": wsegsicd_df,
+        "WSEGAICD": wsegaicd_df,
+        "WSEGVALV": wsegvalv_df,
+    }
 
 
 def expand_welopen(welopen_df: pd.DataFrame, compdat_df: pd.DataFrame) -> pd.DataFrame:
@@ -612,12 +610,14 @@ def expand_wlist(wlist_df: pd.DataFrame) -> pd.DataFrame:
             currentstate[wlist_record["NAME"]] = " ".join(
                 sorted(wlist_record["WELLS"].split())
             )
-        elif wlist_record["ACTION"] in ["ADD", "DEL"]:
-            if wlist_record["NAME"] not in currentstate:
-                raise ValueError(
-                    "WLIST ADD/DEL only works on existing well lists: "
-                    f"{str(wlist_record)}"
-                )
+        elif (
+            wlist_record["ACTION"] in ["ADD", "DEL"]
+            and wlist_record["NAME"] not in currentstate
+        ):
+            raise ValueError(
+                "WLIST ADD/DEL only works on existing well lists: "
+                f"{str(wlist_record)}"
+            )
         if wlist_record["ACTION"] == "ADD":
             currentstate[wlist_record["NAME"]] = " ".join(
                 sorted(
@@ -630,10 +630,8 @@ def expand_wlist(wlist_df: pd.DataFrame) -> pd.DataFrame:
         if wlist_record["ACTION"] == "DEL":
             currentstate[wlist_record["NAME"]] = " ".join(
                 sorted(
-                    list(
-                        set(currentstate[wlist_record["NAME"]].split())
-                        - set(wlist_record["WELLS"].split())
-                    )
+                    set(currentstate[wlist_record["NAME"]].split())
+                    - set(wlist_record["WELLS"].split())
                 )
             )
         if wlist_record["ACTION"] == "MOV":
@@ -641,25 +639,16 @@ def expand_wlist(wlist_df: pd.DataFrame) -> pd.DataFrame:
                 currentstate[wlist_record["NAME"]] = ""
             currentstate[wlist_record["NAME"]] = " ".join(
                 sorted(
-                    list(
-                        set(currentstate[wlist_record["NAME"]].split()).union(
-                            set(wlist_record["WELLS"].split())
-                        )
+                    set(currentstate[wlist_record["NAME"]].split()).union(
+                        set(wlist_record["WELLS"].split())
                     )
                 )
             )
-            for (
-                wlist
-            ) in currentstate.keys():  # pylint: disable=consider-iterating-dictionary
+            for wlist, value in currentstate.items():
                 if wlist == wlist_record["NAME"]:
                     continue
                 currentstate[wlist] = " ".join(
-                    sorted(
-                        list(
-                            set(currentstate[wlist].split())
-                            - set(wlist_record["WELLS"].split())
-                        )
-                    )
+                    sorted(set(value.split()) - set(wlist_record["WELLS"].split()))
                 )
 
     # Dump final state:
@@ -857,11 +846,10 @@ def applywelopen(
     if isinstance(wlist_df, pd.DataFrame):
         if wlist_df.empty:
             wlist_df = None
-        else:
-            if set(wlist_df["ACTION"]) != {"NEW"}:
-                raise ValueError(
-                    "The WLIST dataframe must be expanded through expand_wlist()"
-                )
+        elif set(wlist_df["ACTION"]) != {"NEW"}:
+            raise ValueError(
+                "The WLIST dataframe must be expanded through expand_wlist()"
+            )
 
     welopen_df = welopen_df.astype(object).where(pd.notnull(welopen_df), None)
     welopen_df = expand_wlist_in_welopen_df(welopen_df, wlist_df)
@@ -869,8 +857,8 @@ def applywelopen(
 
     for _, row in welopen_df.iterrows():
         acts_on_well = False
-        if (row["I"] is None and row["J"] is None and row["K"] is None) or (
-            row["I"] <= 0 and row["J"] <= 0 and row["K"] <= 0
+        if all(x is None for x in (row["I"], row["J"], row["K"])) or all(
+            x <= 0 for x in (row["I"], row["J"], row["K"])
         ):
             # Applies to all connections when the completion range
             # is set zero or negative.

res2df/equil.py

@@ -3,33 +3,31 @@ Extract EQUIL from a :term:`.DATA file` as Pandas DataFrame
 """
 
 import argparse
+import contextlib
 import logging
 from pathlib import Path
 from typing import Dict, List, Optional, Union
 
 import pandas as pd
 
-from .common import comment_formatter
-from .common import df2res as common_df2res
-from .common import fill_reverse_parser as common_fill_reverse_parser
 from .common import (
+    comment_formatter,
     generic_deck_table,
     handle_wanted_keywords,
     keyworddata_to_df,
     write_dframe_stdout_file,
     write_inc_stdout_file,
 )
+from .common import df2res as common_df2res
+from .common import fill_reverse_parser as common_fill_reverse_parser
 from .inferdims import DIMS_POS, inject_xxxdims_ntxxx
 from .res2csvlogger import getLogger_res2csv
 from .resdatafiles import ResdataFiles
 
-try:
+with contextlib.suppress(ImportError):
     # pylint: disable=unused-import
     import opm.io
 
-except ImportError:
-    pass
-
 
 logger = logging.getLogger(__name__)
 
@@ -336,7 +334,7 @@ def equil_main(args) -> None:
     else:
         # This might be an include file for which we have to infer/guess
         # EQLDIMS. Then we send it to df() as a string
-        equil_df = df(Path(args.DATAFILE).read_text())
+        equil_df = df(Path(args.DATAFILE).read_text(encoding="utf-8"))
 
     if "EQLNUM" in equil_df and "KEYWORD" in equil_df:
         eqlnums = str(len(equil_df["EQLNUM"].unique()))
@@ -417,12 +415,8 @@ def df2res_equil(dframe: pd.DataFrame, comment: Optional[str] = None) -> str:
         return "-- No data!"
     string = "EQUIL\n"
     string += comment_formatter(comment)
-
-    if "KEYWORD" not in dframe:
-        # Use everything..
-        subset = dframe
-    else:
-        subset = dframe[dframe["KEYWORD"] == "EQUIL"]
+    # Use everything if KEYWORD not in dframe..
+    subset = dframe if "KEYWORD" not in dframe else dframe[dframe["KEYWORD"] == "EQUIL"]
     if "EQLNUM" not in subset:
         if len(subset) != 1:
             logger.critical("If EQLNUM is not supplied, only one row should be given")
@@ -508,11 +502,8 @@ def _df2res_equilfuncs(
     col_headers = RENAMERS[keyword]["DATA"]
 
     string += f"--   {'DEPTH':^21} {col_headers[1]:^21} \n"
-    if "KEYWORD" not in dframe:
-        # Use everything..
-        subset = dframe
-    else:
-        subset = dframe[dframe["KEYWORD"] == keyword]
+    # Use everything if KEYWORD not in dframe..
+    subset = dframe if "KEYWORD" not in dframe else dframe[dframe["KEYWORD"] == keyword]
 
     def _df2res_equilfuncs_eqlnum(dframe: pd.DataFrame) -> str:
         """Create string with :term:`include file` contents

res2df/faults.py

@@ -4,7 +4,9 @@ Extract the contents of the FAULTS keyword into
 a DataFrame
 
 """
+
 import argparse
+import contextlib
 import logging
 from typing import Union
 
@@ -14,15 +16,12 @@ from .common import parse_opmio_deckrecord, write_dframe_stdout_file
 from .res2csvlogger import getLogger_res2csv
 from .resdatafiles import ResdataFiles
 
-try:
+with contextlib.suppress(ImportError):
     # Needed for mypy
 
     # pylint: disable=unused-import
     import opm.io
 
-except ImportError:
-    pass
-
 
 logger = logging.getLogger(__name__)
 

res2df/fipreports.py

@@ -47,7 +47,7 @@ def report_block_lineparser(line: str) -> tuple:
 
     allowed_line_starts = [":CURRENTLY", ":OUTFLOW", ":MATERIAL", ":ORIGINALLY"]
     if not any(line.strip().upper().startswith(x) for x in allowed_line_starts):
-        return tuple()
+        return ()
 
     colonsections = line.split(":")
     to_index: Optional[int]
@@ -172,7 +172,7 @@ def df(prtfile: Union[str, ResdataFiles], fipname: str = "FIPNUM") -> pd.DataFra
 
             if in_report_block:
                 interesting_strings = ["IN PLACE", "OUTFLOW", "MATERIAL"]
-                if not sum([string in line.upper() for string in interesting_strings]):
+                if not sum(string in line.upper() for string in interesting_strings):
                     # Skip if we are not on an interesting line.
                     continue
 

res2df/grid.py

@@ -9,6 +9,7 @@ geometric information. Static data (properties) can be merged from
 the INIT file, and dynamic data can be merged from the Restart (UNRST)
 file.
 """
+
 import argparse
 import datetime
 import fnmatch
@@ -93,13 +94,12 @@ def dates2rstindices(
             if isodate not in availabledates:
                 raise ValueError("date " + str(isodate) + " not found in UNRST file")
             chosendates = [isodate]
-        else:
-            if dates == "first":
-                chosendates = [availabledates[0]]
-            elif dates == "last":
-                chosendates = [availabledates[-1]]
-            elif dates == "all":
-                chosendates = availabledates
+        elif dates == "first":
+            chosendates = [availabledates[0]]
+        elif dates == "last":
+            chosendates = [availabledates[-1]]
+        elif dates == "all":
+            chosendates = availabledates
     elif isinstance(dates, datetime.datetime):
         chosendates = [dates.date()]
     elif isinstance(dates, datetime.date):
@@ -678,10 +678,9 @@ def df2res(
     # Figure out the total number of cells for which we need to export data for:
     global_size = None
     active_cells = None
-    if resdatafiles is not None:
-        if resdatafiles.get_egrid() is not None:
-            global_size = resdatafiles.get_egrid().get_global_size()
-            active_cells = resdatafiles.get_egrid().getNumActive()
+    if resdatafiles is not None and resdatafiles.get_egrid() is not None:
+        global_size = resdatafiles.get_egrid().get_global_size()
+        active_cells = resdatafiles.get_egrid().getNumActive()
 
     if "GLOBAL_INDEX" not in grid_df:
         logger.warning(

res2df/gruptree.py

@@ -2,6 +2,7 @@
 
 import argparse
 import collections
+import contextlib
 import datetime
 import logging
 import sys
@@ -11,13 +12,11 @@ from typing import Any, Dict, List, Optional, Tuple, Union
 import pandas as pd
 import treelib
 
-try:
+with contextlib.suppress(ImportError):
     # Needed for mypy
 
     # pylint: disable=unused-import
     import opm.io
-except ImportError:
-    pass
 
 from .common import (
     parse_opmio_date_rec,
@@ -64,10 +63,7 @@ def df(
     """
 
     date: Optional[datetime.date]
-    if startdate is not None:
-        date = startdate
-    else:
-        date = None
+    date = startdate if startdate is not None else None
 
     if isinstance(deck, ResdataFiles):
         deck = deck.get_deck()
@@ -307,9 +303,8 @@ def edge_dataframe2dict(dframe: pd.DataFrame) -> List[dict]:
     """
     if dframe.empty:
         return [{}]
-    if "DATE" in dframe:
-        if len(dframe["DATE"].unique()) > 1:
-            raise ValueError("Can only handle one date at a time")
+    if "DATE" in dframe and len(dframe["DATE"].unique()) > 1:
+        raise ValueError("Can only handle one date at a time")
     subtrees: dict = collections.defaultdict(dict)
     edges = []  # List of tuples
     for _, row in dframe.iterrows():
@@ -377,12 +372,13 @@ def dict2treelib(name: str, nested_dict: dict) -> treelib.Tree:
     warnings.warn(
         "dict2treelib() is deprecated and will be removed, use tree_from_dict()",
         FutureWarning,
+        stacklevel=1,
     )
 
     tree = treelib.Tree()
     tree.create_node(name, name)
-    for child in nested_dict.keys():
-        tree.paste(name, dict2treelib(child, nested_dict[child]))
+    for child, value in nested_dict.items():
+        tree.paste(name, dict2treelib(child, value))
     return tree
 
 
@@ -426,7 +422,7 @@ def prettyprint(dframe: pd.DataFrame) -> str:
     BRANPROP trees"""
     output = ""
     for date in dframe["DATE"].dropna().unique():
-        df_date = dframe[dframe.DATE == date]
+        df_date = dframe[date == dframe.DATE]
         output += "Date: " + pd.to_datetime(date).strftime("%Y-%m-%d") + "\n"
 
         for treetype in ["GRUPTREE", "BRANPROP"]:

res2df/hook_implementations/jobs.py

@@ -3,14 +3,10 @@ import sys
 from pathlib import Path
 
 try:
-    from ert.shared.plugins.plugin_manager import hook_implementation
-    from ert.shared.plugins.plugin_response import plugin_response
+    from ert import plugin as ert_plugin  # type: ignore
 except ModuleNotFoundError:
-    # ert is not installed - use dummy/transparent function decorators.
-    def hook_implementation(func):
-        return func
-
-    def plugin_response(plugin_name):  # pylint: disable=unused-argument
+    # ert is not installed - use dummy/transparent function decorator:
+    def ert_plugin(name: str = ""):
         def decorator(func):
             return func
 
@@ -28,8 +24,7 @@ def _get_jobs_from_directory(directory):
     return {path.name: str(path) for path in all_files}
 
 
-@hook_implementation
-@plugin_response(plugin_name="res2df")
+@ert_plugin(name="res2df")
 def installable_jobs():
     return _get_jobs_from_directory("config_jobs")
 
@@ -43,8 +38,7 @@ def _get_module_variable_if_exists(module_name, variable_name, default=""):
     return getattr(script_module, variable_name, default)
 
 
-@hook_implementation
-@plugin_response(plugin_name="res2df")
+@ert_plugin(name="res2df")
 def job_documentation(job_name):
     res2df_jobs = set(installable_jobs().data.keys())
     if job_name not in res2df_jobs:

res2df/inferdims.py

@@ -3,21 +3,20 @@ Support module for inferring EQLDIMS and TABDIMS from incomplete
 reservoir simulator decks (typically single include-files)
 """
 
+import contextlib
 import logging
 from typing import Dict, Optional, Union
 
-try:
+with contextlib.suppress(ImportError):
     import opm.io
-except ImportError:
     # Let parts of res2df work without OPM:
-    pass
 
 from .resdatafiles import ResdataFiles
 
 logger = logging.getLogger(__name__)
 
 # Constants to use for pointing to positions in the xxxDIMS keyword
-DIMS_POS: Dict[str, int] = dict(NTPVT=1, NTSFUN=0, NTEQUL=0)
+DIMS_POS: Dict[str, int] = {"NTPVT": 1, "NTSFUN": 0, "NTEQUL": 0}
 
 
 def guess_dim(deckstring: str, dimkeyword: str, dimitem: int = 0) -> int:
@@ -41,12 +40,10 @@ def guess_dim(deckstring: str, dimkeyword: str, dimitem: int = 0) -> int:
 
     if dimkeyword not in ["TABDIMS", "EQLDIMS"]:
         raise ValueError("Only supports TABDIMS and EQLDIMS")
-    if dimkeyword == "TABDIMS":
-        if dimitem not in [0, 1]:
-            raise ValueError("Only support item 0 and 1 in TABDIMS")
-    if dimkeyword == "EQLDIMS":
-        if dimitem not in [0]:
-            raise ValueError("Only item 0 in EQLDIMS can be estimated")
+    if dimkeyword == "TABDIMS" and dimitem not in [0, 1]:
+        raise ValueError("Only support item 0 and 1 in TABDIMS")
+    if dimkeyword == "EQLDIMS" and dimitem not in [0]:
+        raise ValueError("Only item 0 in EQLDIMS can be estimated")
 
     # A less than res2df-standard permissive opm.io, when using
     # this one opm.io will fail if there are extra records
@@ -117,12 +114,10 @@ def inject_dimcount(
     assert dimvalue > 0, "dimvalue must be larger than zero"
     if dimkeyword not in ["TABDIMS", "EQLDIMS"]:
         raise ValueError("Only supports TABDIMS and EQLDIMS")
-    if dimkeyword == "TABDIMS":
-        if dimitem not in [0, 1]:
-            raise ValueError("Only support item 0 and 1 in TABDIMS")
-    if dimkeyword == "EQLDIMS":
-        if dimitem not in [0]:
-            raise ValueError("Only item 0 in EQLDIMS can be injected")
+    if dimkeyword == "TABDIMS" and dimitem not in [0, 1]:
+        raise ValueError("Only support item 0 and 1 in TABDIMS")
+    if dimkeyword == "EQLDIMS" and dimitem not in [0]:
+        raise ValueError("Only item 0 in EQLDIMS can be injected")
 
     if dimkeyword in deckstr:
         if not nowarn:

res2df/nnc.py

@@ -73,7 +73,7 @@ def df(
         data=[egrid_grid.get_ijk(global_index=int(x) - 1) for x in nnc1],
     )
     # Returned indices from get_ijk are zero-based, convert to 1-based indices
-    nnc1_df[idx_cols1] = nnc1_df[idx_cols1] + 1
+    nnc1_df[idx_cols1] += 1
 
     # Grid indices for second cell in cell pairs
     nnc2 = egrid_file["NNC2"][0].numpy_view().reshape(-1, 1)
@@ -88,7 +88,7 @@ def df(
         columns=idx_cols2,
         data=[egrid_grid.get_ijk(global_index=int(x) - 1) for x in nnc2],
     )
-    nnc2_df[idx_cols2] = nnc2_df[idx_cols2] + 1
+    nnc2_df[idx_cols2] += 1
 
     # Obtain transmissibility value, corresponding to the cell pairs above.
     tran = init_file["TRANNNC"][0].numpy_view().reshape(-1, 1)

res2df/opmkeywords/readme

@@ -1,6 +1,5 @@
 This directory contains JSON files downloaded from
 https://github.com/OPM/opm-common/tree/master/src/opm/parser/eclipse/share/keywords/000_Eclipse100
 
-When a new keyword is to be supported by res2df, add it in 
+When a new keyword is to be supported by res2df, add it in
 runmetoupdate.sh AND add it to the list of supported keywords in common.py
-

res2df/parameters.py

@@ -81,7 +81,7 @@ def load_parameterstxt(filename: Union[str, Path]) -> Dict[str, Any]:
                 index_col=False,
             )
         except pd.errors.ParserWarning as txt_exc:
-            raise pd.errors.ParserError(txt_exc)
+            raise pd.errors.ParserError(txt_exc) from txt_exc
 
     return dframe.set_index("KEY")["VALUE"].to_dict()
 

res2df/pillars.py

@@ -235,10 +235,7 @@ def compute_pillar_contacts(
     assert 0 <= sgascutoff <= 1
 
     # assert datestr is None or in ISO-8601 format
-    if datestr:
-        atdatestr = "@" + datestr
-    else:
-        atdatestr = ""
+    atdatestr = "@" + datestr if datestr else ""
 
     # Non-user servicable parameter, for GOC computation
     # we require cells at the contact to contain a minute saturation