effluent

The main package contains only a single function, effluent.run(), which is the main entry point of the application.

Submodules

• effluent.eos
• effluent.io
• effluent.model
• effluent.numerics
• effluent.roms
• effluent.script
• effluent.solver

Attributes

__version__

The version number

Functions

run(conf)

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

Package Contents

effluent.__version__ = '1.5.0'

The version number

effluent.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).