Data

Tools

Indexes

Applications

Experiments

Open Source Science

resdata

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

https://github.com/equinor/resdata

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 109 committers (0.9%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.9%) to scientific vocabulary

Keywords

c eclipse hacktoberfest opm python reservoir

Keywords from Contributors

automatic-differentiation blackoil co2-sequestration compositional finite-volume multiscale porous-media-flow reservoir-simulation
Last synced: 6 months ago · JSON representation

Repository

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

Basic Info
  • Host: GitHub
  • Owner: equinor
  • License: gpl-3.0
  • Language: C++
  • Default Branch: main
  • Homepage:
  • Size: 22.7 MB
Statistics
  • Stars: 113
  • Watchers: 24
  • Forks: 96
  • Open Issues: 33
  • Releases: 103
Topics
c eclipse hacktoberfest opm python reservoir
Created almost 9 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Code of conduct Security

README.md

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 project.

Using

ResData is available on PyPI and can be installed into a Python virtual environment 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 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 during CMake compilation.

In a Python virtual environment, 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 and require that ResData is installed into a Python virtualenv in --editable mode, as described in the 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 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 ```

Owner

  • Name: Equinor
  • Login: equinor
  • Kind: organization

GitHub Events

Total
  • Create event: 12
  • Release event: 5
  • Issues event: 19
  • Watch event: 11
  • Delete event: 7
  • Issue comment event: 27
  • Push event: 46
  • Pull request review comment event: 10
  • Pull request event: 20
  • Pull request review event: 28
  • Fork event: 1
Last Year
  • Create event: 12
  • Release event: 5
  • Issues event: 19
  • Watch event: 11
  • Delete event: 7
  • Issue comment event: 27
  • Push event: 46
  • Pull request review comment event: 10
  • Pull request event: 20
  • Pull request review event: 28
  • Fork event: 1

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 6,669
  • Total Committers: 109
  • Avg Commits per committer: 61.183
  • Development Distribution Score (DDS): 0.629
Past Year
  • Commits: 112
  • Committers: 7
  • Avg Commits per committer: 16.0
  • Development Distribution Score (DDS): 0.241
Top Committers
Name Email Commits
Joakim Hove j****e@g****m 2,474
joaho j****o@e****a 1,598
a152128 a****8@e****a 222
Steinar Foss s****r@u****o 193
Pål Grønås Drange P****R@s****m 190
Jean-Paul Balabanian j****b@s****m 186
Eivind Jahren e****h@e****m 167
jgv j****v@e****a 150
jepebe j****e@u****o 118
Christine Floysand c****o@s****m 112
Markus Fanebust Dregi m****e@s****m 103
Jørgen Kvalsvik j****a@s****m 84
Jean-Paul j****e 78
iLoop2 f****n@m****m 74
Per Røe P****e@n****o 68
Inge Myrseth i****h@n****o 60
masar m****r@e****a 60
Kristian Flikka k****a@g****m 49
Ariel Almendral Vazquez a****l@n****o 47
Zohar Malamant Z****M@e****m 42
Arne Morten Kvarving a****g@s****o 37
eism e****m@e****a 34
Markus Sortland Dregi m****i@g****m 34
Fredrik Gundersen f****n@s****m 32
jepebe G****8 21
Håvard Berland h****b@e****m 21
testbruker t****r@e****a 20
Kjell W. Kongsvik k****o@s****m 19
pasl p****l@e****a 18
Magne Sjaastad m****d@c****m 16
and 79 more...
Committer Domains (Top 20 + Academic)
statoil.com: 17 equinor.com: 14 nr.no: 4 sintef.no: 4 unicus.no: 1 users.noreply.github.co: 1 mac.com: 1 ceetronsolutions.com: 1 yahoo.no: 1 uni.no: 1 be-linrgsn087.be.statoil.no: 1 poware.org: 1 dr-blatt.de: 1 hue.no: 1 tno.nl: 1 iws.uni-stuttgart.de: 1 webstep.no: 1 be-tawapp04.be.statoil.no: 1 localhost.localdomain: 1 be-linapp17.be.statoil.no: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 76
  • Total pull requests: 156
  • Average time to close issues: about 2 years
  • Average time to close pull requests: 9 days
  • Total issue authors: 37
  • Total pull request authors: 15
  • Average comments per issue: 1.61
  • Average comments per pull request: 0.29
  • Merged pull requests: 130
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 11
  • Pull requests: 29
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 6 days
  • Issue authors: 8
  • Pull request authors: 9
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.38
  • Merged pull requests: 22
  • Bot issues: 0
  • Bot pull requests: 1
View more stats
Top Authors
Issue Authors
  • eivindjahren (13)
  • berland (8)
  • pinkwah (6)
  • markusdregi (4)
  • asnyv (3)
  • sondreso (3)
  • andreas-el (3)
  • larsevj (3)
  • edscott (2)
  • alifbe (2)
  • lars-petter-hauge (2)
  • magnesj (2)
  • ManInFez (1)
  • gawilliamsbgs (1)
  • tpradeep (1)
Pull Request Authors
  • eivindjahren (95)
  • larsevj (18)
  • berland (13)
  • andreas-el (9)
  • yngve-sk (5)
  • JHolba (3)
  • sondreso (3)
  • pinkwah (3)
  • GitPaean (1)
  • billcxx (1)
  • kvashchuka (1)
  • ManInFez (1)
  • dependabot[bot] (1)
  • HakonSohoel (1)
  • DanSava (1)
Top Labels
Issue Labels
bug (19) enhancement (2) epic (1) performance (1) good first issue (1) good first C issue (1) difficult (1)
Pull Request Labels
maintenance (6) breaking change (3) enhancement (1) christmas-review (1) dependencies (1) github_actions (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 36,964 last-month
  • Total dependent packages: 7
  • Total dependent repositories: 0
  • Total versions: 18
  • Total maintainers: 1
pypi.org: resdata

Package for reading and writing the fortran result files from reservoir simulators

  • Versions: 18
  • Dependent Packages: 7
  • Dependent Repositories: 0
  • Downloads: 36,964 Last month
Rankings
Dependent packages count: 9.8%
Average: 38.8%
Dependent repos count: 67.9%
Maintainers (1)
statoil-travis
Last synced: 6 months ago

Dependencies

ci/github/setup.py pypi
  • ecl ==
requirements.txt pypi
  • cwrap *
  • future *
  • ninja *
  • numpy *
  • pandas *
  • scikit-build *
  • setuptools *
  • setuptools_scm *
  • six *
  • sphinx *
  • wheel *
setup.py pypi
  • cwrap *
  • functools32 *
  • future *
  • numpy *
  • numpy <=1.16.6
  • pandas *
  • pandas <=0.25.3
  • six *
.github/workflows/style.yml actions
  • actions/checkout v3 composite
.github/workflows/testing.yml actions
  • actions/checkout v2 composite
  • actions/download-artifact v2 composite
  • actions/setup-python v2 composite
  • actions/upload-artifact v2 composite
  • docker://quay.io/pypa/manylinux2014_x86_64 * composite
  • pypa/gh-action-pypi-publish v1.3.1 composite
.github/workflows/windows.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
pyproject.toml pypi