effluent.script

The module contains the main entry point of the application

Functions

init_logger([loglevel])	Initialize the python logger
main()	Main script, runnable from the command line
run(conf)	Run the simulation and save the output in the specified file.

Module Contents

effluent.script.init_logger(loglevel=None)

Initialize the python logger

Parameters:

loglevel – Desired output loglevel

effluent.script.main()

Main script, runnable from the command line

The function uses the argparse library to parse arguments from the command line.

Returns:

0 if successful

effluent.script.run(conf)

Run the simulation and save the output in the specified file.

Internally, the function creates a Model object using the information from the config file, and calls the run method of that object.

Parameters:

conf – Configuration parameters (dict object or file name).