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.

About

• Installation
• Contributing to resqpy
• Release notes
• Trademarks

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	Model class, roughly equivalent to a RESQML epc file.
crs	RESQML coordinate reference systems.
derived_model	Creating a derived resqml model from an existing one; mostly grid manipulations.
fault	Grid Connection Set class and related functions.
grid	The Grid Module.
grid_surface	Classes for RESQML objects related to surfaces.
lines	Polyline and PolylineSet classes and associated functions.
multi_processing	Multiprocessing module for running specific functions concurrently.
organize	Organizational object classes: features and interpretations.
property	Collections of properties for grids, wellbore frames, grid connection sets etc.
rq_import	Miscellaneous functions for importing from other formats.
strata	Stratigraphy related classes and valid values.
surface	Classes for RESQML objects related to surfaces.
time_series	Time series classes and functions.
unstructured	Unstructured grid and derived classes.
weights_and_measures	Weights and measures valid units and unit conversion functions.
well	Classes relating to wells.
olio	Low level supporting modules, mostly providing functions rather than classes.

Indices and tables

• Index

• Module Index

• Search Page