Read dictionary input into foxes objects

Parameters¶

idict: foxes.utils.Dict

The input parameter dictionary

farm: foxes.core.WindFarm, optional

The wind farm, overrules settings from idict

states: foxes.core.States, optional

The ambient states, overrules settings from idict

mbook: foxes.models.ModelBook, optional

The model book, overrules settings from idict

algo: foxes.core.Algorithm, optional

The algorithm, overrules settings from idict

engine_pars: dict, optional

Parameters for engine creation, overrules settings from idict

iterative: bool, optional

Force iterative calculations, overrules settings from idict

verbosity: int, optional

Force a verbosity level, 0 = silent, overrules settings from idict

work_dir: str or pathlib.Path, optional

Path to the working directory

input_dir: str or pathlib.Path, optional

The default input directory

output_dir: str or pathlib.Path, optional

The default output directory

algo_pars: dict, optional

Additional parameters for the algorithm, overrules settings from idict

Returns¶

algo: foxes.core.Algorithm

The algorithm

engine: foxes.core.Engine

The engine, or None if not set