Metadata-Version: 2.1
Name: res2df
Version: 1.2.0
Summary: Convert reservoir simulator input and output to DataFrames
Home-page: http://github.com/equinor/res2df
Author: Håvard Berland
Author-email: havb@equinor.com
License: GPLv3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: resdata>=5.0.0-b0
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: 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>=10.2.0b13; extra == "ert"
Provides-Extra: style
Requires-Dist: pre-commit; extra == "style"
Provides-Extra: tests
Requires-Dist: networkx; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-mock; extra == "tests"
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"

[![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.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,
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.
