NEEMP:Examples: Difference between revisions
No edit summary |
No edit summary |
||
Line 5: | Line 5: | ||
'''NB:''' '''NEEMP is case-sensitive'''. Please follow carefully this section for insight on the correct syntax. Additional information can be found [[NEEMP:Options | here]]. | '''NB:''' '''NEEMP is case-sensitive'''. Please follow carefully this section for insight on the correct syntax. Additional information can be found [[NEEMP:Options | here]]. | ||
=Example 1 | =Example 1= | ||
;./neemp -m info --atom-types-by ElemBond --sdf-file examples/set01.sdf | ;./neemp -m info --atom-types-by ElemBond --sdf-file examples/set01.sdf | ||
Line 13: | Line 13: | ||
[[File:info_mode.png | thumb | 400px | center | '''''Figure 6:''''' Information about structures set ''examples/set01.sdf''. Execution time and loaded molecules number are also printed.]] | [[File:info_mode.png | thumb | 400px | center | '''''Figure 6:''''' Information about structures set ''examples/set01.sdf''. Execution time and loaded molecules number are also printed.]] | ||
=Example 2 | =Example 2= | ||
;./neemp -m cover -sdf-file examples/set02.sdf --par-file examples/Element.par --atom-types-by Element | ;./neemp -m cover -sdf-file examples/set02.sdf --par-file examples/Element.par --atom-types-by Element | ||
Line 22: | Line 22: | ||
[[File:cover_mode2.png | thumb | 400px | center | '''''Figure 7:''''' Complete output for the ''Cover mode'' summarizing information about the input files, molecules set composition and coverage. For more information on this mode refer to [[NEEMP:Modes#Cover (-m cover) | Cover mode]] section.]] | [[File:cover_mode2.png | thumb | 400px | center | '''''Figure 7:''''' Complete output for the ''Cover mode'' summarizing information about the input files, molecules set composition and coverage. For more information on this mode refer to [[NEEMP:Modes#Cover (-m cover) | Cover mode]] section.]] | ||
=Example 3 | =Example 3= | ||
;./neemp -m charges --sdf-file examples/set01.sdf --par-file examples/ElemBond.par --chg-out-file eem_charges --max-threads 8 | ;./neemp -m charges --sdf-file examples/set01.sdf --par-file examples/ElemBond.par --chg-out-file eem_charges --max-threads 8 | ||
Line 33: | Line 33: | ||
For details on ''eem_charges'' output file, see [[NEEMP:files#CHG file | CHG file]] paragraph, as the format is the same. The only different regards the third column, since in this case the '''EEM charges''' are listed in place of the '''ab-initio charges'''. | For details on ''eem_charges'' output file, see [[NEEMP:files#CHG file | CHG file]] paragraph, as the format is the same. The only different regards the third column, since in this case the '''EEM charges''' are listed in place of the '''ab-initio charges'''. | ||
=Example 4 | =Example 4= | ||
;./neemp -m cross --sdf-file examples/set02.sdf --chg-file examples/charges.chg --par-file examples/Element.par --chg-stats-out stats --atom-types-by Element 2> warns > log | ;./neemp -m cross --sdf-file examples/set02.sdf --chg-file examples/charges.chg --par-file examples/Element.par --chg-stats-out stats --atom-types-by Element 2> warns > log | ||
Line 44: | Line 44: | ||
[[File:chg_stats.png | thumb | 900px | center | '''''Figure 8:''''' Close-up from ''stats'' file. Along with statistics for each molecule, ''ab-initio'' charges (3rd column), ''EEM'' charges (4th column) and their difference (5th column) are also printed out. '''NB:''' this type of output file can be obtained via ''params mode'' as well (click [[NEEMP:Examples#Examples 5 - Params mode | here]])]]. | [[File:chg_stats.png | thumb | 900px | center | '''''Figure 8:''''' Close-up from ''stats'' file. Along with statistics for each molecule, ''ab-initio'' charges (3rd column), ''EEM'' charges (4th column) and their difference (5th column) are also printed out. '''NB:''' this type of output file can be obtained via ''params mode'' as well (click [[NEEMP:Examples#Examples 5 - Params mode | here]])]]. | ||
=Example 5 | =Example 5= | ||
;./neemp -m params --sdf-file examples/set01.sdf --chg-file examples/charges.chg --par-out-file new_parameters.par --chg-stats-out-file stats --kappa-preset small | ;./neemp -m params --sdf-file examples/set01.sdf --chg-file examples/charges.chg --par-out-file new_parameters.par --chg-stats-out-file stats --kappa-preset small | ||
Line 54: | Line 54: | ||
For additional information click [[here]]. | For additional information click [[here]]. | ||
=Example 6 | =Example 6= | ||
;./neemp -m params --sdf-file examples/set01.sdf --chg-file examples/charges.chg --kappa-max 1.0 --fs-precision 0.02 --fs-only --sort-by RMSD -vv | ;./neemp -m params --sdf-file examples/set01.sdf --chg-file examples/charges.chg --kappa-max 1.0 --fs-precision 0.02 --fs-only --sort-by RMSD -vv | ||
Line 71: | Line 71: | ||
|} | |} | ||
=Example 7 | =Example 7= | ||
;./neemp -m params --sdf-file examples/set01.sdf --chg-file examples/charges.chg --kappa-preset small --discard simple -v --check-charges --limit-iters 600 --limit-time <nowiki>00:30:00</nowiki> | ;./neemp -m params --sdf-file examples/set01.sdf --chg-file examples/charges.chg --kappa-preset small --discard simple -v --check-charges --limit-iters 600 --limit-time <nowiki>00:30:00</nowiki> | ||
Line 80: | Line 80: | ||
[[File:simple_discard.png | thumb | 800px | center | '''''Figure 11:''''' Abridged output for the simple discard progress. The simple discarding requires as many iterations as the number of molecules in the set, unless the iterations or time limits are reached first. In this case the training set contains only 500 structures so the iteration limit doesn't affect the discarding. The time limit still holds instead. Refer to the [[parametrization paragraph]] for details.]] | [[File:simple_discard.png | thumb | 800px | center | '''''Figure 11:''''' Abridged output for the simple discard progress. The simple discarding requires as many iterations as the number of molecules in the set, unless the iterations or time limits are reached first. In this case the training set contains only 500 structures so the iteration limit doesn't affect the discarding. The time limit still holds instead. Refer to the [[parametrization paragraph]] for details.]] | ||
=Example 8 | =Example 8= | ||
;./neemp -m params -p gm --sdf-file examples/set01.sdf --chg-file examples/charges.chg --om-pop-size 50 -gm-iterations-beg 1000 -gm-iterations-end 500 --random-seed 1234 -vv | ;./neemp -m params -p gm --sdf-file examples/set01.sdf --chg-file examples/charges.chg --om-pop-size 50 -gm-iterations-beg 1000 -gm-iterations-end 500 --random-seed 1234 -vv |
Revision as of 18:15, 20 June 2016
This section shows several use case examples. All of them use only data from examples directory.
NB: NEEMP is case-sensitive. Please follow carefully this section for insight on the correct syntax. Additional information can be found here.
Example 1
- ./neemp -m info --atom-types-by ElemBond --sdf-file examples/set01.sdf
- Prints information about training set, group atoms according to chemical element and bond order.

Example 2
- ./neemp -m cover -sdf-file examples/set02.sdf --par-file examples/Element.par --atom-types-by Element
- Calculate coverage of supplied EEM parameters and molecules set.

Example 3
- ./neemp -m charges --sdf-file examples/set01.sdf --par-file examples/ElemBond.par --chg-out-file eem_charges --max-threads 8
- Compute EEM charges and store them into the file eem_charges. Use up to 8 threads for computation.
For more information on this mode and its output, refer to Charges mode section.
For details on eem_charges output file, see CHG file paragraph, as the format is the same. The only different regards the third column, since in this case the EEM charges are listed in place of the ab-initio charges.
Example 4
- ./neemp -m cross --sdf-file examples/set02.sdf --chg-file examples/charges.chg --par-file examples/Element.par --chg-stats-out stats --atom-types-by Element 2> warns > log
- Perform cross-validation of EEM parameters for atoms grouped by element only. Save standard output into the file log and warnings into the file warns. Moreover outputs charge statistics for each molecule into the file stats.
For more information on this mode click here.

.
Example 5
- ./neemp -m params --sdf-file examples/set01.sdf --chg-file examples/charges.chg --par-out-file new_parameters.par --chg-stats-out-file stats --kappa-preset small
- Performs EEM parametrization, saves parameters into the file new_parameters.par, outputs charge statistics for each molecule into the file stats. Use default settings for k search for small molecules. No discarding is used.
NB: the parameters set file new_parameters.par presents the same identical format and layout as described here.
For additional information click here.
Example 6
- ./neemp -m params --sdf-file examples/set01.sdf --chg-file examples/charges.chg --kappa-max 1.0 --fs-precision 0.02 --fs-only --sort-by RMSD -vv
- Similar to previous example, use custom range for k. Select best parameters according to the RMSD with no iterative refinement (since it can be used only if sorting by R is used). Print k search progress.
Reference to parametrization paragraph if necessary.
Example 7
- ./neemp -m params --sdf-file examples/set01.sdf --chg-file examples/charges.chg --kappa-preset small --discard simple -v --check-charges --limit-iters 600 --limit-time 00:30:00
- Perform simple discarding and print its progress. Issue warning about molecules with abnormal values of statistical descriptors. The duration of the discarding procedure can be at most 600 iterations or 30 minutes (time format HH:MM:SS), whichever is reached first.

Example 8
- ./neemp -m params -p gm --sdf-file examples/set01.sdf --chg-file examples/charges.chg --om-pop-size 50 -gm-iterations-beg 1000 -gm-iterations-end 500 --random-seed 1234 -vv
- Compute parameters for the given molecules in file set01.sdf and ab-initio charges in charges.chg. The chosen optimization method: guided minimization will create 50 vectors (each vector consists of all parameters) and minimized reasonably good ones for 1000 iterations. The best of them will be minimized again, for 500 iterations. A user-defined seed is used and higher level of verbosity is used.
For additional information click here.