foxes
0.3.4
Installation
Requirements
Installation via conda
Virtual Python environment
Standard users
Developers
Installation via pip
Virtual Python environment
Standard users
Developers
Examples
Overview - how to setup foxes
The model book
Single row of turbines
Timeseries data
Multi-height wind data
Wind rose data
Wind sector management
Heterogeneous flow
Power mask
Yawed rotor wakes
Layout optimization
API
foxes.algorithms
foxes.algorithms.downwind
foxes.algorithms.downwind.downwind
foxes.algorithms.downwind.models
foxes.algorithms.iterative
foxes.algorithms.iterative.iterative
foxes.algorithms.iterative.models
foxes.constants
foxes.core
foxes.core.algorithm
foxes.core.algorithm.Algorithm
foxes.core.data
foxes.core.data.Data
foxes.core.data_calc_model
foxes.core.data_calc_model.DataCalcModel
foxes.core.farm_controller
foxes.core.farm_controller.FarmController
foxes.core.farm_data_model
foxes.core.farm_data_model.FarmDataModel
foxes.core.farm_data_model.FarmDataModelList
foxes.core.farm_model
foxes.core.farm_model.FarmModel
foxes.core.model
foxes.core.model.Model
foxes.core.partial_wakes_model
foxes.core.partial_wakes_model.PartialWakesModel
foxes.core.point_data_model
foxes.core.point_data_model.PointDataModel
foxes.core.point_data_model.PointDataModelList
foxes.core.rotor_model
foxes.core.rotor_model.RotorModel
foxes.core.states
foxes.core.states.ExtendedStates
foxes.core.states.States
foxes.core.turbine
foxes.core.turbine.Turbine
foxes.core.turbine_model
foxes.core.turbine_model.TurbineModel
foxes.core.turbine_type
foxes.core.turbine_type.TurbineType
foxes.core.vertical_profile
foxes.core.vertical_profile.VerticalProfile
foxes.core.wake_frame
foxes.core.wake_frame.WakeFrame
foxes.core.wake_model
foxes.core.wake_model.WakeModel
foxes.core.wake_superposition
foxes.core.wake_superposition.WakeSuperposition
foxes.core.wind_farm
foxes.core.wind_farm.WindFarm
foxes.data
foxes.data.farms
foxes.data.parse
foxes.data.parse.parse_Pct_file_name
foxes.data.parse.parse_Pct_two_files
foxes.data.power_ct_curves
foxes.data.states
foxes.data.static_data
foxes.data.static_data.StaticData
foxes.input
foxes.input.farm_layout
foxes.input.farm_layout.add_from_csv
foxes.input.farm_layout.add_from_df
foxes.input.farm_layout.add_from_file
foxes.input.farm_layout.add_from_json
foxes.input.farm_layout.add_grid
foxes.input.farm_layout.add_row
foxes.input.states
foxes.input.states.create
foxes.input.states.field_data_nc
foxes.input.states.multi_height
foxes.input.states.scan_ws
foxes.input.states.single
foxes.input.states.states_table
foxes.input.windio
foxes.input.windio.windio
foxes.models
foxes.models.farm_controllers
foxes.models.farm_controllers.basic
foxes.models.farm_models
foxes.models.farm_models.turbine2farm
foxes.models.model_book
foxes.models.model_book.ModelBook
foxes.models.partial_wakes
foxes.models.partial_wakes.axiwake
foxes.models.partial_wakes.distsliced
foxes.models.partial_wakes.grid
foxes.models.partial_wakes.mapped
foxes.models.partial_wakes.rotor_points
foxes.models.partial_wakes.top_hat
foxes.models.point_models
foxes.models.point_models.set_uniform_data
foxes.models.point_models.tke2ti
foxes.models.point_models.wake_deltas
foxes.models.rotor_models
foxes.models.rotor_models.centre
foxes.models.rotor_models.grid
foxes.models.turbine_models
foxes.models.turbine_models.calculator
foxes.models.turbine_models.kTI_model
foxes.models.turbine_models.power_mask
foxes.models.turbine_models.sector_management
foxes.models.turbine_models.set_XYHD
foxes.models.turbine_models.set_farm_vars
foxes.models.turbine_models.table_factors
foxes.models.turbine_models.thrust2ct
foxes.models.turbine_models.yaw2yawm
foxes.models.turbine_models.yawm2yaw
foxes.models.turbine_types
foxes.models.turbine_types.CpCt_file
foxes.models.turbine_types.CpCt_from_two
foxes.models.turbine_types.PCt_file
foxes.models.turbine_types.PCt_from_two
foxes.models.turbine_types.null_type
foxes.models.turbine_types.wsrho2PCt_two_files
foxes.models.vertical_profiles
foxes.models.vertical_profiles.abl_log
foxes.models.vertical_profiles.uniform
foxes.models.wake_frames
foxes.models.wake_frames.farm_order
foxes.models.wake_frames.rotor_wd
foxes.models.wake_frames.streamlines
foxes.models.wake_frames.yawed_wakes
foxes.models.wake_models
foxes.models.wake_models.axisymmetric
foxes.models.wake_models.dist_sliced
foxes.models.wake_models.gaussian
foxes.models.wake_models.ti
foxes.models.wake_models.top_hat
foxes.models.wake_models.wind
foxes.models.wake_superpositions
foxes.models.wake_superpositions.linear
foxes.models.wake_superpositions.max
foxes.models.wake_superpositions.quadratic
foxes.models.wake_superpositions.ti_superp
foxes.output
foxes.output.farm_layout
foxes.output.farm_layout.FarmLayoutOutput
foxes.output.farm_results_eval
foxes.output.farm_results_eval.FarmResultsEval
foxes.output.flow_plots_2d
foxes.output.flow_plots_2d.FlowPlots2D
foxes.output.output
foxes.output.output.Output
foxes.output.results_writer
foxes.output.results_writer.ResultsWriter
foxes.output.rose_plot
foxes.output.rose_plot.RosePlotOutput
foxes.output.rose_plot.StatesRosePlotOutput
foxes.output.state_turbine_map
foxes.output.state_turbine_map.StateTurbineMap
foxes.output.turbine_type_curves
foxes.output.turbine_type_curves.TurbineTypeCurves
foxes.opt
foxes.opt.constraints
foxes.opt.constraints.area_geometry
foxes.opt.constraints.min_dist
foxes.opt.core
foxes.opt.core.farm_constraint
foxes.opt.core.farm_objective
foxes.opt.core.farm_opt_problem
foxes.opt.core.farm_vars_problem
foxes.opt.core.pop_states
foxes.opt.objectives
foxes.opt.objectives.farm_vars
foxes.opt.objectives.max_n_turbines
foxes.opt.problems
foxes.opt.problems.layout
foxes.opt.problems.opt_farm_vars
foxes.utils
foxes.utils.abl
foxes.utils.abl.neutral
foxes.utils.abl.sheared
foxes.utils.abl.stable
foxes.utils.abl.unstable
foxes.utils.cubic_roots
foxes.utils.data_book
foxes.utils.data_book.DataBook
foxes.utils.dict
foxes.utils.dict.Dict
foxes.utils.geom2d
foxes.utils.geom2d.area_geometry
foxes.utils.geom2d.circle
foxes.utils.geom2d.example_intersection
foxes.utils.geom2d.example_union
foxes.utils.geom2d.half_plane
foxes.utils.geom2d.polygon
foxes.utils.geopandas_helpers
foxes.utils.geopandas_helpers.check_import_gpd
foxes.utils.geopandas_helpers.check_import_utm
foxes.utils.geopandas_helpers.read_shp
foxes.utils.geopandas_helpers.read_shp_polygons
foxes.utils.geopandas_helpers.shp2csv
foxes.utils.geopandas_helpers.shp2geom2d
foxes.utils.pandas_helpers
foxes.utils.pandas_helpers.PandasFileHelper
foxes.utils.plotly_helpers
foxes.utils.plotly_helpers.show_plotly_fig
foxes.utils.runners
foxes.utils.runners.DaskRunner
foxes.utils.runners.DefaultRunner
foxes.utils.runners.Runner
foxes.utils.subclasses
foxes.utils.subclasses.all_subclasses
foxes.utils.two_circles
foxes.utils.two_circles.area
foxes.utils.two_circles.calc_area
foxes.utils.wind_dir
foxes.utils.wind_dir.delta_wd
foxes.utils.wind_dir.uv2wd
foxes.utils.wind_dir.wd2uv
foxes.utils.wind_dir.wd2wdvec
foxes.utils.wind_dir.wdvec2wd
foxes.variables
Static data
Wind farm layout data
test_farm_67.csv
Ambient states data
WRF-Timeseries-4464.csv.gz
abl_states_6000.csv.gz
timeseries_3000.csv.gz
timeseries_8000.csv.gz
wind_rose_bremen.csv
wind_rotation.nc
Power and thrust curves
DTU-10MW-D178d3-H119.csv
IEA-15MW-D240-H150.csv
IWT-7d5MW-D164-H100.csv
NREL-5MW-D126-H90.csv
File paths
History
v0.1.0-alpha
v0.1.1-alpha
v0.1.2-alpha
v0.1.3-alpha
v0.1.4-alpha
v0.2.0-alpha
v0.2.1-alpha
v0.2.2-alpha
v0.2.3-alpha
v0.2.4-alpha
v0.2.5-alpha
v0.2.6-alpha
v0.3.0-alpha
v0.3.1-alpha
v0.3.2-alpha
v0.3.3-alpha
v0.3.4-alpha
foxes
»
API
»
foxes.models
»
foxes.models.turbine_models
»
foxes.models.turbine_models.power_mask
View page source
foxes.models.turbine_models.power_mask
ΒΆ
Classes
PowerMask
Invokes a maximal power value.