Helper class for vectorized opt population calculation, via artificial states of length n_pop times n_states.

Attributes¶

states: foxes.core.States

The original states

n_pop: int

The population size

Public members¶

PopStates(states, n_pop)[source]

Constructor.

load_data(algo, verbosity=0)[source]

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

initialize(algo, verbosity=0)[source]

Initializes the model.

size()[source]

The total number of states.

weights(algo)[source]

The statistical weights of all states.

output_point_vars(algo)[source]

The variables which are being modified by the model.

calculate(algo, mdata, fdata, pdata)[source]

” The main model calculation.

index()

The index list

classmethod new(states_type, *args, **kwargs)

Run-time states factory.

ensure_variables(algo, mdata, fdata, tdata)

Add variables to tdata, initialized with NaN

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

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

__repr__()

Return repr(self).

property model_id

Unique id based on the model type.

var(v)

Creates a model specific variable name.

property initialized

Initialization flag.

sub_models()

List of all sub-models

finalize(algo, verbosity=0)

Finalizes the model.

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

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

data_to_store(name, algo, data)

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

from_data_or_store(name, algo, data, ret_dims=False, safe=False)

Get data from mdata or local store