resqpy 0.1.5

Python API for working with RESQML files

resqpy: Python API for working with RESQML models

Introduction

This repository contains pure python modules which provide a programming interface (API) for reading, writing, and modifying reservoir models in the RESQML format.

See the full documentation here.

Current capabilities

Specialized classes are only available for a subset of the RESQML high level object classes:

• Grids: IjkGridRepresentation
• Wells: WellboreTrajectoryRepresentation, DeviationSurveyRepresentation, MdDatum, BlockedWellboreRepresentation, WellboreFrameRepresentation, WellboreMarkerFrameRepresentation, WellboreInterpretation, WellboreFeature
• Properties for Grids, Wells etc: ContinuousProperty, DiscreteProperty, CatagoricalProperty, PropertyKind, PropertySet, StringTableLookup
• Surfaces: TriangulatedSetRepresentation, Grid2dRepresentation, PointSetRepresentation, HorizonInterpretation, GeneticBoundaryFeature
• Faults: GridConnectionSetRepresentation, FaultInterpretation, TectonicBoundaryFeature
• Lines: PolylineRepresentation, PolylineSetRepresentation
• Other: TimeSeries, EpcExternalPartReference, various other Interpretation and Feature classes

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

Install from source in "editable" mode with:

pip install -e /path/to/repo/

Contributing

Repository structure

• resqpy: high level modules providing classes for main RESQML object types and high level modification functions
• resqpy/olio: low level modules, not often imported directly by calling code
• tests: unit tests

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.