foxes.core.farm_data_model.FarmDataModelList

class foxes.core.farm_data_model.FarmDataModelList[source]

Bases: FarmDataModel

A list of farm data models.

By using the FarmDataModelList the models’ calculate functions are called together under one common call of xarray’s apply_ufunc.

Parameters:

models (list of foxes.core.FarmDataModel) – The model list

models

The model list

Type:

list of foxes.core.FarmDataModel

__init__(models=[])[source]

Methods

__init__([models])

append(model)

Add a model to the list

calculate(algo, mdata, fdata[, parameters])

The main model calculation.

finalize(algo[, verbosity])

Finalizes the model.

get_data(variable, data[, st_sel, upcast, ...])

Getter for a data entry in either the given data source, or the model object.

initialize(algo[, verbosity])

Initializes the model.

output_farm_vars(algo)

The variables which are being modified by the model.

run_calculation(algo, *data, out_vars, ...)

Starts the model calculation in parallel, via xarray's apply_ufunc.

var(v)

Creates a model specific variable name.

Attributes

initialized

Initialization flag.

model_id

Unique id based on the model type.
__init__(models=[])[source]
append(model)[source]

Add a model to the list

Parameters:

model (foxes.core.FarmDataModel) – The model to add

calculate(algo, mdata, fdata, parameters=[])[source]

The main model calculation.

This function is executed on a single chunk of data, all computations should be based on numpy arrays.

Parameters:

  • algo (foxes.core.Algorithm) – The calculation algorithm

  • mdata (foxes.core.Data) – The model data

  • fdata (foxes.core.Data) – The farm data

  • parameters (list of dict, optional) – A list of parameter dicts, one for each model

Returns:

results – The resulting data, keys: output variable str. Values: numpy.ndarray with shape (n_states, n_turbines)

Return type:

dict

finalize(algo, verbosity=0)[source]

Finalizes the model.

Parameters:

  • algo (foxes.core.Algorithm) – The calculation algorithm

  • verbosity (int) – The verbosity level, 0 means silent

get_data(variable, data, st_sel=None, upcast=None, data_prio=False, accept_none=False)

Getter for a data entry in either the given data source, or the model object.

Parameters:

  • variable (str) – The variable, serves as data key

  • data (dict) – The data source

  • st_sel (numpy.ndarray of bool, optional) – If given, get the specified state-turbine subset

  • upcast (str, optional) – Either ‘farm’ or ‘points’, broadcasts potential scalar data to numpy.ndarray with dimensions (n_states, n_turbines) or (n_states, n_points), respectively

  • data_prio (bool) – First search the data source, then the object

  • accept_none (bool) – Do not throw an error if data entry is None or np.nan

initialize(algo, verbosity=0)[source]

Initializes the model.

This includes loading all required data from files. The model should return all array type data as part of the idata return dictionary (and not store it under self, for memory reasons). This data will then be chunked and provided as part of the mdata object during calculations.

Parameters:

  • algo (foxes.core.Algorithm) – The calculation algorithm

  • verbosity (int) – The verbosity level, 0 = silent

Returns:

idata – The dict has exactly two entries: data_vars, a dict with entries name_str -> (dim_tuple, data_ndarray); and coords, a dict with entries dim_name_str -> dim_array

Return type:

dict

property initialized

Initialization flag.

Returns:

True if the model has been initialized.

Return type:

bool

property model_id

Unique id based on the model type.

Returns:

Unique id of the model object

Return type:

int

output_farm_vars(algo)[source]

The variables which are being modified by the model.

Parameters:

algo (foxes.core.Algorithm) – The calculation algorithm

Returns:

output_vars – The output variable names

Return type:

list of str

run_calculation(algo, *data, out_vars, **calc_pars)

Starts the model calculation in parallel, via xarray’s apply_ufunc.

Typically this function is called by algorithms.

Parameters:

  • algo (foxes.core.Algorithm) – The calculation algorithm

  • *data (tuple of xarray.Dataset) – The input data

  • out_vars (list of str) – The calculation output variables

  • **calc_pars (dict, optional) – Additional arguments for the calculate function

Returns:

results – The calculation results

Return type:

xarray.Dataset

var(v)

Creates a model specific variable name.

Parameters:

v (str) – The variable name

Returns:

Model specific variable name

Return type:

str