Skip to content

epymorph.log.file

Logging epymorph simulations to a file.

file_log 

file_log(
    log_file: str = "debug.log",
    log_level: str | int = DEBUG,
) -> Generator[None, None, None]

Run simulations in this context manager to write detailed simulation activity to a log file.

Parameters:

  • log_file (str, default: 'debug.log' ) –

    The path to the log file to write. Can be relative to the current working directory.

  • log_level (str | int, default: DEBUG ) –

    The log level to use; accepts any argument valid for logging.Handler.setLevel.

Examples:

1
2
3
with file_log("my_log_file.log"):
    sim = BasicSimulator(rume)
    my_results = sim.run()