Difference between revisions of "Ants running manual"

From Kraken Wiki
Jump to: navigation, search
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Ants]] is run using the command line. The basic syntax is <code>ants [OPTION] INPUT-FILE</code>. Additional parameters may be given as
+
[[Ants]] is executed using the command line. The basic syntax is <code>ants [OPTIONS] INPUT-FILE</code> (Linux) or <code>ants.exe [OPTIONS] INPUT-FILE</code> (Windows). Additional parameters for OPTIONS may be given as
   -c --cerberus   use coupled calculation mode with Cerberus
+
   -c --cerberus   use coupled calculation mode with Cerberus
   -h --help       print this help and exit
+
   -h --help       print this help and exit
   -l --list-input switch on printing of parsed input cards
+
   -l --list-input switch on printing of parsed input cards
     --omp NUM   set number of OpenMP threads
+
     --omp NUM     set number of OpenMP threads
   -p --port       port number to be used with coupled calculation mode with Cerberus
+
   -p --port NUM    port number to be used with coupled calculation mode with Cerberus
   -v --version   print version information and exit
+
    --sparse-cram use sparse CRAM solver
 +
    --new-cram    use new CRAM solver
 +
    --test-only  run only numerics tests
 +
   -v --version     print version information and exit
 +
 
 +
If <code>--omp</code> is omitted, default number of OpenMP threads is used. Therefore, single thread execution is obtained with <code>--omp 1</code> option. The <code>--new-cram</code> is only used together with <code>--sparse-cram</code>.
  
 
[[Category:Ants]]
 
[[Category:Ants]]
 
[[Category:Running manuals]]
 
[[Category:Running manuals]]

Latest revision as of 17:38, 4 February 2024

Ants is executed using the command line. The basic syntax is ants [OPTIONS] INPUT-FILE (Linux) or ants.exe [OPTIONS] INPUT-FILE (Windows). Additional parameters for OPTIONS may be given as

 -c --cerberus    use coupled calculation mode with Cerberus
 -h --help        print this help and exit
 -l --list-input  switch on printing of parsed input cards
    --omp NUM     set number of OpenMP threads
 -p --port NUM    port number to be used with coupled calculation mode with Cerberus
    --sparse-cram use sparse CRAM solver
    --new-cram    use new CRAM solver
    --test-only   run only numerics tests
 -v --version     print version information and exit

If --omp is omitted, default number of OpenMP threads is used. Therefore, single thread execution is obtained with --omp 1 option. The --new-cram is only used together with --sparse-cram.