foxes.input¶

Classes and functions that describe user input data.

Package	Description
foxes.input.farm_layout	Functions for adding turbines to the wind farm.
foxes.input.states	Atmospheric input states.
foxes.input.states.create	Functions for the creation of ambient states from parameters.
foxes.input.yaml	Runs foxes via parameter input yaml files, for foxes_yaml
foxes.input.yaml.windio	An interface to WindIO yaml files, via foxes_windio

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_row(farm, xy_base, xy_step, ...)[source]

Add a single row of turbines.

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.farm_layout.add_ring(farm, xy_base, dist, ...)[source]

Add a ring of turbines.

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.ScanStates(foxes.core.States)[source]

Scan over selected variables

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

class foxes.input.states.WRGStates(foxes.core.States)[source]

Ambient states based on WRG data

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.yaml¶

Runs foxes via parameter input yaml files, used by the command line application foxes_yaml.

foxes.input.yaml.read_dict(idict, farm=None, states=None, ...)[source]

Read dictionary input into foxes objects

foxes.input.yaml.run_dict(idict, *args, verbosity=None, **kwargs)[source]

Runs foxes from dictionary input

foxes.input.yaml.run_outputs(idict, algo=None, ...)[source]

Run outputs from dict.

foxes.input.yaml.run_obj_function(obj, fdict, algo, rlabels, ...)[source]

Runs a function of an object

foxes.input.yaml.get_output_obj(ocls, odict, algo, ...)[source]

Create the output object

foxes.input.yaml.foxes_yaml()[source]

Command line tool for running foxes from yaml file input.

foxes.input.yaml.windio¶

Interface to WindIO yaml input files, used by the command line application foxes_windio.

foxes.input.yaml.read_windio(wio_dict, verbosity=1)[source]

Translate windio data to foxes input data

foxes.input.yaml.foxes_windio()[source]

Command line tool for running foxes from windio yaml file input.

foxes.input.yaml.windio.read_site(wio_dict, verbosity=1)[source]

Reads the site information

foxes.input.yaml.windio.read_farm(wio_dict, mbook, verbosity)[source]

Reads the wind farm information

foxes.input.yaml.windio.read_attributes(wio_attrs, idict, ...)[source]

Reads the attributes part of windio

foxes.input.yaml.windio.read_wind_resource_field(name, ...)[source]

Reads wind resource data into fields and dims

foxes.input.yaml.windio.read_layout(lname, ldict, farm, ttypes, ...)[source]

Read wind farm layout from windio input

foxes.input.yaml.windio.read_turbine_types(wio_farm, mbook, ...)[source]

Reads the turbine type from windio