Abstract base class for models with that run calculation on xarray Dataset data.

The calculations are run via xarray’s apply_ufunc function, i.e., they run in parallel depending on the dask settings.

For each individual data chunk the calculate function is called.

Public members¶

abstract calculate(algo, *data, **parameters)[source]

” The main model calculation.

run_calculation(algo, *data, out_vars, loop_dims, ...)[source]

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

DataCalcModel()[source]

Constructor.

__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