main — Main LADiM Module

This module contains one function, main() governing LADiM simulations. Its signature is:

main.main(config_stream, loglevel=logging.INFO)
Parameters:
  • config_stream (stream) – Configuration stream
  • loglevel (int) – Logging level, default = logging.INFO

The configuration stream is normally an open yaml-file, but can be a text string by StringIO as in the jupyter example.

A simplified, but working, version of the ladim script:

import logging
from ladim import main

loglevel = logging.INFO
config_file = 'ladim1.yaml'

logging.basicConfig(
    level=loglevel, format='%(levelname)s:%(module)s - %(message)s')

with open(config_file, encoding='utf8') as fp:
    main(config_stream=fp, loglevel=loglevel)