PetrelPy Documentation

PetrelPy is a CLI tool and library for getting data in and out of Petrel.

Getting started

New to Petrel? This won’t help you. New to petrelpy? Unsure what it can be used for? Check out the getting started guides. They contain an introduction to petrelpy’s CLI features.

User guide

The user guide provides in-depth documentation on library features for petrelpy.

API reference

The reference guide contains a detailed description of the functions, modules, and objects included in petrelpy. The reference describes how the methods work and which parameters can be used.

Contributor’s guide

Spotted a typo in the documentation? Want to add to the codebase? The contributing guidelines will guide you through the process of improving petrelpy.