res2df 1.1.2__tar.gz → 1.2.1__tar.gz

{res2df-1.1.2 → res2df-1.2.1}/.github/workflows/codecov.yml

@@ -16,12 +16,16 @@ jobs:
       PYTHON: '3.8'
 
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v4
 
     - name: Setup Python
-      uses: actions/setup-python@master
+      uses: actions/setup-python@v5
       with:
         python-version: 3.8
+        cache: "pip"
+        cache-dependency-path: |
+          setup.py
+          test_requirements.txt
 
     - name: Install res2df
       run: |

{res2df-1.1.2 → res2df-1.2.1}/.github/workflows/res2df.yml

@@ -19,17 +19,25 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
-        pandas-version: ['pandas<2', 'pandas>2']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        pandas-version: ['pandas>2']
         include:
           # For one of the Python versions we
           # install the extra dependency ert
           # (in order to not double the job matrix)
+
+          # Only test with pandas < 2 for py38 and py311
+          # No wheels for python3.12 for pandas<2
           - python-version: '3.8'
             install-ert: true
+          - python-version: '3.8'
+            pandas-version: 'pandas<2'
+          - python-version: '3.11'
+            pandas-version: 'pandas<2'
+
     steps:
       - name: Checkout commit locally
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Checkout tags
         # This seems necessary for setuptools_scm to be able to infer
@@ -37,14 +45,18 @@ jobs:
         run: git fetch --unshallow --tags
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+          cache: "pip"
+          cache-dependency-path: |
+            setup.py
+            test_requirements.txt
 
       - name: Install res2df with dependencies
         run: |
           pip install --upgrade pip
-          pip install .
+          pip install ".[tests, docs]"
 
       - name: Install numpy<2 if pandas<2
         if: matrix.pandas-version == 'pandas<2'
@@ -53,21 +65,10 @@ jobs:
       - name: Check pandas version
         run: |
           pip install "${{matrix.pandas-version}}"
-          python -c "import res2df"
 
       - name: Install ert
         if: matrix.install-ert
-        run: pip install .[ert]
-
-      - name: Install test dependencies
-        run: pip install .[tests,docs,types]
-
-      - name: Check code style and typing
-        run: |
-          black --check res2df tests setup.py docs/conf.py
-          flake8 res2df tests
-          isort --check-only --profile black res2df tests
-          mypy res2df
+        run: pip install ".[ert]"
 
       - name: List all installed packages
         run: pip freeze
@@ -117,4 +118,3 @@ jobs:
           python -m pip install --upgrade setuptools wheel twine
           python setup.py sdist bdist_wheel
           twine upload dist/*
-

res2df-1.2.1/.github/workflows/style.yml

@@ -0,0 +1,42 @@
+name: Style
+
+on:
+ push:
+   branches:
+     - master
+     - 'version-**'
+ pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
+
+jobs:
+  check-style:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.12']
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: "pip"
+        cache-dependency-path: |
+          setup.py
+
+    - name: Install res2df with style dependencies
+      run: |
+        pip install ".[style]"
+
+    - name: Run style check
+      if: ${{ always() }}
+      run: |
+        SKIP=no-commit-to-branch pre-commit run --all-files --show-diff-on-failure

res2df-1.2.1/.github/workflows/typing.yml

@@ -0,0 +1,42 @@
+name: Typing
+
+on:
+ push:
+   branches:
+     - master
+     - 'version-**'
+ pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
+
+jobs:
+  check-style:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.12']
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: "pip"
+        cache-dependency-path: |
+          setup.py
+          types_requirements.txt
+
+    - name: Install res2df with types dependencies
+      run: |
+        pip install ".[types]"
+
+    - name: Run mypy
+      run: |
+        mypy res2df

res2df-1.2.1/.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+  - id:  no-commit-to-branch
+    args: ['--branch', 'master']
+  - id: check-yaml
+  - id: debug-statements
+  - id: end-of-file-fixer
+  - id: fix-encoding-pragma
+    args: [--remove]
+  - id: mixed-line-ending
+  - id: trailing-whitespace
+
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.7
+    hooks:
+    - id: ruff
+      args: [ --fix ]
+    - id: ruff-format

{res2df-1.1.2 → res2df-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: res2df
-Version: 1.1.2
+Version: 1.2.1
 Summary: Convert reservoir simulator input and output to DataFrames
 Home-page: http://github.com/equinor/res2df
 Author: Håvard Berland
@@ -9,7 +9,7 @@ License: GPLv3
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: resdata>=4.0.0
+Requires-Dist: resdata>=5.0.0-b0
 Requires-Dist: numpy
 Requires-Dist: opm>=2020.10.2
 Requires-Dist: pandas
@@ -17,16 +17,15 @@ Requires-Dist: pyarrow
 Requires-Dist: pyyaml>=5.1
 Requires-Dist: treelib
 Provides-Extra: tests
-Requires-Dist: black; extra == "tests"
-Requires-Dist: flake8; extra == "tests"
-Requires-Dist: isort; extra == "tests"
-Requires-Dist: mypy; extra == "tests"
 Requires-Dist: networkx; extra == "tests"
-Requires-Dist: pre-commit; 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"
@@ -34,27 +33,28 @@ Provides-Extra: docs
 Requires-Dist: autoapi; extra == "docs"
 Requires-Dist: ipython; extra == "docs"
 Requires-Dist: rstcheck; extra == "docs"
+Requires-Dist: setuptools; extra == "docs"
 Requires-Dist: sphinx<7; 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>=2.38.0-b5; extra == "ert"
+Requires-Dist: ert>=10.2.0b13; extra == "ert"
 
 [![Build Status](https://img.shields.io/github/workflow/status/equinor/res2df/res2df)](https://github.com/equinor/res2df/actions?query=workflow%3Ares2df)
 [![codecov](https://codecov.io/gh/equinor/res2df/graph/badge.svg?token=3sZBGGu5VG)](https://codecov.io/gh/equinor/res2df)
-[![Python 3.8-3.10](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10-blue.svg)](https://www.python.org)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://black.readthedocs.io/)
+[![Python 3.8-3.12](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12-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, 
+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 
+(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

{res2df-1.1.2 → res2df-1.2.1}/README.md

@@ -1,17 +1,17 @@
 [![Build Status](https://img.shields.io/github/workflow/status/equinor/res2df/res2df)](https://github.com/equinor/res2df/actions?query=workflow%3Ares2df)
 [![codecov](https://codecov.io/gh/equinor/res2df/graph/badge.svg?token=3sZBGGu5VG)](https://codecov.io/gh/equinor/res2df)
-[![Python 3.8-3.10](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10-blue.svg)](https://www.python.org)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://black.readthedocs.io/)
+[![Python 3.8-3.12](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12-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, 
+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 
+(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

res2df-1.2.1/SECURITY.md

@@ -0,0 +1,16 @@
+If you discover a security vulnerability in this project, please follow these steps to responsibly disclose it:
+
+1. **Do not** create a public GitHub issue for the vulnerability.
+2. Follow our guideline for Responsible Disclosure Policy at [https://www.equinor.com/about-us/csirt](https://www.equinor.com/about-us/csirt) to report the issue
+
+The following information will help us triage your report more quickly:
+
+- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code (if possible)
+- Impact of the issue, including how an attacker might exploit the issue
+
+We prefer all communications to be in English.

{res2df-1.1.2 → res2df-1.2.1}/ci/testkomodo.sh

@@ -2,10 +2,6 @@ install_test_dependencies () {
   pip install -r test_requirements.txt
 }
 
-install_package () {
-  pip install .[tests,docs]
-}
-
 start_tests () {
   pytest --run-eclipse-simulator
 }

{res2df-1.1.2 → res2df-1.2.1}/docs/glossary.rst

@@ -4,7 +4,7 @@ Glossary
 .. glossary::
 
     reservoir simulator
-        Simulation of reservoir fields come in many forms, but for the purposes of 
+        Simulation of reservoir fields come in many forms, but for the purposes of
         res2df we only consider simulators that take a :term:`deck` as input and produces
         :term:`output files <output file>` such `.UNSRMY`. This includes, OPM flow and Eclipse.
 
@@ -20,7 +20,7 @@ Glossary
     deck
         Refers to inputs passed to reservoir simulators. It may be a :term:`.DATA file` and the
         include files it points to, or it may be a single or several include files.
-        If a deck contains all the information (i.e., keywords) the simulator needs 
+        If a deck contains all the information (i.e., keywords) the simulator needs
         to run the requested simulation, it is defined as complete. Otherwise it is incomplete.
 
     output file

{res2df-1.1.2 → res2df-1.2.1}/docs/introduction.rst

@@ -95,7 +95,7 @@ More documentation on :doc:`usage/trans`.
 ``rft``
 ^^^^^^^
 
-Reads the `.RFT` files which are outputted by the 
+Reads the `.RFT` files which are outputted by the
 :term:`simulator <reservoir simulator>` when
 the `WRFTPLT` keyword is used, with details along wellbores.
 

{res2df-1.1.2 → res2df-1.2.1}/docs/usage/equil.rst

@@ -54,7 +54,7 @@ one meter for compatibility, which you could do by the statements:
 Re-exporting tables to include-files
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-When you are done with the table, you can generate new 
+When you are done with the table, you can generate new
 :term:`include files <include file>` from your modified
 data by issuing
 

{res2df-1.1.2 → res2df-1.2.1}/docs/usage/fipreports-example.txt

@@ -1,4 +1,4 @@
-  REPORT   0     1 JAN 2000 
+  REPORT   0     1 JAN 2000
                                                 =================================
                                                 : FIPZON  REPORT REGION    2    :
                                                 :     PAV =        139.76  BARSA:

{res2df-1.1.2 → res2df-1.2.1}/docs/usage/fipreports.rst

@@ -20,8 +20,3 @@ In this particular example, ``FIPZON`` was selected explicitly, either using the
 through an option to the :func:`res2df.fipreports.df` function.
 
 Using this module is easiest through ``res2csv fipreports``.
-
-
-
-
-

{res2df-1.1.2 → res2df-1.2.1}/docs/usage/grid.rst

@@ -2,8 +2,8 @@ grid
 ----
 
 The grid module will extract static and dynamic cell properties from
-a grid 
-(from the :term:`output files of reservoir simulators <output file>`). 
+a grid
+(from the :term:`output files of reservoir simulators <output file>`).
 Each row in a returned dataframe represents one cell.
 
 Typical usage

{res2df-1.1.2 → res2df-1.2.1}/docs/usage/gruptree.rst

@@ -78,4 +78,3 @@ the dataframe will get additional rows and columns:
 .. csv-table:: Dataframe from GRUPTREE, GRUPNET and WELSPECS
    :file: gruptreenet.csv
    :header-rows: 1
-

{res2df-1.1.2 → res2df-1.2.1}/docs/usage/nnc.rst

@@ -71,4 +71,3 @@ and the contents of the exported file can be:
         30   4   3  31   4   2    0.1 /
         30   4   4  31   4   1    0.1 /
     / -- 4 nnc connections, avg multiplier 0.1
-

{res2df-1.1.2 → res2df-1.2.1}/docs/usage/pvt.rst

@@ -70,7 +70,7 @@ Density values are easier to scale up or down to whatever is needed.
 Re-exporting tables to include files
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-When you are done with the table, you can generate new 
+When you are done with the table, you can generate new
 :term:`include files <include file>` from your modified data by issuing
 
 .. code-block:: python
@@ -84,4 +84,3 @@ and need to be catered for outside res2df.
 
 The last step can also be done using the ``csv2res`` command line utility
 if you dump to CSV from your Python code instead.
-

{res2df-1.1.2 → res2df-1.2.1}/docs/usage/rft.rst

@@ -20,7 +20,7 @@ Eclipse usage
 ^^^^^^^^^^^^^
 
 In order to get RFT files emitted from Eclipse, you need the ``WRFTPLT`` keyword
-in your :term`.DATA file`, example:
+in your :term:`.DATA file`, example:
 
 .. code-block:: console
 
@@ -95,4 +95,3 @@ to represent ICD segments. The corresponding ``SEG*`` data for these ICD segment
 will be joined to the segment they are connected to, and have their ``SEG*`` data
 renamed to ``ICD*``. For understanding your ``ICD*`` data, look at the description of
 the analogue ``SEG*`` data above.
-

{res2df-1.1.2 → res2df-1.2.1}/docs/usage/satfunc.rst

@@ -2,7 +2,7 @@ satfunc
 -------
 
 satfunc will extract saturation functions from :term:`.DATA files <.DATA file>` or from
-:term:`include files <include file>`, these are the keywords ``SWOF``, ``SGOF``, 
+:term:`include files <include file>`, these are the keywords ``SWOF``, ``SGOF``,
 ``SGWFN``, ``SWFN``, ``SOF2``, ``SGFN``, ``SOF3`` and  ``SLGOF``.
 
 The data obtained from one invocation of the satfunc module will be put in one

{res2df-1.1.2 → res2df-1.2.1}/docs/usage/trans.rst

@@ -122,4 +122,3 @@ where this last table can also be exported directly from the command line using
 .. code-block:: console
 
    res2csv trans MYDATADECK.DATA --vectors FIPNUM --nnc --group --output fipnuminterfaces.csv
-

{res2df-1.1.2 → res2df-1.2.1}/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-1.1.2 → res2df-1.2.1}/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