.. geology documentation master file, created by
   sphinx-quickstart on Tue Mar  3 13:38:10 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to DeepField's documentation!
=====================================

`DeepField` is a python-based framework for reservoir engineering.


Contents
========
.. toctree::
   :maxdepth: 4
   :titlesonly:

   quick_start/quick_start
   api/deepfield


Supported keywords
==================

.. note:: Besides of standard keywords, any component supports
          custom keywords with array-like data.

General

* ARRA
* ARRAY
* DISGAS
* EFIL
* EFILE
* EFOR
* EFORM
* ETAB
* FIELD
* GAS
* HFIL
* HFILE
* HUNI
* HUNIS
* INCLUDE
* METRIC
* OIL
* START
* TITLE
* TFIL
* TTAB
* USERFILE
* VAPOIL
* WATER

Grid

* ACTNUM
* DIMENS
* DX
* DY
* DZ
* MAPAXES
* TOPS
* COORD
* DIMENS
* ZCORN
* MINPV

Rock

* PERMX
* PERMY
* PERMZ
* PORO
* KRW
* KRWR
* SGU
* SOGCR
* SOWCR
* SWATINIT
* SWCR
* SWL

States

* PRESSURE
* SGAS
* SOIL
* SWAT
* RS

Tables

* PVTO
* PVDG
* PVTW
* SWOF
* SGOF
* RSVD
* ROCK
* DENSITY

Wells

* wells and groups related keywords from .RSM file
* control keywords from ETAB section
* COMPDAT
* COMPDATL
* COMPDATMD
* GROU
* GROUP
* GRUPTREE
* PERF
* WCONPROD
* WCONINJE
* WELLTRACK
* WELSPECS
* WEFAC
* WFRAC
* WFRACP

Faults

* FAULTS
* MULTFLT

Arithmetics (operations with array-like data)

* EQUALS
* ADD
* MULTIPLY
* COPY