class foxes.core.States(foxes.core.PointDataModel)[source]

Abstract base class for states.

States describe ambient meteorological data, typically wind speed, wind direction, turbulence intensity and air density.

Public members

abstract size()[source]

The total number of states.


The index list

abstract weights(algo)[source]

The statistical weights of all states.

load_data(algo, verbosity=0)[source]

Load and/or create all model data that is subject to chunking.


The variables which are being modified by the model.

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

Run-time states factory.

ensure_variables(algo, mdata, fdata, tdata)[source]

Add variables to tdata, initialized with NaN

abstract calculate(algo, mdata, fdata, tdata)[source]

” The main model calculation.

run_calculation(algo, *data, out_vars, **calc_pars)[source]

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




Return repr(self).

property model_id

Unique id based on the model type.


Creates a model specific variable name.

property initialized

Initialization flag.


List of all sub-models

initialize(algo, verbosity=0, force=False)[source]

Initializes the model.

finalize(algo, verbosity=0)[source]

Finalizes the model.

get_data(variable, target, lookup='smfp', mdata=None, ...)[source]

Getter for a data entry in the model object or provided data sources

data_to_store(name, algo, data)[source]

Adds data from mdata to the local store, intended for iterative runs.

from_data_or_store(name, algo, data, ret_dims=False, safe=False)[source]

Get data from mdata or local store