Command Line Arguments#
There are several command line arguments that can control the behavior of Einsums. This is the documentation for these arguments.
Basic Arguments#
- --einsums:log:level <level>#
Set the level to see in the logger. Lower values provide more information. By default, it is set to 3 for the release build and 2 for the debug build.
0: Tracing messages. Very verbose.
1: Debugging messages.
2: Information messages
3: Warnings.
4: Errors.
5: Critical errors.
Added in version 1.0.0.
Changed in version 1.1.0: This option now also sets the HIP log level if Einsums was built with GPU support.
Changed in version 2.0.0: This option no longer sets the HIP log level. Use the
AMD_LOG_LEVEL
environment variable. This option’s name has also been changed.
- --einsums:log:destination [cerr | cout]#
Set whether the logger will log to standard output or standard error.
Added in version 1.0.0.
Changed in version 2.0.0: This option’s name has been changed.
- --einsums:profile:no-report#
Tells Einsums not to output the profiling information.
Added in version 1.0.0.
Changed in version 2.0.0: This option’s name has been changed.
- --einsums:profile:filename#
The name of the file for the profiler output.
Added in version 1.0.0.
Changed in version 2.0.0: This option’s name has been changed.
- --einsums:buffer-size#
The amount of memory Einsums is allowed to use. It takes a string containing a number and units. The units are either bytes or words. See
memory_string
for more information.Added in version 1.0.0.
- --einsums:gpu-buffer-size#
The amount of memory Einsums is allowed to use on the GPU. It takes a string containing a number and units. The units are either bytes or words. See
memory_string
for more information.Added in version 1.0.0.
Advanced Arguments#
- --einsums:debug:no-install-signal-handlers#
Tells Einsums not to install its custom signal handlers.
Added in version 1.0.0.
Changed in version 2.0.0: This option’s name has been changed.
- --einsums:debug:no-attach-debugger#
Tells Einsums not to allow users the ability to attach a debugger when an error is detected.
Added in version 1.0.0.
Changed in version 2.0.0: This option’s name has been changed.
- --einsums:debug:no-diagnostics-on-terminate#
When present, Einsums won’t print extra diagnostics on termination.
Added in version 1.0.0.
Changed in version 2.0.0: This option’s name has been changed.
- --einsums:log:format#
A format string used for the logger output.
Added in version 1.0.0.
Changed in version 2.0.0: This option’s name has been changed.
- --einsums:profiler:no-append#
If present, the profiling information will be appended to the profiling file. Otherwise, the profiling file will be overwritten.
Added in version 1.0.0.
Changed in version 2.0.0: This option’s name has been changed.