Abstract base class for models that modify farm data.

Attributes¶

pre_rotor: bool

Flag for running this model before running the rotor model.

Public members¶

FarmDataModel(pre_rotor=False)[source]

Constructor.

abstract output_farm_vars(algo)[source]

The variables which are being modified by the model.

ensure_variables(algo, mdata, fdata)[source]

Add variables to fdata, initialized with NaN

abstract calculate(algo, mdata, fdata)[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.

__repr__()[source]

Return repr(self).

property model_id

Unique id based on the model type.

var(v)[source]

Creates a model specific variable name.

property initialized

Initialization flag.

sub_models()[source]

List of all sub-models

load_data(algo, verbosity=0)[source]

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

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