Output class for cluster-aware aggregation and area mapping plots.

Public members¶

ClusterEval(*args, **kwargs)[source]

Constructor.

property results

Get the aggregated cluster results.

get_mapping()[source]

Get the mapping from cluster to turbine indices.

split()[source]

Split the results by cluster.

get_power_units()[source]

Gets the power units in Watts for all elements

get_capacity()[source]

Gets the capacity values for each turbine, equals nominal power

write_split_nc_files(base_name, **kwargs)[source]

Write the results for each sub element to separate netCDF files.

weinsum(rhs, *vars)[source]

Calculates Einstein sum, adding weights as last argument to the given fields.

reduce_states(vars_op=None)[source]

Reduces the states dimension by some operation

reduce_turbines(vars_op)[source]

Reduces the turbine dimension by some operation

reduce_all(states_op, turbines_op)[source]

Reduces states and turbine dimension by some operation

calc_states_mean(vars, use_weights=True)[source]

Calculates the mean wrt states.

calc_states_sum(vars)[source]

Calculates the sum wrt states.

calc_states_std(vars)[source]

Calculates the standard deviation wrt states.

calc_turbine_mean(vars)[source]

Calculates the mean wrt turbines.

calc_turbine_sum(vars)[source]

Calculates the sum wrt turbines.

calc_farm_mean(vars)[source]

Calculates the mean over states and turbines.

calc_farm_sum(vars)[source]

Calculates the sum over states and turbines.

calc_mean_farm_power(ambient=False)[source]

Calculates the mean total farm power.

calc_yield(annual=False, ambient=False, hours=None, ...)[source]

Calculates the yield

add_capacity(verbosity=1)[source]

Adds capacity to the farm results, equals P_nominal on turbine level

add_yield(annual=True, ambient=False, verbosity=1, **kwargs)[source]

Adds yield to the farm results

add_capacity_factor(capacity=None, ambient=False, verbosity=1)[source]

Adds capacity factor to the farm results, P / CAP

calc_farm_yield(turbine_yield=None, power_uncert=None, **kwargs)[source]

Calculates yield, P75 and P90 at the farm level

add_efficiency(verbosity=1)[source]

Adds efficiency to the farm results

add_full_load_fraction(ambient=False, verbosity=1)[source]

Adds full load fraction to the farm results

calc_farm_efficiency()[source]

Calculates farm efficiency

gen_stdata(turbines, variable, fig=None, ax=None, figsize=None, ...)[source]

Generates state-turbine data, intended to be used in animations

write_nc(fname, **kwargs)[source]

Write the results to a netCDF file.

get_fpath(fname)[source]

Gets the total file path

write(file_name, data, format_col2var={}, format_dict={}, **kwargs)[source]

Writes data to file via pandas.

classmethod print_models()[source]

Prints all model names.

classmethod new(output_type, *args, **kwargs)[source]

Run-time output model factory.

output¶

get_area_mapping_plot_layout(area_by_name, n_areas)[source]

Compute an extent-aware figure size and marker size for area mapping plots.

write_area_mapping_plot(plot_file, areas=None, mapping=None, ...)[source]

Writes a plot visualizing turbine-to-area mapping.