foxes.input.yaml.foxes_yaml(yml_file, output_dir=None, rotor=None, pwakes=None, wakes=None, frame=None, engine=None, n_procs=None, chunksize_states=None, chunksize_points=None, iterative=False, nofig=False, verbosity=1)[source]

Run foxes from yaml file input

ParametersΒΆ

yml_file: str or Path

The yaml file path

output_dir: str or Path, optional

The output directory, default: None (same as input file)

rotor: str, optional

The rotor model, default: None (use the one from the yaml file)

pwakes: list of str, optional

The partial wakes models, default: None (use the ones from the yaml file)

wakes: list of str, optional

The wake models, default: None (use the ones from the yaml file)

frame: str, optional

The wake frame, default: None (use the one from the yaml file)

engine: str, optional

The engine, default: None (use the one from the yaml file)

n_procs: int, optional

The number of processes, default: None (use the one from the yaml file)

chunksize_states: int, optional

The chunk size for states, default: None (use the one from the yaml file)

chunksize_points: int, optional

The chunk size for points, default: None (use the one from the yaml file)

iterative: bool, optional

Use iterative algorithm, default: False

nofig: bool, optional

Do not show figures, default: False

verbosity: int, optional

The verbosity level, 0 = silent, default: 1