Clinica Logs Enhacement

[omar-rifai]

A discussion to possibly enhance the current situation with Clinica logs. Please share your ideas below @ghisvail, @alexandreroutier @mdiazmel

For reference, messages in the log file are ranked by severity in the following order:

1. Error
2. Warning <-- by default in logs / stdout
3. Info
4. Debug

How many log files?

1. Historically, third party logs (in particular Nipype logs) were separated from Clinica's main logs. This has recently changed and currently those two logs are found in the clinica.log file)

   • Pros:

     • Single source of information
     • level of verbosity adjusted in parallel for all logs

   • Cons:

     • Nipype logs are too verbose by default (level=info seems only useful for debugging purposes)

   • Ideas:

     • Go back to the separation of Nipype/ clinica logs keeping the verbosity adjusted in parallel

What to display on the console?

1. In previous version of Clinica (pre-0.4.1) all cprint messages (level=info used to be displayed on the console. Currently only cprint messages with level=warning and up are displayed. User can change this behavior with the flag (-v for setting the cursor toinfo ) and (-vv for setting the cursor to debug)

   • Pros:

     • More readable console output

   • Cons:

     • Important progress-related information is not printed by defaut

   • Ideas:

     • Keep defaut to warning and use a progress bar