Skip to main content

resqpy: Python API for working with RESQML models

License Documentation Status Python CI Python version PyPI Status codecov

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 Emma Nesbit (Emma.Nesbit@uk.bp.com)

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.

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! Please feel free to open issues on the GitHub issue tracker, or submit Pull Requests. Instructions with how to set up your own development environment can be found at Development environment setup. Please read the Contributing Guide before submitting patches.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

resqpy-5.2.0.tar.gz (736.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

resqpy-5.2.0-py3-none-any.whl (870.7 kB view details)

Uploaded Python 3

File details

Details for the file resqpy-5.2.0.tar.gz.

File metadata

  • Download URL: resqpy-5.2.0.tar.gz
  • Upload date:
  • Size: 736.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for resqpy-5.2.0.tar.gz
Algorithm Hash digest
SHA256 38d0d7c0378c716e2fe26b47e6e552322603b188e2d20403264b8d6d6fbd51c8
MD5 2a723ea57392310932ca229b048fbdba
BLAKE2b-256 c92ea430fbd497c1f0d4174ccdc4b0fb13a655a8ce8b27da7669e524ed02e4fe

See more details on using hashes here.

Provenance

The following attestation bundles were made for resqpy-5.2.0.tar.gz:

Publisher: ci-publish.yml on bp/resqpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file resqpy-5.2.0-py3-none-any.whl.

File metadata

  • Download URL: resqpy-5.2.0-py3-none-any.whl
  • Upload date:
  • Size: 870.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for resqpy-5.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 585fc9047649a96ac67fc88ef1fafb46d9ed24102a66a159d77804d978246224
MD5 2858e1b21651ca7a002ef34419f7b6d1
BLAKE2b-256 44566488a628c131577cf81a4f80ee545d0f9e2cf3cf28a965b51d1fdf831657

See more details on using hashes here.

Provenance

The following attestation bundles were made for resqpy-5.2.0-py3-none-any.whl:

Publisher: ci-publish.yml on bp/resqpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page