Welcome to pyKVFinder's documentation!
======================================

Welcome to the **Python-C parallel KVFinder (pyKVFinder)** documentation, this page was built to help you get started with our cavity detection and characterization package.

* `Installation <_installation/index.html>`_
* `Tutorial <_tutorial/index.html>`_
* `API reference <_api_reference/index.html>`_
* `Command-line interface <_cli/index.html>`_
* `GitHub repository <https://github.com/LBC-LNBio/pyKVFinder>`_
* `About <_about/index.html>`_

.. toctree::
   :maxdepth: 1
   :caption: Installation
   :hidden:

   _installation/index
 
.. toctree::
   :maxdepth: 1
   :caption: Tutorial
   :hidden:
   
   _tutorial/index
   
.. toctree::
   :maxdepth: 1
   :caption: API Reference
   :hidden:

   _api_reference/index

.. toctree::
   :maxdepth: 1
   :caption: Command-line interface
   :hidden:

   _cli/index

.. toctree::
    :maxdepth: 1
    :caption: Configuration files
    :hidden:

    vdW radii <_cfg_files/vdw_file_template>
    Custom grid <_cfg_files/box_file_template>
    Hydrophobicity scale <_cfg_files/hydrophobicity_scale_file_template>

.. toctree::
   :maxdepth: 1
   :caption: Citing pyKVFinder
   :hidden:

.. toctree::
   :maxdepth: 1
   :caption: About
   :hidden:

   _about/index