.. _enumsites_example:

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

.. program:: enumsites

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

The simplest way to run **EnumSites** is by passing in an unprepped, biounit OEDesignUnit file (oedu) as the input and a fully prepared OEDesignUnit file as a reference.

.. code-block:: bash

   prompt> enumsites -ref 4OBD_AB__DU__E-2-PGNFFQNRP-10.oedu -in 1HHP_AB__DU__biounit.oedu

Here, **EnumSites** will use the biounit OEDesignUnit :file:`1HHP_AB__DU__biounit.oedu` with the :option:`-in` parameter, along with a reference OEDesignUnit
file :file:`4OBD_AB__DU__E-2-PGNFFQNRP-10.oedu` with the :option:`-ref` option, in order to create an OEDesignUnit from :file:`1HHP_AB__DU__biounit.oedu` using
the site defined in the reference structure. The output is a single OEDesignUnit (.oedu): :file:`1HHP_AB_DU_apo_ASP_B-25.oedu`.

Instead of a fully prepared OEDesignUnit file as a reference, one may simply specify the site residues required to define the new site of interest.

So for example:

.. code-block:: bash

   prompt> enumsites -site_residue "ASP:25: :A" -in 1HHP_AB__DU__biounit.oedu


will construct an OEDesignUnit based on enumeration from the same biounit OEDesignUnit file as before (:file:`1HHP_AB__DU__biounit.oedu`), but here the definition of
the site comes from the :option:`-site_residue` option instead of another fully-prepared OEDesignUnit.

To calculate the Iridium classification as a metric of structure quality with ``enumsites``, one must provide the map file that corresponds to
experiment from which the biomolecular structure was derived:

.. code-block:: bash

   prompt> enumsites -site_residue "MET:124: :A" -map 1a29_validation_2fo-fc_map_coef.cif.gz -in 1A29_A__DU__biounit.oedu

Here two OEDesignUnit files (:file:`1A29_A__DU__TFP_A-153.oedu` and :file:`1A29_A__DU__TFP_A-154.oedu`) will be produced from :file:`1A29_A__DU__biounit.oedu` and the site defined
as ``MET:124: :A``, but the Iridium classification can be made since the structure factor CIF file (:file:`1a29_validation_2fo-fc_map_coef.cif.gz`) was passed in through the :option:`-map` option. The two files are resulting
from the two different ligands binding in that site simultaneously.

.. note::

   The :option:`-map` option accepts structure factor CIF files (``.cif``, ``.cif.gz``) as provided by
   :ref:`GetStructure <chapter_getstructure>` and the RCSB, as well as legacy MTZ files (``.mtz``).

To prevent continually over-writing output files, the :option:`-prefix` flag
allows you to give unique names to these files.

.. code-block:: bash

   prompt> enumsites -site_residue "ASP:25: :A" -in 1HHP_AB__DU__biounit.oedu -prefix FOO


will write the output structure into a file named :file:`FOO_1HHP_AB__DU__apo_ASP_A-25.oedu`.
