foxes.input¶
Classes and functions that describe user input data.
Package
Description
Functions for adding turbines to the wind farm.
Atmospheric input states.
Functions for the creation of ambient states from parameters.
An interface to WindIO yaml files.
foxes.input.farm_layout¶
This package contains functions that can be used to add wind turbines to the wind farm.
- foxes.input.farm_layout.add_grid(farm, xy_base, step_vectors, ...)[source]
Add a regular grid of turbines.
- foxes.input.farm_layout.add_from_json(farm, file_path, ...)[source]
Add turbimes from a json file.
- foxes.input.farm_layout.add_from_csv(farm, data_source, ...)[source]
Add turbines to wind farm via csv input file.
- foxes.input.farm_layout.add_from_file(farm, file_path, *args, ...)[source]
Add turbines from file.
- foxes.input.farm_layout.add_from_df(farm, data_source, *args, ...)[source]
Add turbines to wind farm via pandas DataFrame.
- foxes.input.farm_layout.add_random(farm, n_turbines, min_dist, ...)[source]
Add turbines that lie randomly within a square
foxes.input.states¶
All ambient user input states classes can be found here.
- class foxes.input.states.SingleStateStates(foxes.core.States)[source]
A single uniform state.
- class foxes.input.states.ScanWS(foxes.core.States)[source]
A given list of wind speeds, all other variables are fixed.
- class foxes.input.states.StatesTable(foxes.core.States)[source]
States from a pandas.DataFrame or a pandas readable file.
- class foxes.input.states.Timeseries(foxes.input.states.StatesTable)[source]
Timeseries states data.
- class foxes.input.states.TabStates(foxes.input.states.StatesTable)[source]
States created from a single tab file
- class foxes.input.states.FieldDataNC(foxes.core.States)[source]
Heterogeneous ambient states on a regular horizontal grid in NetCDF format.
- class foxes.input.states.MultiHeightStates(foxes.core.States)[source]
States with multiple heights data per entry.
- class foxes.input.states.MultiHeightTimeseries(foxes.input.states.MultiHeightStates)[source]
Multi-height timeseries states data.
- class foxes.input.states.MultiHeightNCStates(foxes.input.states.MultiHeightStates)[source]
Multi-height states from xarray Dataset.
- class foxes.input.states.MultiHeightNCTimeseries(foxes.input.states.MultiHeightNCStates)[source]
Multi-height timeseries from xarray Dataset.
- class foxes.input.states.OnePointFlowStates(foxes.core.States)[source]
Time-evolving states based on horizontally homogeneous timeseries data
- class foxes.input.states.OnePointFlowTimeseries(foxes.input.states.OnePointFlowStates)[source]
Inhomogeneous inflow from homogeneous timeseries data at one point
- class foxes.input.states.OnePointFlowMultiHeightTimeseries(foxes.input.states.OnePointFlowStates)[source]
Inhomogeneous inflow from height dependent homogeneous timeseries data at one point
- class foxes.input.states.OnePointFlowMultiHeightNCTimeseries(foxes.input.states.OnePointFlowStates)[source]
Inhomogeneous inflow from height dependent homogeneous timeseries data at one point based on NetCDF input
foxes.input.states.create¶
Functions for the creation of ambient states from parameters.
- foxes.input.states.create.create_random_abl_states(n_states, ...)[source]
Create random abl states.
- foxes.input.states.create.random_timseries_data(n_times, ...)[source]
Creates random uniform timeseries data
foxes.input.windio¶
Interface to WindIO yaml input files.
- foxes.input.windio.get_states(coords, fields, dims, verbosity=
1
)[source]Reads states parameters from windio input
- foxes.input.windio.read_outputs(wio_outs, algo_dict, verbosity)[source]
Reads the windio outputs
- foxes.input.windio.read_attributes(wio, algo_dict, verbosity)[source]
Reads the attributes part of windio
- foxes.input.windio.read_windio(windio_yaml, verbosity=
1
, ...)[source]Reads a complete WindIO case.
- foxes.input.windio.read_turbine_types(wio_farm, algo_dict, ...)[source]
Reads the turbine type from windio
- foxes.input.windio.read_layout(lname, ldict, algo_dict, ttypes, ...)[source]
Read wind farm layout from windio input
- class foxes.input.windio.WindioRunner[source]
Runner for windio input