MetaWards API Detail

Classes

Disease(beta, progress, too_ill_to_move, …) This class holds the parameters about a single disease
Infections() This class holds the arrays that record the infections as they are occuring during the outbreak
InputFiles(work, play, identifier, …) This class holds all of the input files that must be loaded from METAWARDSDATA to construct the network of wards and links between them
Link(ifrom, ito, weight, suscept, distance, A) This is a link between nodes in the network
Links This is a container class for Links.
Network(nodes, to_links, play, weekend, …) This class represents a network of wards.
Node(label, begin_to, end_to, self_w, …) This class represents an electoral ward (node) in the network
Nodes This is a container class for Nodes.
OutputFiles(output_dir, check_empty, force_empty) This is a class that manages all of the output files that are written to during a model outbreak.
Parameters(input_files, uv_filename, …) The full set of Parameters that are used to control the model outbreak over a Network.
Population(initial, susceptibles, latent, …) This class holds information about the progress of the disease through the population
Populations(_trajectory) This class holds the trajectory of Population objects recorded for every step (day) of a model outbreak
VariableSet(variables, float] = None, …) This class holds a single set of adjustable variables that are used to adjust the variables as part of a model run
VariableSets() This class holds the collection of all VariableSet objects that contain the set of adjustable variables that are used to control a single run of the model
WardInfo(name, alternate_names, code, …) This class holds metadata about a ward, e.g.
WardInfos(wards) Simple class that holds a list of WardInfo objects, and provides useful search functions over that list.
Workspace(n_inf_classes, nnodes, inf_tot, …) This class provides a workspace for the running calculation.

Functions

get_version_string() Return a version string for metawards which can be printed into a file or written out to the screen
metawards.get_version_string()[source]

Return a version string for metawards which can be printed into a file or written out to the screen