memilio.plot.createGIF

Functions

create_gif_map_plot(input_data, output_dir, ...)

Creates a gif of the simulation results by calling create_plot_map for each day of the simulation and then storing the single plots in a temporary directory.

create_plot_map(day, filename, files_input, ...)

Plots region-specific information for a single day of the simulation.
memilio.plot.createGIF.create_gif_map_plot(
input_data,
output_dir,
compartments,
filename='simulation',
relative=True,
age_groups={0: '0-4', 1: '5-14', 2: '15-34', 3: '35-59', 4: '60-79', 5: '80+'},
)

Creates a gif of the simulation results by calling create_plot_map for each day of the simulation and then storing the single plots in a temporary directory. Currently only works for the results created by the parameter study.

Parameters:

  • input_data – Path to the input data. The Path should contain a file called ‘Results’ which contains the simulation results. This is the default output folder of the parameter study.

  • output_dir – Path where the gif should be stored.

  • filename – Name of the temporary file. (Default value = “simulation”)

  • relative – Defines if data should be scaled relative to population. (Default value = True)

  • age_groups – Dictionary of age groups to be considered. (Default value = {0: ‘0-4’, 1: ‘5-14’, 2: ‘15-34’, 3: ‘35-59’, 4: ‘60-79’, 5: ‘80+’})

memilio.plot.createGIF.create_plot_map(
day,
filename,
files_input,
output_path,
compartments,
file_format='h5',
relative=False,
age_groups={0: '0-4', 1: '5-14', 2: '15-34', 3: '35-59', 4: '60-79', 5: '80+'},
)

Plots region-specific information for a single day of the simulation.

Parameters:

  • day – Day of the simulation.

  • filename – Name of the file to be created.

  • files_input – Dictionary of input files.

  • output_path – Output path for the figure.

  • compartments – List of compartments to be plotted.

  • file_format – Format of the file to be created. Either ‘h5’ or ‘json’. (Default value = ‘h5’)

  • relative – Defines if data should be scaled relative to population. (Default value = False)

  • age_groups – Dictionary of age groups to be considered. (Default value = {0: ‘0-4’, 1: ‘5-14’, 2: ‘15-34’, 3: ‘35-59’, 4: ‘60-79’, 5: ‘80+’})