Run ruff format and updated pre-commit on all files

equinor · Aug 14, 2024 · ee06193 · ee06193
1 parent ce97ec5
commit ee06193
Show file tree

Hide file tree

Showing 39 changed files with 9,627 additions and 9,647 deletions.
diff --git a/.github/workflows/res2df.yml b/.github/workflows/res2df.yml
@@ -106,4 +106,3 @@ jobs:
           python -m pip install --upgrade setuptools wheel twine
           python setup.py sdist bdist_wheel
           twine upload dist/*
-
diff --git a/.github/workflows/style.yml b/.github/workflows/style.yml
@@ -40,4 +40,4 @@ jobs:
     - name: Run style check
       if: ${{ always() }}
       run: |
-        SKIP=no-commit-to-branch pre-commit run --all-files --show-diff-on-failure
+        SKIP=no-commit-to-branch pre-commit run --all-files --show-diff-on-failure
diff --git a/.github/workflows/typing.yml b/.github/workflows/typing.yml
@@ -39,4 +39,4 @@ jobs:
 
     - name: Run mypy
       run: |
-        mypy res2df
+        mypy res2df
diff --git a/README.md b/README.md
@@ -7,11 +7,11 @@
 # 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

diff --git a/docs/glossary.rst b/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

diff --git a/docs/introduction.rst b/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.
 

diff --git a/docs/usage/equil.rst b/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
 

diff --git a/docs/usage/fipreports-example.txt b/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:

diff --git a/docs/usage/fipreports.rst b/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``.
-
-
-
-
-
diff --git a/docs/usage/grid.rst b/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

diff --git a/docs/usage/gruptree.rst b/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
-
diff --git a/docs/usage/nnc.rst b/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
-
diff --git a/docs/usage/pvt.rst b/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.
-
diff --git a/docs/usage/rft.rst b/docs/usage/rft.rst
@@ -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.
-
diff --git a/docs/usage/satfunc.rst b/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

diff --git a/docs/usage/trans.rst b/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
-
diff --git a/res2df/__init__.py b/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",

diff --git a/res2df/opmkeywords/readme b/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
-