Skip to main content

Python API for working with RESQML models

Project description

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.

Project details


Release history Release notifications | RSS feed

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.1.10.tar.gz (735.3 kB view details)

Uploaded Source

Built Distribution

resqpy-5.1.10-py3-none-any.whl (870.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for resqpy-5.1.10.tar.gz
Algorithm Hash digest
SHA256 097d77b98dc6a13ef53739a1bb597758f8131b0fe8388197c1414380cff25d7e
MD5 6fcd3d3b7d2467dcaee1766ebedafcb8
BLAKE2b-256 f9e81441ca2b52debb9cf56584dc7df096fe9d654f09a639dfe3ca4b53744e04

See more details on using hashes here.

Provenance

The following attestation bundles were made for resqpy-5.1.10.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.1.10-py3-none-any.whl.

File metadata

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

File hashes

Hashes for resqpy-5.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 55358f79825dd4fdabc51e34f0056a2dbba1d517657577d315437c133d5f0761
MD5 459ec7bb40b37ff00b3bd754e89dca52
BLAKE2b-256 1bba2aa64da4c211d7692cf1ed588cc5135d48251a8f5a2753ad0df09db36cd3

See more details on using hashes here.

Provenance

The following attestation bundles were made for resqpy-5.1.10-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.

Supported by

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