petrelpy.cli
============

.. py:module:: petrelpy.cli

.. autoapi-nested-parse::

   Command line tool for working with Petrel input and output formats.



Functions
---------

.. autoapisummary::

   petrelpy.cli.cli
   petrelpy.cli.production
   petrelpy.cli.connection
   petrelpy.cli.perforation
   petrelpy.cli.gslib


Module Contents
---------------

.. py:function:: cli()

   Command line tool for working with Petrel input and output formats.


.. py:function:: production(input: click.Path, output: click.Path, yearly: bool, zip: bool)

   Convert IHS production spreadsheet to Petrel vol format.

   This allows production to be easily imported into Petrel.


.. py:function:: connection(input: click.Path, output: click.Path, heel: click.Path)

   Process well connection file to average geomodel properties.

   This gets well properties from Petrel (in an Eclipse format) into a spreadsheet.


.. py:function:: perforation(input: tuple[click.Path], output: click.Path, header: str, date_col: str, sheetname: str | int)

   Create petrel perforation file.

   Takes csv, excel, or prn files as input.
   Expected columns include: API, Treatment Start Date, start_depth, stop_depth

   Produces .ev (default) or .prn file


.. py:function:: gslib(gslib_file: str, output: str | None, output_format: str)

   Process GSLIB geocellular model file to spreadsheet.

   Defaults to writing a parquet format to ease further manipulation with
   python, but csv is also supported.