foxes.input.yaml.windio.read_windio_file(yml_file, ret_wio=False, verbosity=1, **algo_kwargs)[source]

Read windio yaml file and translate to foxes input data

Parameters

yml_file: pathlib.Path or str

The windio yaml file

ret_wio: bool

Whether to return the windio data dictionary as well

verbosity: int

The verbosity level, 0 = silent

algo_kwargs: dict, optional

Additional keyword arguments for the algorithm

Returns

idict: foxes.utils.Dict or dict

The foxes input data dictionary

algo: foxes.core.Algorithm

The algorithm

odir: pathlib.Path

The output directory