The PyRETIS analysis application¶
The PyRETIS analysis application, pyretisanalyse
, is used to
analyse the results from PyRETIS simulations.
The general syntax for executing is:
pyretisanalyse [-h] [-i INPUT] [-V] [-pyvisa] [-pyvisa-cmp]
where INPUT
is the input file for the analysis. It can be of two types:
A pickle, that can be used with the PyVisA tool, or the
standard input file used by PyRETIS
application with the
settings for the analysis, defined via the
analysis section.
Note
The
INPUT
file for the analysis is created automatically
by running the PyRETIS application. This file is named out.rst
and can be directly used as input for the analysis program.where INPUT
is the input file for the analysis. This file is
similar to the input file to the PyRETIS
application with some differences:
- It contains the actual number of cycles/steps completed, specified by the endcycle keyword.
- It contains the directory from where the simulation was executed, specified by the exe-path keyword.
- It contains the number of particles in the simulation, specified by the npart keyword.
- It contains settings for the analysis, defined via the analysis section.
Note
The
INPUT
file for the analysis is created automatically
by running the PyRETIS application. This file is named out.rst
and can be directly used as input for the analysis program.Input arguments¶
Argument | Description |
---|---|
-h, –help | Show the help message and exit. |
-i INPUT, –input INPUT | Location of the input file containing analysis settings. |
-V, –version | Show the version number and exit. |
-pyvisa, –pyvisa-all | Call the GUI of PyVisA visualization tool. If a pickle has to be loaded, it can be selected as the INPUT file following the -i flag. |
-pyvisa-cmp, –pyvisa-compressor | Call the PyVisA compressor tool and generate a pickle file that can be loaded by the GUI tool. |