States extended by a population factor.

For each original state, n_pop states are created. This is useful for parameter studies, where each inserted state corresponds to a different value of the associated variable.

Attributes¶

states: foxes.core.States

The original states

n_pop: int

The population size

Public members¶

PopulationStates(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.

output_point_vars(algo)[source]

The variables which are being modified by the model.

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

” The main model calculation.

index()[source]

The index list

reset(algo=None, states_sel=None, states_loc=None, verbosity=0)[source]

Reset the states, optionally select states

gen_states_split_size()[source]

Generator for suggested states split sizes for output writing.

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

Run-time states factory.

output_coords()[source]

Gets the coordinates of all output arrays

ensure_output_vars(algo, tdata)[source]

Ensures that the output variables are present in the target data.

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

Starts the model calculation in parallel.

__repr__()[source]

Return repr(self).

property model_id

Unique id based on the model type.

var(v)[source]

Creates a model specific variable name.

unvar(vnm)[source]

Translates model specific variable name to origninal variable name.

property initialized

Initialization flag.

sub_models()[source]

List of all sub-models

property running

Flag for currently running models

set_running(algo, data_stash, sel=None, isel=None, verbosity=0)[source]

Sets this model status to running, and moves all large data to stash.

unset_running(algo, data_stash, sel=None, isel=None, verbosity=0)[source]

Sets this model status to not running, recovering large data from stash

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