.. 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.

odpy framework Documentation
###########

`odpy` is a framework for research and deployment that allows for basic interactions with the OpendTect software and database

* Locates/set the path to the OpendTect installation
* Locates/set the path to the OpendTect database
* Complements h5py for an easier manipulation of hdf5 attributes
* Easy loading of well logs from the OpendTect database


**Installation**

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

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

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

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

After that just import `odpy`:

.. code-block:: python

    import odpy

To get the developer version, run::

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

**Citing odpy**

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

    Huck A., and Ibrahim O. odpy library for OpendTect access. 2019.

    @misc{odpy_2019,
        author       = {A. Huck and O. Ibrahim},
        title        = {odpy library for OpendTect access},
        year         = 2019
   }

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

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

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