.. _oesitehopper_chapter_intro:

********************************************************************************
Introduction
********************************************************************************

The **SiteHopper TK** uses technology from the OpenEye **Shape TK** to compare 
protein binding sites using Shape and Color similarity.

There are two main classes in the toolkit.
:ref:`OESiteHopperDatabase <OESiteHopper_OESiteHopperDatabase>` can be used to search and prepare a set of
:ref:`OEDesignUnit <OEBio_OEDesignUnit>` for search. For each :ref:`OEDesignUnit <OEBio_OEDesignUnit>`,
:ref:`OESiteHopperDatabase <OESiteHopper_OESiteHopperDatabase>` creates a "patch" molecule generated by placing shape atoms
on the molecular surface of the binding site and color atoms on protein atoms
near the binding site.

Once the database is created, the :ref:`OESiteHopperSearch <OESiteHopper_OESiteHopperSearch>` class
can take a query :ref:`OEDesignUnit <OEBio_OEDesignUnit>` and return a set of similar :ref:`OEDesignUnit <OEBio_OEDesignUnit>` objects, each transformed
based on the optimized overlap and scored using a combination of the Shape and Color
Tanimoto calculated via the **Shape TK**.

If running on a Linux machine with a supported Nvidia GPU, the Search can use the
GPU to do a fast pre-screen to speed up the search. See the :ref:`GPU Prerequisites <sitehopper_search_gpu>`
section for more info on GPU requirements.

