Welcome to resqpy’s documentation¶
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.
resqpy is written and maintained by bp, and is made available under the MIT license as a contribution to the open-source community.
The repository is hosted on GitHub.
User guide
- Getting started
- Tutorials
- Reservoir Modelling with RESQML
- Getting started with the Model class
- Coordinate Reference Systems
- High Level Objects
- Attributes of High Level Objects
- Cellular Grid Basics
- Grid Properties
- Working with a Single Property
- The Units of Measure system
- A first look at Well Objects
- Surface Representations
- Creating a Test Dataset
- Working with the RelPerm class and equinor/pyscal
- Multiprocessing
API Reference¶
RESQML manipulation library.
Model class, roughly equivalent to a RESQML epc file. |
|
RESQML coordinate reference systems. |
|
Creating a derived resqml model from an existing one; mostly grid manipulations. |
|
Grid Connection Set class and related functions. |
|
The Grid Module. |
|
Classes for RESQML objects related to surfaces. |
|
Polyline and PolylineSet classes and associated functions. |
|
Multiprocessing module for running specific functions concurrently. |
|
Organizational object classes: features and interpretations. |
|
Collections of properties for grids, wellbore frames, grid connection sets etc. |
|
Miscellaneous functions for importing from other formats. |
|
Stratigraphy related classes and valid values. |
|
Classes for RESQML objects related to surfaces. |
|
Time series classes and functions. |
|
Unstructured grid and derived classes. |
|
Weights and measures valid units and unit conversion functions. |
|
Classes relating to wells. |
|
Low level supporting modules, mostly providing functions rather than classes. |