june.distributors.university_distributor.UniversityDistributor

class june.distributors.university_distributor.UniversityDistributor(universities: List[june.groups.university.University], max_number_of_super_areas=20)

For each university it searches in the nearby super areas for students living in student households. Once it has enough to fill the university, it stops searching and fills the university.

universities

a list of universities to fill

max_number_of_super_areas

maximum number of neighbour super areas to look for students

__init__(universities: List[june.groups.university.University], max_number_of_super_areas=20)

For each university it searches in the nearby super areas for students living in student households. Once it has enough to fill the university, it stops searching and fills the university.

universities

a list of universities to fill

max_number_of_super_areas

maximum number of neighbour super areas to look for students

distribute_students_to_universities(super_areas: june.geography.geography.SuperAreas)

For each university, search for students in nearby areas and allocate them to the university.

find_students_in_super_areas(super_areas: june.geography.geography.SuperAreas, n_students: int)