resqpy: Python API for working with RESQML models
Introduction
resqpy is a pure python package which provides a programming interface (API) for reading, writing, and modifying reservoir models in the RESQML format. It gives you the ability to work with reservoir models programmatically, without having to know the details of the RESQML standard.
The package is written and maintained by bp, and is made available under the MIT license as a contribution to the open-source community.
resqpy was created by Andy Beer. For enquires about resqpy, please contact Nathan Lane ([email protected])
Documentation
See the complete package documentation on readthedocs.
About RESQML
RESQML™ is an industry initiative to provide open, non-proprietary data exchange standards for reservoir characterization, earth and reservoir models. It is governed by the Energistics consortium.
Resqpy provides specialized classes for a subset of the RESQML high level object classes, as described in the docs. Furthermore, not all variations of these object types are supported; for example, radial IJK grids are not yet catered for, although the RESQML standard does allow for such grids.
It is envisaged that the code base will be expanded to include other classes of object and more fully cover the options permitted by the RESQML standard.
Modification functionality at the moment focuses on changes to grid geometry.
Installation
Resqpy can be installed with pip:
pip install resqpy
Alternatively, to install your working copy of the code in "editable" mode:
pip install -e /path/to/repo/
Contributing
Contributions of all forms are welcome and encouraged! See the Contributing Guide for guidance on how you can contribute, including bug reports, features requests and pull requests.
Repository structure
resqpy: high level modules providing classes for main RESQML object types and high level modification functionsresqpy/olio: low level modules, not often imported directly by calling codetests: unit testsexample_data: small example datasets
Unit tests
Run the test suite locally with:
pytest tests/
Making a release
To make a release at a given commit, simply make a git tag:
# Make a tag
git tag -a v0.0.1 -m "Incremental release with some bugfixes"
# Push tag to github
git push origin v0.0.1
The tag must have the prefix v and have the form MAJOR.MINOR.PATCH.
Following semantic versioning, increment the:
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards compatible manner, and
- PATCH version when you make backwards compatible bug fixes.
47 Oct 16, 2022
7.8k Jan 08, 2023
2 Nov 12, 2021
16 Nov 12, 2022
5 Feb 19, 2022
49 Dec 31, 2022
8 Nov 22, 2022
70 Oct 04, 2022
38.2k Jan 01, 2023
13 Nov 19, 2022
1 Aug 06, 2022
133 Dec 28, 2022
11 Oct 11, 2022
2 Dec 14, 2022
2 Sep 12, 2022
1 Apr 21, 2022
95 Sep 24, 2021
2 Feb 11, 2022
2 Jul 12, 2022
17 Jul 07, 2022