.. _fastrocs_examples_suite:

##########################
FastROCS Example Suite
##########################

FastROCS comes with a variety of scripts for configuring, reporting,
and debugging. For more details of how to use these examples please see
the :ref:`fastrocs_part_tutorials` section.

.. _section_example_fastrocs_simple_examples:

Simple Examples
============================================================================

.. oe:language:: c++ python java

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`bestshapeoverlay<section_example_fastrocs_bestshapeoverlay>`
        - Database searching with queries.
      * - :ref:`bestshapeoverlaymulticonfquery<section_example_fastrocs_bestshapeoverlaymulticonfquery>`
        - Database searching with every conformer of every query.
      * - :ref:`besttverskyshapeoverlay<section_example_fastrocs_besttverskyshapeoverlay>`
        - Database searching with queries using Tversky similarity scoring.
      * - :ref:`coloroptimization<section_example_fastrocs_coloroptimization>`
        - Optimize over color overlap in addition to shape overlap.
      * - :ref:`customcolorffprep<section_example_fastrocs_customcolorffprep>`
        - Cache custom color atoms onto molecules.
      * - :ref:`implicitmillsdeannorings<section_example_fastrocs_implicitmillsdeannorings>`
        - Run FastROCS with the implicit Mills-Dean color force field, sans rings.
      * - :ref:`rocsmode<section_example_fastrocs_rocsmode>`
        - Turn on ROCS mode.
      * - :ref:`shapedatabasechunker<section_example_fastrocs_shapedatabasechunker>`
        - Split database into chunks.
      * - :ref:`shapedatabaseprep<section_example_fastrocs_shapedatabaseprep>`
        - Prepare OEB file for faster load performance.
      * - :ref:`shapedistancematrix<section_example_fastrocs_shapedistancematrix>`
        - Calculate distance between all molecules in database with themselves.
      * - :ref:`shapeclustering<section_example_fastrocs_shapeclustering>`
        - Cluster database into shape clusters.

.. _section_example_fastrocs_alternative_starts:

Alternative Starts
============================================================================

.. oe:language:: c++ python java

   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`asisstarts<section_example_fastrocs_asisstarts>`
        - Database searching with queries using the As Is starting orientation.
      * - :ref:`inertialatheavyatomstarts<section_example_fastrocs_inertialatheavyatomstarts>`
        - Database searching with queries using the inertial at heavy atoms starting orientation.
      * - :ref:`userinertialstarts<section_example_fastrocs_userinertialstarts>`
        - Database searching with queries using the user inertial starts orientation.

.. _section_example_fastrocs_client_server:

Client-Server
=============

.. oe:language:: c++

   .. note::
 
      Currently there is no C++ based FastROCS TK client example.

.. oe:language:: java

   .. note::
 
      Currently there is no Java based FastROCS TK client example.

.. oe:language:: python
    
   .. list-table::
      :widths: 100 100
      :header-rows: 1

      * - Program
        - Description

      * - :ref:`shapedatabaseserver<section_example_fastrocs_shapedatabaseserver>`
        - Run the FastROCS server.
      * - :ref:`shapedatabaseclient<section_example_fastrocs_shapedatabaseclient>`
        - Send query to specified server.
      * - :ref:`shapedatabaseclienthistogram<section_example_fastrocs_shapedatabaseclienthistogram>`
        - Send query to specified server and print histogram.
      * - :ref:`shapedatabaseisloaded<section_example_fastrocs_shapedatabaseisloaded>`
        - Returns whether the database has completed loading in server:port.
      * - :ref:`multiserverloadbalancing<section_example_fastrocs_multiserverloadbalancing>`
        - Spread database across multiple servers.
      * - :ref:`shapedatabaseproxy<section_example_fastrocs_shapedatabaseproxy>`
        - Tie multiple servers to appear as a single server.
      * - :ref:`shapedatabaseoethrowsetlevel<section_example_fastrocs_shapedatabaseoethrowsetlevel>`
        - Adjust the verbosity of server running on server:port.
