https://github.com/equinor/resdata

Software for reading and writing the result files from the Eclipse reservoir simulator.
https://github.com/equinor/resdata

c eclipse hacktoberfest opm python reservoir

Last synced: 13 days ago
JSON representation

Software for reading and writing the result files from the Eclipse reservoir simulator.

• Host: GitHub
• URL: https://github.com/equinor/resdata
• Owner: equinor
• License: gpl-3.0
• Created: 2017-03-16T08:39:13.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-08-07T12:58:41.000Z (3 months ago)
• Last Synced: 2024-08-07T13:28:45.133Z (3 months ago)
• Topics: c, eclipse, hacktoberfest, opm, python, reservoir
• Language: C++
• Homepage:
• Size: 22.4 MB
• Stars: 100
• Watchers: 25
• Forks: 95
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: COPYING
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# ResData

Python package for reading and writing the result files from

reservoir simulators. The file types covered are the

RESTART, INIT, RFT, Summary and GRID files in unified and non-unified, and formatted and unformatted.

ResData officially only supports Linux and macOS. It was initially developed as part of the

[_ert_](http://github.com/Equinor/ert) project.

## Using

[ResData is available on PyPI](https://pypi.org/project/resdata/) and can be installed into a [Python virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments) with `pip`:

```sh

pip install resdata

```

## Building

ResData is a Python project with a C++ extension layer. Most of the functionality is implemented in C++ and uses [cwrap](https://github.com/equinor/cwrap) for binding it to Python.

A C++17-compatible compiler, like GCC 8+ or Clang 11+ is required. Other C++ dependencies are brought in automatically by [Conan](https://conan.io) during [CMake](https://cmake.org) compilation.

In a [Python virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments), run:

```sh

# Fetch directly from GitHub

pip install git+https://github.com/equinor/resdata

# If git-cloned, install local directory in editable mode

pip install --editable .

```

## Running tests

As this codebase contains both Python and C++ code, there are tests for both Python and C++.

### Python tests

These tests use [pytest](https://pytest.org) and require that ResData is installed into a Python virtualenv in `--editable` mode, as described in the [Building](#Building) section.

Ensure that pytest is installed and do the following to 

```sh

# Install pytest

pip install pytest

# Run all tests in the python/tests directory

pytest python/tests

```

### C++ tests

ResData uses a homegrown testing suite as well as [Catch2, 2.x](https://github.com/catchorg/Catch2) which is compiled via CMake and ran using `ctest`.

Ensure that `cmake` and `conan` version 1 is installed.

```sh

# Generate CMake build files into `build/`

cmake -B build .

# Build project

cmake --build build

# Run all tests

ctest --test-dir build

```