Usage¶

Command line interface¶

Quvac has its own small command line interface and after installation provides the following commands:

quvac-simulation
quvac-simulation-parallel
quvac-gridscan
quvac-optimization

All functions have the same calling signature (-h for help):

quvac-simulation [-h] [--input INPUT] [--output OUTPUT] [--wisdom WISDOM]

The difference is in the input file format (see Tutorials section for details):

quvac-simulation requires field, grid and postprocessing parameters.
quvac-simulation-parallel additionally requires a section about parallelization parameters.
quvac-gridscan requires a section about gridscan parameters.
quvac-optimization requires a section about optimization parameters.

Launching scripts directly¶

Python scripts could be launched directly with (make sure to provide correct path to the script):

python src/quvac/simulation.py <args>
python src/quvac/simulation_parallel.py <args>
python src/quvac/cluster/gridscan.py <args>
python src/quvac/cluster/optimization.py <args>

Script arguments are the same as in the previous section:

python src/quvac/simulation.py -i <input_yml_file> -o <output_dir>