artist.util

Bundle all classes that implement util functionality in ARTIST.

Submodules

Functions

set_logger_config(→ None)

Set up the logger. Should only need to be done once. Generally, logging should only be done on the master rank.

Package Contents

artist.util.set_logger_config(level: int = logging.INFO, log_file: str | pathlib.Path | None = None, log_to_stdout: bool = True, colors: bool = True) None

Set up the logger. Should only need to be done once. Generally, logging should only be done on the master rank.

Parameters

levelint

The default level for logging. Default is logging.INFO.

log_filestr | Path | None

The file to save the log to.

log_to_stdoutbool

A flag indicating if the log should be printed on stdout. Default is True.

colorsbool

A flag for using colored logs. Default is True.