Jump to content

NEEMP:Options: Difference between revisions

From WebChemistry Wiki
Francesco (talk | contribs)
No edit summary
Francesco (talk | contribs)
No edit summary
Line 9: Line 9:
:;<code>--max-threads N</code>
:;<code>--max-threads N</code>
::use up to N threads to solve EEM system in parallel.
::use up to N threads to solve EEM system in parallel.
:;<code>-m STRING</code>, ;<code>--mode STRING</code>
:;<code>-m</code>, <code>--mode</code> <code>MODE</code>
::set STRING mode for NEEMP. Valid choices are: info, params, charges, cross, cover (required).
::set mode for NEEMP. Valid choices are: info, params, charges, cross, cover (required).
:;<code>-p</code>, <code>--params-method</code> <code>METHOD</code>
::set optimization method used for calculation of parameters. Valid choices are: lr-full, lr-full-brent, de, gm (optional).
:;<code>--sdf-file FILE</code>
:;<code>--sdf-file FILE</code>
::define the structural SDF file (required).
::define the structural SDF file (required).
:;<code>--atom-types-by METHOD</code>
:;<code>--atom-types-by METHOD</code>
::classify atoms according to the METHOD. Valid choices are: Element, ElemBond.
::classify atoms according to the METHOD. Valid choices are: Element, ElemBond or User.
:;<code>--list-omitted-molecules</code>
:;<code>--list-omitted-molecules</code>
::list names of molecules for which we don't have charges or parameters loaded (mode dependent).
::list names of molecules for which we don't have charges or parameters loaded (mode dependent).


'''Options specific to mode params'''
'''Generic options for mode params'''


:;<code>--chg-file FILE</code>
:;<code>--chg-file FILE</code>
Line 24: Line 26:
:;<code>--chg-stats-out-file FILE</code>
:;<code>--chg-stats-out-file FILE</code>
::output charges statistics to FILE (used also by cross mode).
::output charges statistics to FILE (used also by cross mode).
:;<code>--random-seed</code>
::set random seed (used by DE, GM and iterative discarding LR)(optional).
:;<code>--par-out-file FILE</code>
::output the parameters to FILE.
:;<code>-s</code>, <code>--sort-by</code> <code>STAT</code>
::sort solutions by STAT. Valid choices are: R, R2, R_w, spearman, RMSD, RMSD_avg, D_max, D_avg. We strongly advise using R_w for method DE.
:;<code>--check-charges</code>
::warn about molecules with abnormal differences between QM and EEM charges (used also by cross mode).
:;<code>--kappa-max VALUE</code>
:;<code>--kappa-max VALUE</code>
::set maximum value for kappa (required).
::set maximum value for kappa (required).
Line 34: Line 46:
:;<code>-f</code>, ;<code>--fs-only</code>
:;<code>-f</code>, ;<code>--fs-only</code>
::do not use additional accuracy improvement.
::do not use additional accuracy improvement.
:;<code>--par-out-file FILE</code>
::output the parameters to FILE.
:;<code>-d METHOD</code>, ;<code>--discard METHOD</code>
:;<code>-d METHOD</code>, ;<code>--discard METHOD</code>
::perform discarding with METHOD. Valid choices are: iterative, simple and off. Default is off.
::perform discarding with METHOD. Valid choices are: iterative, simple and off. Default is off.
:;<code>-s STAT</code>, ;<code>--sort-by STAT</code>
::sort solutions by STAT. Valid choices are: R, R2, spearman, RMSD, D_max, D_avg.
:;<code>--limit-iters COUNT</code>
:;<code>--limit-iters COUNT</code>
::set the maximum number of iterations for discarding.
::set the maximum number of iterations for discarding.
:;<code>--limit-time HH:MM:SS</code>
:;<code>--limit-time HH:MM:SS</code>
::set the maximum time for discarding in format hours:minutes:seconds.
::set the maximum time for discarding in format hours:minutes:seconds.
:;<code>--check-charges</code>
::warn about molecules with abnormal differences between QM and EEM charges (used also by cross mode).


'''Options specific to mode charges'''
'''Options specific to mode charges'''

Revision as of 15:19, 20 June 2016

This section provides a complete list of NEEMP options. NB: NEEMP is case-sensitive, so pay attention to the keywords syntax.

Generic options

-h, --help
display help page and exit.
--version
display version information and exit.
--max-threads N
use up to N threads to solve EEM system in parallel.
-m, --mode MODE
set mode for NEEMP. Valid choices are: info, params, charges, cross, cover (required).
-p, --params-method METHOD
set optimization method used for calculation of parameters. Valid choices are: lr-full, lr-full-brent, de, gm (optional).
--sdf-file FILE
define the structural SDF file (required).
--atom-types-by METHOD
classify atoms according to the METHOD. Valid choices are: Element, ElemBond or User.
--list-omitted-molecules
list names of molecules for which we don't have charges or parameters loaded (mode dependent).

Generic options for mode params

--chg-file FILE
FILE with ab-initio charges (required)(used also by cross mode).
--chg-stats-out-file FILE
output charges statistics to FILE (used also by cross mode).
--random-seed
set random seed (used by DE, GM and iterative discarding LR)(optional).
--par-out-file FILE
output the parameters to FILE.
-s, --sort-by STAT
sort solutions by STAT. Valid choices are: R, R2, R_w, spearman, RMSD, RMSD_avg, D_max, D_avg. We strongly advise using R_w for method DE.
--check-charges
warn about molecules with abnormal differences between QM and EEM charges (used also by cross mode).


--kappa-max VALUE
set maximum value for kappa (required).
--kappa VALUE
use only one kappa VALUE for parametrization.
--fs-precision VALUE
resolution for the full scan (required).
--kappa-preset PRESET
set kappa-max and fs-precision to safe values. Valid choices are: small, protein.
-f, ;--fs-only
do not use additional accuracy improvement.
-d METHOD, ;--discard METHOD
perform discarding with METHOD. Valid choices are: iterative, simple and off. Default is off.
--limit-iters COUNT
set the maximum number of iterations for discarding.
--limit-time HH:MM:SS
set the maximum time for discarding in format hours:minutes:seconds.

Options specific to mode charges

--par-file FILE
FILE with EEM parameters (required)(used also by cross mode)
--chg-out-file FILE
output charges to FILE (required)