june.groups.boundary¶
-
exception
june.groups.boundary.
BoundaryError
¶ Class for throwing boundary related errors.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
args
¶
-
-
class
june.groups.boundary.
Boundary
(world)¶ A group of people such as in a hospital or a school.
If a spec attribute is not defined in the child class then it is generated by converting the class name into snakecase.
-
__init__
(world)¶ A group of people such as in a hospital or a school.
If a spec attribute is not defined in the child class then it is generated by converting the class name into snakecase.
-
_collate_from_subgroups
(attribute: str) → List[june.demography.person.Person]¶ Return a set of all of the people in the subgroups with a particular health status
- attribute
The name of the attribute in the subgroup, e.g. “in_hospital”
The union of all the sets with the given attribute name in all of the sub groups.
-
_init_frequencies
()¶ Create the frequencies for different attributes of the whole simulated region.
-
classmethod
_next_id
() → int¶ Iterate an id for this class. Each group class has its own id iterator starting at 0
-
add
(person: june.demography.person.Person, activity: str, subgroup_type: june.groups.group.group.Group.SubgroupType)¶ Add a person to a given subgroup. For example, in a school a student is added to the subgroup matching their age.
- person
A person
group_type
-
clear
()¶
-
get_spec
() → str¶ Returns the speciailization of the group.
-
init_random_variables
(n_residents, compsec)¶ Create the random variables following the discrete distributions. for different attributes of the whole simulated region.
-
missing_workforce_nr
()¶ Estimate missing workforce in simulated region. This will establish the number of workers recruited from the boundary.
-
remove_person
(person: june.demography.person.Person)¶ Remove a person from this group by removing them from the subgroup to which they belong
- person
A person
-
_abc_impl
= <_abc_data object>¶
-
property
contains_people
¶ Does this group contain at least one person?
-
property
dead
¶
-
external
= False¶
-
id
¶
-
property
in_hospital
¶
-
property
infected
¶
-
property
must_timestep
¶
-
property
name
¶ The name is computed on the fly to reduce memory footprint. It combines the name fo the class with the id of the instance.
-
property
people
¶ All the people in this group
-
property
recovered
¶
-
property
size
¶
-
property
size_infected
¶
-
property
size_recovered
¶
-
property
size_susceptible
¶
-
spec
¶
-
subgroups
¶
-
property
susceptible
¶
-