june.demography.demography.Demography¶
-
class
june.demography.demography.
Demography
(area_names, age_sex_generators: Dict[str, june.demography.demography.AgeSexGenerator], comorbidity_data=None) Tool to generate population for a certain geographical regin.
- age_sex_generators
A dictionary mapping area identifiers to functions that generate age and sex for individuals.
-
__init__
(area_names, age_sex_generators: Dict[str, june.demography.demography.AgeSexGenerator], comorbidity_data=None) Tool to generate population for a certain geographical regin.
- age_sex_generators
A dictionary mapping area identifiers to functions that generate age and sex for individuals.
-
classmethod
for_areas
(area_names: List[str], data_path: str = PosixPath('/home/sadie/JUNE/data/input/demography'), config: Optional[dict] = None, config_path: str = PosixPath('/home/sadie/JUNE/configs')) → june.demography.demography.Demography Load data from files and construct classes capable of generating demographic data for individuals in the population.
- area_names
List of areas for which to create a demographic generator.
- data_path
The path to the data directory
- config
Optional configuration. At the moment this just gives an asymptomatic ratio.
A demography representing the super area
-
classmethod
for_geography
(geography: june.geography.geography.Geography, data_path: str = PosixPath('/home/sadie/JUNE/data/input/demography'), config: Optional[dict] = None) → june.demography.demography.Demography Initializes demography from an existing geography.
- geography
an instance of the geography class
-
classmethod
for_zone
(filter_key: Dict[str, list], data_path: str = PosixPath('/home/sadie/JUNE/data/input/demography'), areas_maps_path: str = PosixPath('/home/sadie/JUNE/data/input/geography/area_super_area_region.csv'), config: Optional[dict] = None) → june.demography.demography.Demography Initializes a geography for a specific list of zones. The zones are specified by the filter_dict dictionary where the key denotes the kind of zone, and the value is a list with the different zone names.
filter_key = {“region” : “North East”} filter_key = {“super_area” : [“EXXXX”, “EYYYY”]}
-
populate
(area_name: str, ethnicity=True, socioecon_index=True, comorbidity=True) → june.demography.demography.Population Generate a population for a given area. Age, sex and number of residents are all based on census data for that area.
- area_name
The name of an area a population should be generated for
A population of people