API Reference

The API for petrelpy is split by format between Petrel file formats such as ev, vol, and prn, the gslib format, Eclipse’s wcf format, and the CLI section.

Petrelpy by file format

Getting data into Petrel

export_vol(wells, outfile[, header])

Export production volumes to Petrel-readable .vol format file.

export_injection_vol(wells, outfile[, header])

Export injection volumes to Petrel-readable .vol format file.

export_perfs_ev(→ None)

Export perforations in ev (event file) format.

export_perfs_prn(→ None)

Export perforations in prn (fixed) format.

write_header(df, fname[, fill_na])

Write header information to a Petrel-readable header file.

read_header(→ pandas.DataFrame)

Read headers from a file.

write_tops(df, fname[, comments, fill_na])

Write top picks to Petrel-readable file.

collect_perfs(→ pandas.DataFrame)

Group perforations by well.

read_production(infile[, yearly])

Get raw data from infile (even if infile is several files).

get_raw_table(→ pandas.DataFrame)

Ingest excel, prn, or csv file.

Using Petrel exports

convert_properties_petrel_to_arc(fin, fout, prop)

Make Midland basin Petrel gslib file Arc-readable.

read_petrel_tops(→ pandas.DataFrame)

Read Petrel tops file.

load_from_petrel(→ dask.dataframe.DataFrame)

Load GSLIB geomodel file.

get_midpoint_cell_columns(geomodel, dir_out)

Find cell columns where UWI-index exists in the geomodel.

load_petrel_tops_file(tops_file)

Load in petrel tops file and return pandas dataframe.

match_well_to_cell(→ pandas.DataFrame)

Give each well in df_wells the i,j,k index of the nearest cell in df_cells.

match_ijz_petrel(geomodel, uwi_to_index, wdir[, zdmax])

Merge geomodel with wells to assign properties to wells.

aggregate_well_properties(→ pandas.DataFrame)

Find average geocellular properties about well midpoint.

get_facies_stats(df[, zonename, faciesname, attrs])

Get aggregated statistics for different facies and zones.

get_facies_histograms(→ tuple[pandas.DataFrame, ...)

Calculate histogram of original oil in place for geomodel by zone, facies, properties.

process_well_connection_file(→ pandas.DataFrame)

Get average properties along the laterals for a well connection file.

process_well_lateral(→ pandas.Series)

Get average properties along the well lateral from the geomodel.

get_wellnames(→ list[str])

Get all the well names from a well connection file.

get_trajectory_geomodel_columns(→ list[str])

Get columns used for well trajectory.

get_trajectory(→ pandas.DataFrame)

Get trajectory for a well from the well connection file.

get_well(file_obj)

Get section of well connection file for well.

get_wellname(→ str)

Get well's name from string.

Command Line Interface

Some documentation for the CLI tools are here (but you’re better off checking Getting started):