res2df 1.3.9__py3-none-any.whl → 1.3.10__py3-none-any.whl

res2df/pvt.py

@@ -5,11 +5,12 @@ Data can be extracted from a complete deck or from individual files.
 """
 
 import argparse
-import contextlib
 import logging
 from pathlib import Path
 from typing import cast
 
+# Needed for mypy
+import opm.io
 import pandas as pd
 
 from .common import (
@@ -25,11 +26,6 @@ from .inferdims import DIMS_POS, inject_xxxdims_ntxxx
 from .res2csvlogger import getLogger_res2csv
 from .resdatafiles import ResdataFiles
 
-with contextlib.suppress(ImportError):
-    # Needed for mypy
-    import opm.io
-
-
 logger: logging.Logger = logging.getLogger(__name__)
 
 SUPPORTED_KEYWORDS: list[str] = [
@@ -288,7 +284,7 @@ def fill_reverse_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentPar
     return common_fill_reverse_parser(parser, "PVT", "pvt.inc")
 
 
-def pvt_main(args) -> None:
+def pvt_main(args: argparse.Namespace) -> None:
     """Entry-point for module, for command line utility for Eclipse to CSV"""
     logger = getLogger_res2csv(__name__, vars(args))
     resdatafiles = ResdataFiles(args.DATAFILE)
@@ -320,7 +316,7 @@ def pvt_main(args) -> None:
     )
 
 
-def pvt_reverse_main(args) -> None:
+def pvt_reverse_main(args: argparse.Namespace) -> None:
     """Entry-point for module, for command line utility for CSV to simulator
     :term:`deck`"""
     logger = getLogger_res2csv(__name__, vars(args))
@@ -469,7 +465,7 @@ def df2res_pvtg(dframe: pd.DataFrame, comment: str | None = None) -> str:
         subset["PVTNUM"] = 1
     subset = subset.set_index("PVTNUM").sort_index()
 
-    def _pvtg_pvtnum(dframe):
+    def _pvtg_pvtnum(dframe: pd.DataFrame) -> str:
         """Create string with :term:`include file` contents for
         PVTG-data with a specific PVTNUM"""
         string = ""
@@ -478,7 +474,7 @@ def df2res_pvtg(dframe: pd.DataFrame, comment: str | None = None) -> str:
             string += _pvtg_pvtnum_pg(dframe[dframe.index == p_gas])
         return string + "/\n"
 
-    def _pvtg_pvtnum_pg(dframe):
+    def _pvtg_pvtnum_pg(dframe: pd.DataFrame) -> str:
         """Create string with :term:`include file` contents for
         PVTG-data with a particular gas phase pressure"""
         string = ""
@@ -486,6 +482,7 @@ def df2res_pvtg(dframe: pd.DataFrame, comment: str | None = None) -> str:
         p_gas = dframe.index.to_numpy()[0]
         string += f"{p_gas:20.7f}  "
         for rowidx, row in dframe.reset_index().iterrows():
+            rowidx = cast(int, rowidx)
             indent = "\n" + " " * 22 if rowidx > 0 else ""
             string += (
                 indent
@@ -523,7 +520,7 @@ def df2res_pvdg(dframe: pd.DataFrame, comment: str | None = None) -> str:
             return ""
         subset["PVTNUM"] = 1
 
-    def _pvdg_pvtnum(dframe):
+    def _pvdg_pvtnum(dframe: pd.DataFrame) -> str:
         """Create string with :term:`include file` contents for
         PVDG-data with a specific PVTNUM
 

res2df/res2csv.py

@@ -24,7 +24,7 @@ def get_parser() -> argparse.ArgumentParser:
         "--version", action="version", version=f"%(prog)s {__version__}"
     )
 
-    subparsers = parser.add_subparsers(  # type: ignore
+    subparsers = parser.add_subparsers(
         required=True,
         dest="subcommand",
         parser_class=argparse.ArgumentParser,
@@ -203,9 +203,7 @@ def get_parser() -> argparse.ArgumentParser:
     for submodule, subparser in subparsers_dict.items():
         # Use the submodule's fill_parser() to add the submodule specific
         # arguments:
-        importlib.import_module("res2df." + submodule).fill_parser(  # type: ignore
-            subparser
-        )
+        importlib.import_module("res2df." + submodule).fill_parser(subparser)
 
         # Add empty placeholders, this looks strange but is needed for the
         # ERT forward model frontend, where non-used options must be supplied
@@ -226,7 +224,7 @@ def get_parser() -> argparse.ArgumentParser:
 
 
 def run_subparser_main(
-    args,
+    args: argparse.Namespace,
     submodule: str,
     parser: argparse.ArgumentParser | None = None,
 ) -> None:

res2df/resdatafiles.py

@@ -6,13 +6,7 @@ import os
 from pathlib import Path
 from typing import Any
 
-try:
-    import opm.io
-
-    HAVE_OPM = True
-except ImportError:
-    HAVE_OPM = False
-
+import opm.io
 from resdata.grid import Grid
 from resdata.rd_util import FileMode
 from resdata.resfile import ResdataFile
@@ -22,21 +16,20 @@ from .common import convert_lyrlist_to_zonemap, parse_lyrfile
 
 logger = logging.getLogger(__name__)
 
-if HAVE_OPM:
-    # Default parse option to opm.io for a very permissive parsing
-    OPMIOPARSER_RECOVERY: list[tuple[str, Any]] = [
-        ("PARSE_EXTRA_DATA", opm.io.action.ignore),
-        ("PARSE_EXTRA_RECORDS", opm.io.action.ignore),
-        ("PARSE_INVALID_KEYWORD_COMBINATION", opm.io.action.ignore),
-        ("PARSE_MISSING_DIMS_KEYWORD", opm.io.action.ignore),
-        ("PARSE_MISSING_INCLUDE", opm.io.action.ignore),
-        ("PARSE_MISSING_SECTIONS", opm.io.action.ignore),
-        ("PARSE_RANDOM_SLASH", opm.io.action.ignore),
-        ("PARSE_RANDOM_TEXT", opm.io.action.ignore),
-        ("PARSE_UNKNOWN_KEYWORD", opm.io.action.ignore),
-        ("SUMMARY_UNKNOWN_GROUP", opm.io.action.ignore),
-        ("UNSUPPORTED_*", opm.io.action.ignore),
-    ]
+# Default parse option to opm.io for a very permissive parsing
+OPMIOPARSER_RECOVERY: list[tuple[str, Any]] = [
+    ("PARSE_EXTRA_DATA", opm.io.action.ignore),
+    ("PARSE_EXTRA_RECORDS", opm.io.action.ignore),
+    ("PARSE_INVALID_KEYWORD_COMBINATION", opm.io.action.ignore),
+    ("PARSE_MISSING_DIMS_KEYWORD", opm.io.action.ignore),
+    ("PARSE_MISSING_INCLUDE", opm.io.action.ignore),
+    ("PARSE_MISSING_SECTIONS", opm.io.action.ignore),
+    ("PARSE_RANDOM_SLASH", opm.io.action.ignore),
+    ("PARSE_RANDOM_TEXT", opm.io.action.ignore),
+    ("PARSE_UNKNOWN_KEYWORD", opm.io.action.ignore),
+    ("SUMMARY_UNKNOWN_GROUP", opm.io.action.ignore),
+    ("UNSUPPORTED_*", opm.io.action.ignore),
+]
 
 
 class ResdataFiles:
@@ -52,7 +45,7 @@ class ResdataFiles:
     it should be loaded or served from cache.
     """
 
-    def __init__(self, eclbase):
+    def __init__(self, eclbase: str | Path) -> None:
         # eclbase might be a a Posix path object
         eclbase = str(eclbase)
 
@@ -211,7 +204,7 @@ class ResdataFiles:
         self._rstfile = None
         self._rftfile = None
 
-    def get_zonemap(self, filename=None):
+    def get_zonemap(self, filename: str | None = None) -> dict[int, str]:
         """Return a dictionary from (int) K layers in the simgrid to strings
 
         Typical usage is to map from grid layer to zone names.
@@ -243,15 +236,15 @@ class ResdataFiles:
         if not Path(filename).is_absolute():
             fullpath = Path(self.get_path()) / filename
         else:
-            fullpath = filename
-        if not Path(fullpath).is_file():
+            fullpath = Path(filename)
+        if not fullpath.is_file():
             if filename_defaulted:
                 # No warnings when the default filename is not there.
                 return {}
             logger.warning("Zonefile %s not found, ignoring", fullpath)
             return {}
         lyrlist = parse_lyrfile(fullpath)
-        return convert_lyrlist_to_zonemap(lyrlist)
+        return convert_lyrlist_to_zonemap(lyrlist) or {}
 
 
 def rreplace(pat: str, sub: str, string: str) -> str:

res2df/rft.py

@@ -667,7 +667,7 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
     return parser
 
 
-def rft_main(args) -> None:
+def rft_main(args: argparse.Namespace) -> None:
     """Entry-point for module, for command line utility"""
     logger = getLogger_res2csv(__name__, vars(args))
     if args.DATAFILE.endswith(".RFT"):

res2df/satfunc.py

@@ -14,15 +14,12 @@ TABDIMS or to supply the satnumcount directly to avoid possible bugs.
 """
 
 import argparse
-import contextlib
 import logging
 from pathlib import Path
 
+import opm.io
 import pandas as pd
 
-with contextlib.suppress(ImportError):
-    import opm.io
-
 from .common import (
     comment_formatter,
     handle_wanted_keywords,
@@ -197,7 +194,7 @@ def fill_reverse_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentPar
     return common_fill_reverse_parser(parser, "SWOF, SGOF++", "relperm.inc")
 
 
-def satfunc_main(args) -> None:
+def satfunc_main(args: argparse.Namespace) -> None:
     """Entry-point for module, for command line utility"""
     logger = getLogger_res2csv(__name__, vars(args))
     resdatafiles = ResdataFiles(args.DATAFILE)
@@ -228,7 +225,7 @@ def satfunc_main(args) -> None:
     )
 
 
-def satfunc_reverse_main(args) -> None:
+def satfunc_reverse_main(args: argparse.Namespace) -> None:
     """For command line utility for CSV to resdata"""
     logger = getLogger_res2csv(__name__, vars(args))
     satfunc_df = pd.read_csv(args.csvfile)
@@ -368,7 +365,7 @@ def _df2res_satfuncs(
     subset = subset.set_index("SATNUM").sort_index()
 
     # Make a function that is to be called for each SATNUM
-    def _df2res_satfuncs_satnum(keyword, dframe):
+    def _df2res_satfuncs_satnum(keyword: str, dframe: pd.DataFrame) -> str:
         """Create string with :term:`include file` contents
         for one saturation function for one specific SATNUM"""
         col_headers = RENAMERS[keyword]["DATA"]

res2df/summary.py

@@ -80,7 +80,7 @@ def _ensure_date_or_none(some_date: str | dt.date | None) -> dt.date | None:
     if not some_date:
         return None
     if isinstance(some_date, str):
-        return dateutil.parser.parse(some_date).date()  # type: ignore
+        return dateutil.parser.parse(some_date).date()
     raise TypeError(f"some_date must be a string or a date, got {some_date}")
 
 
@@ -104,7 +104,7 @@ def _crop_datelist(
     Returns:
         list of datetimes.
     """
-    datetimes: list[dt.date] | list[dt.datetime] = []  # type: ignore
+    datetimes: list[dt.date] | list[dt.datetime] = []
     if freq == FREQ_RAW:
         datetimes = summarydates
         datetimes.sort()
@@ -153,9 +153,7 @@ def _fallback_date_roll(rollme: dt.datetime, direction: str, freq: str) -> dt.da
                 return dt.datetime(year=rollme.year, month=rollme.month, day=1)
             return dt.datetime(
                 year=rollme.year, month=rollme.month, day=1
-            ) + dateutil.relativedelta.relativedelta(  # type: ignore
-                months=1
-            )
+            ) + dateutil.relativedelta.relativedelta(months=1)
         return dt.datetime(year=rollme.year, month=rollme.month, day=1)
 
     raise ValueError(
@@ -188,7 +186,7 @@ def _fallback_date_range(start: dt.date, end: dt.date, freq: str) -> list[dt.dat
         enddatetime = dt.datetime.combine(end, dt.datetime.min.time())
         while date <= enddatetime:
             dates.append(date)
-            date += dateutil.relativedelta.relativedelta(months=1)  # type: ignore
+            date += dateutil.relativedelta.relativedelta(months=1)
         return dates
     raise ValueError("Unsupported frequency for datetimes beyond year 2262")
 
@@ -238,7 +236,7 @@ def resample_smry_dates(
 
     # In case freq is an ISO-date(time)-string, interpret as such:
     try:
-        parseddate = dateutil.parser.isoparse(freq)  # type: ignore
+        parseddate = dateutil.parser.isoparse(freq)
         return [parseddate]
     except ValueError:
         # freq is a frequency string or datetime.date (or similar)
@@ -301,7 +299,7 @@ def df(
     params: bool = False,
     paramfile: str | None = None,
     datetime: bool = False,  # A very poor choice of argument name [pylint]
-):
+) -> pd.DataFrame:
     """
     Extract data from UNSMRY as Pandas dataframes.
 
@@ -623,10 +621,7 @@ def _fix_dframe_for_resdata(dframe: pd.DataFrame) -> pd.DataFrame:
             # Do not use pd.Series.apply() here, Pandas would try to convert it to
             # datetime64[ns] which is limited at year 2262.
             dframe["DATE"] = pd.Series(
-                [
-                    dateutil.parser.parse(datestr)  # type: ignore
-                    for datestr in dframe["DATE"]
-                ],
+                [dateutil.parser.parse(datestr) for datestr in dframe["DATE"]],
                 dtype="object",
                 index=dframe.index,
             )
@@ -794,7 +789,7 @@ def fill_reverse_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentPar
     return parser
 
 
-def summary_main(args) -> None:
+def summary_main(args: argparse.Namespace) -> None:
     """Read summary data from disk and write CSV back to disk"""
     logger = getLogger_res2csv(__name__, vars(args))
     eclbase = (
@@ -824,7 +819,7 @@ def summary_main(args) -> None:
     write_dframe_stdout_file(sum_df, args.output, index=True, caller_logger=logger)
 
 
-def summary_reverse_main(args) -> None:
+def summary_reverse_main(args: argparse.Namespace) -> None:
     """Entry point for usage with "csv2res summary" on the command line"""
     logger = getLogger_res2csv(__name__, vars(args))
 

res2df/trans.py

@@ -284,7 +284,7 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
     return parser
 
 
-def trans_main(args):
+def trans_main(args: argparse.Namespace) -> None:
     """This is the command line API"""
     logger = getLogger_res2csv(__name__, vars(args))
     resdatafiles = ResdataFiles(args.DATAFILE)

res2df/version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.3.9'
-__version_tuple__ = version_tuple = (1, 3, 9)
+__version__ = version = '1.3.10'
+__version_tuple__ = version_tuple = (1, 3, 10)
 
 __commit_id__ = commit_id = None

res2df/vfp/__init__.py

@@ -2,7 +2,7 @@
 keywords in Eclipse.
 """
 
-from ._vfp import (  # noqa: F401
+from ._vfp import (
     basic_data,
     basic_data2df,
     basic_data2pyarrow,
@@ -18,3 +18,20 @@ from ._vfp import (  # noqa: F401
     vfp_main,
     vfp_reverse_main,
 )
+
+__all__ = [
+    "basic_data",
+    "basic_data2df",
+    "basic_data2pyarrow",
+    "df",
+    "df2basic_data",
+    "df2res",
+    "df2ress",
+    "dfs",
+    "fill_parser",
+    "fill_reverse_parser",
+    "pyarrow2basic_data",
+    "pyarrow_tables",
+    "vfp_main",
+    "vfp_reverse_main",
+]

res2df/vfp/_vfp.py

@@ -10,19 +10,15 @@ import sys
 from typing import Any
 
 import numpy as np
+
+# Needed for mypy
+import opm.io
 import pandas as pd
 import pyarrow as pa
 
-try:
-    # Needed for mypy
-
-    import opm.io
-
-    # This import is seemingly not used, but necessary for some attributes
-    # to be included in DeckItem objects.
-    from opm.io.deck import DeckKeyword  # noqa: F401
-except ImportError:
-    pass
+# This import is seemingly not used, but necessary for some attributes
+# to be included in DeckItem objects.
+from opm.io.deck import DeckKeyword  # noqa: F401
 
 from ..common import comment_formatter, write_dframe_stdout_file, write_inc_stdout_file
 from ..common import fill_reverse_parser as common_fill_reverse_parser
@@ -484,7 +480,7 @@ def fill_reverse_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentPar
     return common_fill_reverse_parser(parser, "VFPPROD, VFPINJ", "vfp.inc")
 
 
-def vfp_main(args) -> None:
+def vfp_main(args: argparse.Namespace) -> None:
     """Entry-point for module, for command line utility."""
     logger = getLogger_res2csv(__name__, vars(args))
     if args.keyword and args.keyword not in SUPPORTED_KEYWORDS:
@@ -523,7 +519,7 @@ def vfp_main(args) -> None:
             logger.info("Parsed file %s for vfp.df", args.DATAFILE)
 
 
-def vfp_reverse_main(args) -> None:
+def vfp_reverse_main(args: argparse.Namespace) -> None:
     """Entry-point for module, for command line utility for CSV to Eclipse"""
     logger = getLogger_res2csv(__name__, vars(args))
     vfp_df = pd.read_csv(args.csvfile)

res2df/vfp/_vfpcommon.py

@@ -7,22 +7,16 @@ output both in csv format as a pandas DataFrame or in pyarrow and pyarrow.table
 """
 
 import logging
-import numbers
-from typing import Any
 
 import numpy as np
-import pandas as pd
-
-try:
-    # Needed for mypy
 
-    import opm.io
+# Needed for mypy
+import opm.io
+import pandas as pd
 
-    # This import is seemingly not used, but necessary for some attributes
-    # to be included in DeckItem objects.
-    from opm.io.deck import DeckKeyword  # noqa: F401
-except ImportError:
-    pass
+# This import is seemingly not used, but necessary for some attributes
+# to be included in DeckItem objects.
+from opm.io.deck import DeckKeyword  # noqa: F401
 
 from ..common import parse_opmio_deckrecord
 
@@ -56,7 +50,7 @@ def _deckrecord2list(
     keyword: str,
     recordindex: int,
     recordname: str,
-) -> Any | list[float]:
+) -> list[float]:
     """
     Parse an opm.opmcommon_python.DeckRecord belonging to a certain keyword
     and return as list of numbers
@@ -68,14 +62,22 @@ def _deckrecord2list(
                      list index to the "record".
         recordname:  Name of the record
     """
-    record = parse_opmio_deckrecord(record, keyword, "records", recordindex)
+    rec_dict = parse_opmio_deckrecord(record, keyword, "records", recordindex)
 
-    values: Any | list[float]
+    values: list[float]
     # Extract interpolation ranges into lists
-    if isinstance(record.get(recordname), list):
-        values = record.get(recordname)
-    elif isinstance(record.get(recordname), numbers.Number):
-        values = [record.get(recordname)]
+    tmp_val = rec_dict.get(recordname)
+    if tmp_val is None:
+        raise KeyError(f"Missing record '{recordname}' in keyword '{keyword}'")
+    if isinstance(tmp_val, (list, tuple)):
+        try:
+            values = [float(val) for val in tmp_val]
+        except (TypeError, ValueError) as e:
+            raise ValueError(
+                f"Non-numeric value in record '{recordname}' for keyword '{keyword}'"
+            ) from e
+    elif isinstance(tmp_val, (int, float)):
+        values = [float(tmp_val)]
     else:
         raise ValueError(
             f"Keyword {keyword} and recordname {recordname} "

res2df/wcon.py

@@ -1,16 +1,13 @@
 """Extract WCON* from a .DATA file"""
 
 import argparse
-import contextlib
 import datetime
 import logging
 
+# Needed for mypy
+import opm.io
 import pandas as pd
 
-with contextlib.suppress(ImportError):
-    # Needed for mypy
-    import opm.io
-
 from .common import (
     parse_opmio_date_rec,
     parse_opmio_deckrecord,
@@ -85,7 +82,7 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
     return parser
 
 
-def wcon_main(args) -> None:
+def wcon_main(args: argparse.Namespace) -> None:
     """Read from disk and write CSV back to disk"""
     logger = getLogger_res2csv(__name__, vars(args))
     resdatafiles = ResdataFiles(args.DATAFILE)

res2df/wellcompletiondata.py

@@ -34,7 +34,7 @@ class KHUnit(StrEnum):
 
 def df(
     resdatafiles: ResdataFiles,
-    zonemap: dict[int, str],
+    zonemap: dict[int, str] | None = None,
     use_wellconnstatus: bool = False,
     excl_well_startswith: str | None = None,
 ) -> pd.DataFrame:
@@ -48,6 +48,9 @@ def df(
     if other connections are closed. And the KH is summed over open connections
     only.
 
+    If no zonemap is provided, it will be looked for in the default location
+    (the same directory as the DATA file loaded in resdatafiles).
+
     Args:
         resdatafiles; ResdataFiles object
         zonemap: dictionary with layer->zone mapping
@@ -56,7 +59,9 @@ def df(
     Returns:
         pd.DataFrame with one row per unique combination of well, zone and date.
     """
+
     compdat_df = create_compdat_df(resdatafiles, zonemap=zonemap)
+
     if "ZONE" not in compdat_df.columns:
         logger.warning(
             "ZONE column not generated in compdat table. "
@@ -286,7 +291,7 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
     return parser
 
 
-def wellcompletiondata_main(args):
+def wellcompletiondata_main(args: argparse.Namespace) -> None:
     """Entry-point for module, for command line utility"""
     logger = getLogger_res2csv(__name__, vars(args))
 

res2df/wellconnstatus.py

@@ -112,7 +112,7 @@ def fill_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
     return parser
 
 
-def wellconnstatus_main(args):
+def wellconnstatus_main(args: argparse.Namespace) -> None:
     """Entry-point for module, for command line utility"""
     logger = getLogger_res2csv(__name__, vars(args))
     resdatafiles = ResdataFiles(args.DATAFILE)

res2df-1.3.10.dist-info/METADATA

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: res2df
+Version: 1.3.10
+Summary: Convert reservoir simulator input and output to DataFrames
+Author-email: Håvard Berland <havb@equinor.com>
+License-Expression: GPL-3.0-only
+Project-URL: Homepage, https://github.com/equinor/res2df
+Project-URL: Repository, https://github.com/equinor/res2df
+Project-URL: Documentation, https://equinor.github.io/res2df/
+Keywords: energy,subsurface,reservoir,scientific,engineering
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Natural Language :: English
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: resdata>=5.0.0-b0
+Requires-Dist: resfo
+Requires-Dist: networkx
+Requires-Dist: numpy
+Requires-Dist: opm>=2020.10.2
+Requires-Dist: pandas
+Requires-Dist: pyarrow
+Requires-Dist: pyyaml>=5.1
+Requires-Dist: treelib
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: pytest-mock; extra == "tests"
+Requires-Dist: pytest-timeout; extra == "tests"
+Provides-Extra: style
+Requires-Dist: pre-commit; extra == "style"
+Provides-Extra: types
+Requires-Dist: mypy; extra == "types"
+Requires-Dist: types-PyYAML; extra == "types"
+Requires-Dist: types-python-dateutil; extra == "types"
+Requires-Dist: types-setuptools; extra == "types"
+Requires-Dist: types-networkx; extra == "types"
+Requires-Dist: pandas-stubs; extra == "types"
+Provides-Extra: docs
+Requires-Dist: sphinx-autoapi; extra == "docs"
+Requires-Dist: ipython; extra == "docs"
+Requires-Dist: rstcheck; extra == "docs"
+Requires-Dist: setuptools; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-argparse; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Provides-Extra: ert
+Requires-Dist: ert>=10.2.0b13; extra == "ert"
+Dynamic: license-file
+
+[![Publish to PyPI](https://github.com/equinor/res2df/actions/workflows/publish.yml/badge.svg)](https://github.com/equinor/res2df/actions/workflows/publish.yml)
+[![PyPI version](https://img.shields.io/pypi/v/res2df.svg)](https://pypi.org/project/res2df/)
+[![codecov](https://codecov.io/gh/equinor/res2df/graph/badge.svg?token=3sZBGGu5VG)](https://codecov.io/gh/equinor/res2df)
+[![Python 3.11-3.13](https://img.shields.io/badge/python-3.11%20|%203.12%20|%203.13-blue.svg)](https://www.python.org)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+# res2df
+
+res2df is a Pandas DataFrame wrapper around resdata and opm.io, which
+are used to access binary files outputted by reservoir simulators,
+or its input files --- or any other tool outputting to the same data format.
+
+The reverse operation, from a Pandas DataFrame to reservoir simulator include files
+(commonly given the extension ".inc", ".grdecl" etc.) is provided for some of the
+modules.
+
+The package consists of a module pr. datatype, e.g. one module for summary
+files (.UNSMRY), one for completion data etc.
+
+There is a command line frontend for almost all functionality, called
+`res2csv`, which converts the reservoir data to DataFrames, and then dumps
+the dataframes to files in CSV format, and a similar `csv2res` for the
+reverse operation.
+
+For documentation, see <https://equinor.github.io/res2df/>
+
+## License
+
+This library is released under GPLv3.
+
+## Copyright
+
+The code is Copyright Equinor ASA 2019-2021.
+
+Contributions without copyright transfer are welcome.