.. include:: ../substitutions
.. include:: ../../apps-substitutions

.. _fred_example:

.. program:: fred 

======================
Example Commands
======================

Basic docking example
---------------------

This example docks molecules on a single processor using default parameters.

Input files for 1DWD

   * **receptor.oedu** :
     A receptor file containing the structure of the
     prepared target protein.  (see :ref:`fred_receptor_preparation` section). 

   * **multiconformer_ligands.oeb.gz** :
     Conformationally expanded ligands to dock.
     (see :ref:`fred_ligand_preparation` section).

Command line

   .. code-block:: bash

      prompt> fred -receptor receptor.oedu -dbase multiconformer_ligands.oeb.gz


Output files

   * **fred_docked.oeb.gz** :
     Top 500 scoring molecules of 
     *multiconformer_ligands.oeb.gz* docked into *receptor.oedu*.

   * **fred_undocked.oeb.gz** :
     Molecules of *multiconformer_ligands.oeb.gz* that could
     not be docked into the active site (generally occurs if the molecules are too
     big for the site).  This file will not be present if all molecules were 
     successfully docked to the active site.

   * **fred_score.txt** :
      A tab separated text file containing the name and score of
      each of the top 500 ligands.

   * **fred_report.txt** :
     A text report of the docking process.

   * **fred_settings.param** :
     A text file containing the parameters used for this run.

   * **fred_status.txt** :
     A text file that is written periodically during the run 
     with the status of the run.


MPI docking example
-------------------

This example docks molecules on 4 processors of the host machine.

Input files

   * **receptor.oedu** :
     A receptor file containing the structure of the 
     prepared target protein.  (see :ref:`fred_receptor_preparation` section). 

   * **multiconformer_ligands.oeb.gz** :
     Conformationally expanded ligands to dock.  (see :ref:`fred_ligand_preparation`
     section).


Command line

      .. code-block:: bash

         prompt>fred -mpi_np 4  -receptor receptor.oedu \
                                     -dbase multiconformer_ligands.oeb.gz

Output files

   * **fred_docked.oeb.gz** :
     Top 500 scoring molecules of 
     *multiconformer_ligands.oeb.gz* docked into *receptor.oedu*.

   * **fred_undocked.oeb.gz** :
     Molecules of *multiconformer_ligands.oeb.gz* that could
     not be docked into the active site (generally occurs if the molecules are too
     big for the site).  This file will not be present if all molecules were 
     successfully docked to the active site.

   * **fred_score.txt** :
     A tab separated text file containing the name and score of each of
     the top 500 ligands.

   * **fred_report.txt** :
     A text report of the docking process.

   * **fred_settings.param** :
     A text file containing the parameters used for this run.

   * **fred_status.txt** :
     A text file that is overwritten periodically during the run 
     with the status of the run.