.. odpy documentation master file, created by
   sphinx-quickstart on Thu Jun 11 08:09:06 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

dgbpy framework Documentation
#############################

`dgbpy` is a framework for research and deployment of machine learning models from seismic and well data.

**Installation**

With pipenv - https://docs.pipenv.org::

    pipenv install git+https://github.com/OpendTect/dgbpy.git#egg=dgbpy

With pip - https://pip.pypa.io/en/stable/ ::

    pip3 install git+https://github.com/OpendTect/dgbpy.git

After that just import `dgbpy`:

.. code-block:: python

    import dgbpy

To get the developer version, run::

    git clone --recursive https://github.com/OpendTect/dgbpy.git

**Citing odpy**

Please cite `dgbpy` in your publications if it helps your research.::

    Huck A., and Mogg W., Ibrahim O. dgbpy library for seismic interpretation with deep learning. 2019.

    @misc{dgbpy_2019,
        author       = {A. Huck and W. Mogg and O. Ibrahim},
        title        = {dgbpy library for seismic interpretation with deep learning},
        year         = 2019
    }

.. toctree::
   :maxdepth: 6
   :caption: Contents:

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`