memilio.epidata.getSimulationData

getSimulationData.py

Executes all data downloads which belong to the epidata package and downloads external data

The functions which are called are:

  • getCaseData.get_case_data

  • getPopulationData.get_population_data

  • getVacccinationData.get_vaccination_data

  • getDIVIData.get_divi_data

  • getCommuterMobility.get_commuter_data

Functions

get_simulation_data([read_data, ...])

Downloads all data from external sources

main()

Main program entry.

print_error(text)

param text:
memilio.epidata.getSimulationData.get_simulation_data(
read_data=False,
file_format='json_timeasstring',
out_folder='/home/docs/checkouts/readthedocs.org/user_builds/memilio/data/',
start_date=datetime.date(2020, 1, 1),
end_date=datetime.date(2026, 6, 15),
impute_dates=False,
moving_average=0,
split_berlin=False,
rep_date=False,
sanitize_data=1,
ref_year=2022,
**kwargs,
)

Downloads all data from external sources

The functions which are called are: - getCaseData.get_case_data - getPopulationData.get_population_data - getVaccinationData.get_vaccination_data - getDIVIData.get_divi_data - getCommuterMobility.get_commuter_data - transformMobilityData.updateMobility2022 (if ref_year < 2022)

Keyword arguments:

Parameters:

  • read_data – True or False. Defines if data is read from file or downloaded. Default defined in defaultDict.

  • file_format – File format which is used for writing the data. Default defined in defaultDict.

  • out_folder – Folder where data is written to. Default defined in defaultDict.

  • start_date – Date of first date in dataframe. Default 2020-01-01.

  • end_date – Date of last date in dataframe. Default defined in defaultDict.

  • impute_dates – True or False. Defines if values for dates without new information are imputed. Default defined in defaultDict.

  • moving_average – Integers >=0. Applies an ‘moving_average’-days moving average on all time series to smooth out effects of irregular reporting. Default defined in defaultDict.

  • split_berlin – True or False. Defines if Berlin’s disctricts are kept separated or get merged. Default defined in defaultDict.

  • rep_date – True or False. Defines if reporting date or reference date is taken into dataframe. Default defined in defaultDict.

  • sanitize_data – Value in {0,1,2,3}. Redistributes cases of every county either based on regions’ ratios or on thresholds and population. (Default value = dd.defaultDict[‘sanitize_data’])

  • ref_year – Year that specifies where the data should be taken from. Default value is 2022.

  • **kwargs –

memilio.epidata.getSimulationData.main()

Main program entry.

memilio.epidata.getSimulationData.print_error(text)
Parameters:

text –