Developers Documentation

These pages contain important background information for developers of the DSP-TOOLS code repository.

Please read the README first.

Custom Set-Up

Log File Location

The log files are by default saved in ~/.dsp-tools/logs/. Every DSP-TOOLS run creates a new log file. If you prefer 1 single log file across all DSP-TOOLS runs, in the current working directory, then set the following variable in an .env file:

DSP_TOOLS_SAVE_ADDITIONAL_LOG_FILE_IN_CWD=true

Variable Values in Tracebacks

The tracebacks in the log files do not contain the values of the variables. If you need these values to debug a problem, then set the following variable in an .env file:

DSP_TOOLS_LOG_VARIABLE_VALUES=true

The log files then can contain passwords, tokens and research data. Remove the variable after debugging, and delete the log files that you do not need.