3.2.11. Other parameters¶
3.2.11.1. --help, -h
¶
Print the help with all the required (denoted as {R}
) and optional
arguments. The latter change depending on the selected simulation type and
code.
aff3ct -h
Usage: ./bin/aff3ct -C <text> [optional args...]
Simulation parameter(s):
{R} --sim-cde-type, -C <text:including set={BCH|LDPC|POLAR|RA|REP|RS|RSC|RSC_DB|TPC|TURBO|TURBO_DB|UNCODED}>
Select the channel code family to simulate.
--sim-prec, -p <integer:including set={8|16|32|64}>
Specify the representation of the real numbers in the receiver part of the
chain.
--sim-type <text:including set={BFER|BFERI|EXIT}>
Select the type of simulation (or communication chain skeleton).
Other parameter(s):
--Help, -H
Print the help like with the '--help, -h' parameter plus advanced
arguments (denoted as '{A}').
--help, -h
Print the help with all the required (denoted as '{R}') and optional
arguments. The latter change depending on the selected simulation type and
code.
--no-colors
Disable the colors in the shell.
--version, -v
Print informations about the version of the source code and compilation
options.
3.2.11.2. --Help, -H
¶
Print the help like with the --help, -h
parameter plus advanced arguments
(denoted as {A}
).
aff3ct -H
Usage: ./bin/aff3ct -C <text> [optional args...]
Simulation parameter(s):
{R} --sim-cde-type, -C <text:including set={BCH|LDPC|POLAR|RA|REP|RS|RSC|RSC_DB|TPC|TURBO|TURBO_DB|UNCODED}>
Select the channel code family to simulate.
--sim-prec, -p <integer:including set={8|16|32|64}>
Specify the representation of the real numbers in the receiver part of the
chain.
--sim-type <text:including set={BFER|BFERI|EXIT}>
Select the type of simulation (or communication chain skeleton).
Other parameter(s):
--Help, -H
Print the help like with the '--help, -h' parameter plus advanced
arguments (denoted as '{A}').
{A} --except-a2l
Enhance the backtrace when displaying exception. This change the program
addresses into filenames and lines. It may take some seconds to do this
work.
{A} --except-no-bt
Disable the backtrace display when running an exception.
{A} --full-legend
Display the legend with all modules details when launching the simulation.
--help, -h
Print the help with all the required (denoted as '{R}') and optional
arguments. The latter change depending on the selected simulation type and
code.
{A} --keys, -k
Display the parameter keys in the help.
--no-colors
Disable the colors in the shell.
{A} --no-legend
Disable the legend display (remove all the lines beginning by the '#'
character).
--version, -v
Print informations about the version of the source code and compilation
options.
3.2.11.3. --version, -v
¶
Print informations about the version of the source code and compilation options.
aff3ct -v
aff3ct (Linux 64-bit, g++-5.4, AVX2) v2.1.1-48-g1c72c3d
Compilation options:
* Precision: 8/16/32/64-bit
* Polar bit packing: on
* Terminal colors: on
* Backtrace: on
* External strings: on
* MPI: off
* GSL: off
* MKL: off
* SystemC: off
Copyright (c) 2016-2018 - MIT license.
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
3.2.11.4. --keys, -k
¶
Display the parameter keys in the help.
aff3ct -h -k
Usage: ./bin/aff3ct -C <text> [optional args...]
Simulation parameter(s):
{R} --sim-cde-type, -C <text:including set={BCH|LDPC|POLAR|RA|REP|RS|RSC|RSC_DB|TPC|TURBO|TURBO_DB|UNCODED}>
[factory::Launcher::parameters::p+cde-type,C]
Select the channel code family to simulate.
--sim-prec, -p <integer:including set={8|16|32|64}>
[factory::Launcher::parameters::p+prec,p]
Specify the representation of the real numbers in the receiver part of the
chain.
--sim-type <text:including set={BFER|BFERI|EXIT}>
[factory::Launcher::parameters::p+type]
Select the type of simulation (or communication chain skeleton).
Other parameter(s):
--Help, -H
[factory::Launcher::parameters::Help,H]
Print the help like with the '--help, -h' parameter plus advanced
arguments (denoted as '{A}').
--help, -h
[factory::Launcher::parameters::help,h]
Print the help with all the required (denoted as '{R}') and optional
arguments. The latter change depending on the selected simulation type and
code.
--no-colors
[factory::Launcher::parameters::no-colors]
Disable the colors in the shell.
--version, -v
[factory::Launcher::parameters::version,v]
Print informations about the version of the source code and compilation
options.
3.2.11.5. --except-a2l
¶
Enhance the backtrace when displaying exception. This change the program addresses into filenames and lines. It may take some seconds to do this work.
Note
This option works only on Unix based OS and if AFF3CT has been
compiled with debug symbols
(-g
compile flag) and without NDEBUG
macro (-DNDEBUG
flag).
3.2.11.6. --except-no-bt
¶
Disable the backtrace display when running an exception.
3.2.11.7. --no-legend
¶
Disable the legend display (remove all the lines beginning by the #
character).
Tip
Use this option when you want to complete an already existing
simulation result file with new noise points. Pay attention to use >>
instead of >
to redirect the standard output in order to add results at
the end of the file and not overwriting it.
3.2.11.8. --full-legend
¶
Display the legend with all modules details when launching the simulation.
This additional information can help to understand a problem in the simulation. Data can of course be redundant from one module to another.
3.2.11.9. --no-colors
¶
Disable the colors in the shell.