foxes_opt.pipelines.layout_pipelines¶
Classes¶
Pipeline for layout generation. |
Module Contents¶
-
class foxes_opt.pipelines.layout_pipelines.LayoutPipeline(base_dir: str, algo_pars: dict[str, Any], n_turbines: int, turbine_models: list[str], farm_boundary: foxes.utils.geom2d.AreaGeometry | None, states: foxes.core.States | None =
None, mbook: foxes.ModelBook | None =None, farm_pars: dict[str, Any] | None =None, name: str ='layout_pipeline', **kwargs: Any)¶ Bases:
iwopy.PipelinePipeline for layout generation.
- Parameters:¶
- base_dir
Base directory for the self.
- algo_pars
The parameters for the foxes algorithm
- n_turbines
The number of turbines in the wind farm
- turbine_models
The turbine models
- farm_boundary
The wind farm boundary
- states
The states to optimize the layout for
- mbook
The model book to be used
- farm_pars
Additional parameters for the wind farm
- name
The name of the pipeline
- kwargs
Additional keyword arguments for the self.
-
run(start_stage: int =
0, end_stage: int | None =None, finalize: bool =True, verbosity: int =1) tuple[bool, tuple[Any, Any]]¶ Run the pipeline.
- Parameters:¶
- start_stage
The stage index to start from
- end_stage
The stage index to end at, default None (run all stages)
- finalize
Whether to finalize the pipeline after running, default True
- verbosity
The verbosity level, 0 = silent
- Returns:¶
- success
Whether all stages were successful
- results
The results of the pipeline, containing the algorithm and farm results when successful, otherwise the layout coordinates and no farm result.
- algo_pars¶
- farm_boundary¶
- farm_pars¶
- mbook¶
- n_turbines¶
-
states =
None¶
- turbine_models¶