RUME

rume.RUME(self, strata, ipm, mms, scope, time_frame, params)

A RUME (or Runnable Modeling Experiment) contains the configuration of an epymorph-style simulation.

It brings together one or more IPMs, MMs, initialization routines, and a geo-temporal scope. Model parameters can also be specified. The RUME will eventually be used to construct a Simulation, which is an algorithm that uses a RUME to produce some results – in the most basic case, running a disease simulation and providing time-series results of the disease model.

RUME is an abstract parent class; users will typically use SingleStrataRUME.build and MultiStrataRUMEBuilder to construct concrete RUMEs.

RUME is generic on the type of GeoScope used to construct the RUME (GeoScopeT_co).

Attributes

strata: Sequence[GPM]

The list of strata.

ipm: BaseCompartmentModel

The compartmental model.

mms: OrderedDict[str, MovementModel]

The movement models (by strata).

scope: GeoScopeT_co

The geo scope.

time_frame: TimeFrame

The simulation time frame.

params: Mapping[NamePattern, ParamValue]

Parameter values set on the RUME.

tau_step_lengths: list[float]

The lengths of each tau step in the simulation as fractions of a day.

num_tau_steps: int

The number of tau steps per day in the simulation.

num_ticks: int

The number of total simulation ticks, the product of multiplying the number of simulation days from the time frame by the number of tau steps per day.

requirements: Mapping[AbsoluteName, AttributeDef]

Returns the attributes required by the RUME.

Methods

Name	Description
params_description	Provide a description of all attributes required by the RUME.
estimate_data	Prints a report estimating the data requirements of this RUME.
requirements_tree	Compute the requirements tree for the given RUME.
generate_params_dict	Generate a skeleton dictionary you can use to provide parameter values to the RUME.
evaluate_params	Evaluates the parameters of this RUME.
initialize	Evaluates the Initializer(s) for this RUME.
symbols	Convenient function to retrieve the symbols used to represent simulation quantities.