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

.. program:: eon 

=======================
Optional Parameters
=======================

.. include:: ../../common/mpi_execute_options.irst
.. include:: ../../common/file_options.irst
.. include:: ../../common/progress_options.irst


EON App Options
^^^^^^^^^^^^^^^^

.. option:: -scdbase

   Treat the database file as a single-conformer input (when the format is not
   OEB). [Default=true]

.. option:: -fixpka_query

   Apply a neutral pH model to the query molecule. It should be
   set to ``false`` if  :option:`-charges` is set to ``existing``; otherwise EON will fail. [Default=true]

.. option:: -fixpka_dbase

   Apply a neutral pH model to the database molecules. It should be
   set to ``false`` if  :option:`-charges` is set to ``existing``; otherwise EON will fail. [Default=true]

.. option:: -writegrid

   Whether or not to output electrostatic grid when writing to .oeb file. [Default=false]

.. option:: -charges

   Specifies charges to be used on the query and the database. Default
   is to calculate them internally with ``mmff``. The option
   ``-charges existing`` will use precalculated charges that must be
   set in the input files. If ``existing`` is selected and any
   molecule doesn't have charges then EON will default to ``mmff`` for
   those molecules. Both :option:`-fixpka_query` and :option:`-fixpka_dbase`
   should be set to ``false`` if :option:`-charges` is set to ``existing``;
   otherwise EON will fail. [Default=mmff]

.. option:: -num_top_scores

   When potential mode is engaged, the shape and charge overlay will keep this many 
   best hits, and score them all with potential to choose best combo hit. [Default=5]

.. option:: -potential

   Scoring done with shape and potential similarity combo. [Default=false]

.. option:: -scoreonly

   Whether or not to score only or do full overlay. [Default=false]


EON Hitlist Options
^^^^^^^^^^^^^^^^^^^^

.. option:: -besthits <N>

   Keep a hitlist and find best N hits. Zero implies no hitlist, and streaming all
   scored input in the order of appearance. [Default=500]

.. option:: -maxhits <N>

   When this parameter is greater than zero, stop after *N* hits, otherwise find all hits. [Default=0]

.. option:: -rankby

   Score to use when ranking the hitlist.

   ========  ==============================
   Value     Meaning
   ========  ==============================
   ET_pb     Poisson-Boltzmann ET score
   ET_coul   Coulomb ET score
   ET_combo  Combined ET score (default)
   ========  ==============================

   [Default=ET_combo]

.. option:: -cutoff <N>

    Minimum score to keep. [Default=-1.0]

.. option:: -outputquery

   Output query molecule at the beginning of the hits file. [Default=true]

.. option:: -sdTags

   Attach score information to output molecules as SD data. [Default=true]

   [Aliases=**-sdtags**]

.. option:: -nostructs

   Do not output any structures to the hits file. [Default=false]

.. option:: -hitsfile <filename>

   Absolute filename for the output hits file. Must be a valid molecule file.
   Use ``none`` for no hit file output. Overrides the name generated from
   :option:`-prefix`.

.. option:: -reportfile <filename>

   Absolute filename for the report file. Use ``none`` for no report file
   output. Overrides the name generated from :option:`-prefix`.

.. option:: -oformat <extension>

   Format for the output structure file. Legal values:
   ``sdf``, ``mol``, ``mol2``, ``pdb``, ``ent``, ``mmod``, ``oeb``,
   ``sdf.gz``, ``mol.gz``, ``mol2.gz``, ``pdb.gz``, ``ent.gz``,
   ``mmod.gz``, ``oeb.gz``.
   [Default=oeb]

.. option:: -logfile <filename>

   Absolute filename for the log file. Use ``-`` for stdout, ``none`` for no
   log output. Overrides the name generated from :option:`-prefix`.

.. option:: -statusfile <filename>

   Write status information to this file. Use ``none`` for no status file.


ZAP/PB Options
^^^^^^^^^^^^^^^

.. option:: -salt

   Salt concentration (in mol/L) to use in the PB calculation. [Default=0.04]

.. option:: -spacing

   Grid spacing for internal ZAP grid. [Default=0.75]


Omega Conformer Options
^^^^^^^^^^^^^^^^^^^^^^^^

.. option:: -ewindow

   Energy window (kcal/mol) used for conformer selection. [Default=10.0]

.. option:: -rms

   RMS threshold used to identify and remove duplicate conformations.
   [Default=0.3]

.. option:: -sampleHydrogens

   Sample hydrogen positions for hydroxyl (OH), thiol (SH), and amine
   groups during conformer generation. [Default=false]

   [Aliases=**-sampleH**,**-samplehydrogens**]