Command line options: Difference between revisions

From The Yambo Project
Jump to navigation Jump to search
No edit summary
No edit summary
Line 19: Line 19:
These options are extremely important to master if you want to use yambo productively.  
These options are extremely important to master if you want to use yambo productively.  
The meaning of several options is clear from the help menu: try a table
The meaning of several options is clear from the help menu: try a table
  $ yambo -F yambo.in_HF -x  
  $ yambo -F yambo.in_HF -x ''Make a Hartree -Fock input file called yambo.in_HF
$ yambo -D ''Summarize the content of the databases in the SAVE folder''
$ yambo -I ../ ''Use a SAVE folder in a directory one level up; run the code''
$ yambo -C MyTest ''Run the code, putting all report, log, plot files inside a folder MyTest'm


others deserve a closer look
Other options deserve a closer look.
===Verbosity===
Yambo uses ''many'' input variables, many of which can be left at their default values. To keep inout files short and manageable, only a few variables appear by default  in the inout file. More advanced variables can be switched on by using the -V verbosity option. These are grouped according to the type of variable. For instance, -V RL switches on variables related to G vector summations, and -V io switches on options related to handling the inout output control. Try:


Here some exercises using -J, -V, -F
$ yambo -o c -V RL    Switches on:
FFTGvecs
$ yambo -o c -V io switches on
DB etc
Unfortunately, -V options must be invoked and changed one at a time. When you are more expert, you may go straight to -V all, which turns on all possible Haifa les. Note that yambo -V all for XXX creates 12244  aria lee so use it with care.
===Job script label===
The best way to keep track of different runs using different parameters is through the - J flag. This inserts a label in all output and report files, and creates a new folder containing any new databases (i.e. The are not written in the SAVE folder). Try:
$ yambo -x -J 5Ry
EXXGvecs = 5 Ry
$ yambo -J 5Ry
$ ls *
Yambo.in
SAVE/
5RY
$ yambo -x -J 10Ry etc
 
===Production example===
$ yambo -F -J -I -O


== Links ==
== Links ==
* [[Tutorials|Back to tutorials menu]]
* [[Tutorials|Back to tutorials menu]]

Revision as of 09:36, 29 March 2017

Uppercase options modify some of the code's default settings. They can be used when launching the code but also when generating input files. To see the list of options, do:

$ yambo -H
Tool: yambo 4.1.2 rev.14024
Description: A shiny pot of fun and happiness [C.D.Hogan] 
-J <opt>	:Job string identifier
-V <opt>	:Input file verbosity
                [opt=RL,kpt,sc,qp,io,gen,resp,all,par]
-F <opt>	:Input file
-I <opt>	:Core I/O directory
-O <opt>	:Additional I/O directory
-C <opt>	:Communications I/O directory
-D		:DataBases properties
-W <opt>	:Wall Time limitation (1d2h30m format)
-Q		:Don't launch the text editor
-M		:Switch-off MPI support (serial run)
-N		:Switch-off OpenMP support (single thread run)
[Lower case options]

These options are extremely important to master if you want to use yambo productively. The meaning of several options is clear from the help menu: try a table

$ yambo -F yambo.in_HF -x Make a Hartree -Fock input file called yambo.in_HF
$ yambo -D Summarize the content of the databases in the SAVE folder
$ yambo -I ../ Use a SAVE folder in a directory one level up; run the code
$ yambo -C MyTest Run the code, putting all report, log, plot files inside a folder MyTest'm

Other options deserve a closer look.

Verbosity

Yambo uses many input variables, many of which can be left at their default values. To keep inout files short and manageable, only a few variables appear by default in the inout file. More advanced variables can be switched on by using the -V verbosity option. These are grouped according to the type of variable. For instance, -V RL switches on variables related to G vector summations, and -V io switches on options related to handling the inout output control. Try:

$ yambo -o c -V RL    Switches on:
FFTGvecs

$ yambo -o c -V io switches on
DB etc

Unfortunately, -V options must be invoked and changed one at a time. When you are more expert, you may go straight to -V all, which turns on all possible Haifa les. Note that yambo -V all for XXX creates 12244 aria lee so use it with care.

Job script label

The best way to keep track of different runs using different parameters is through the - J flag. This inserts a label in all output and report files, and creates a new folder containing any new databases (i.e. The are not written in the SAVE folder). Try:

$ yambo -x -J 5Ry
EXXGvecs = 5 Ry
$ yambo -J 5Ry
$ ls *
Yambo.in
SAVE/
5RY
$ yambo -x -J 10Ry etc

Production example

$ yambo -F -J -I -O

Links