.. Fragment Hotspot Maps documentation master file, created by
   sphinx-quickstart on Tue Oct 24 10:05:37 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the Hotspot API's documentation!
=================================================

.. image:: hotspots-api-gh-banner.png

This API is publicly available, it is dependant on the CSD python API - a commercial package.
If you are an academic user, it's likely your institution will have a license. If you are unsure if you have a
license or would like to enquire about purchasing one, please contact support@ccdc.cam.ac.uk


Please note, this is an academic project and we would therefore welcome feedback, contributions and collaborations.
If you have any queries regarding this package please contact us (pcurran@ccdc.cam.ac.uk)!


NB: We recommend installing on a Linux machine. If this isn't possible, be aware that only the LIGSITE method will be
available for the buriedness calculation.



.. toctree::
   :maxdepth: 2
   :caption: Contents:

   tutorial
   calculation_api
   hs_io_api
   result_api
   hs_pharmacophore_api
   hs_docking_api
   hs_utilities_api