logs#
- s2fft.logs.critical_log(message: str)#
Log a critical message (e.g. core code failures etc).
- Parameters:
message (str) – Message to log.
- s2fft.logs.debug_log(message: str)#
Log a debug message (e.g. for background logs to assist debugging).
- Parameters:
message (str) – Message to log.
- s2fft.logs.info_log(message: str)#
Log an information message (e.g. evidence value printing, run completion etc).
- Parameters:
message (str) – Message to log.
- s2fft.logs.setup_logging(custom_yaml_path: str | None = None)#
Initialise and configure logging.
Should be called at the beginning of code to initialise and configure the desired logging level. Logging levels can be ints in [0,50] where 10 is debug logging and 50 is critical logging.
- Parameters:
custom_yaml_path (string) – Complete pathname of desired yaml logging configuration. If empty will provide default logging config.
- Raises:
ValueError – Raised if logging.yaml is not in ./logs/ directory.
- s2fft.logs.warning_log(message: str)#
Log a warning (e.g. for internal code warnings such as large dynamic ranges).
- Parameters:
message (str) – Warning to log.