arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

Specifying population structure

This page describes how users specify the names, sizes, and connectivities of the different subpopulations comprising the total population to be modeled

hashtag
Overview

The subpop_setup section of the configuration file is where users can input the information required to define a population structure on which to simulate the model. The options allow the user to determine the population size of each subpopulation that makes up the overall population, and to specify the amount of mixing that occurs between each pair of subpopulations.

An example configuration file with the global header and the spatial_setup section is below:

hashtag
Items and options

Config Item
Required?
Type/Format
Description

hashtag
geodata file and selected option

  • geodata is a .csv with column headers, with at least two columns: subpop and population.

  • selected if provided, is the subset of locations in geodata file (as determined by subpop column) to be modeled. Requesting subpopulation(s) that are not present will lead to an error.

hashtag
Example geodata file format

hashtag
mobility file

The mobility file is a .csv file (it has to contain .csv as extension) with long form comma separated values. Columns have to be named ori, dest, amount, with amount being the average number individuals moving from the origin subpopulation ori to destination subpopulation dest on any given day. Details on the mathematics of this model of contact are explained in the . Unassigned relations are assumed to be zero. The location entries in the ori and dest columns should correspond to an entry in the subpop column in geodata.csv. When using selected

hashtag
Example mobility file format

It is also possible, but not recommended to specify the mobility file as a .txt with space-separated values in the shape of a matrix. This matrix is symmetric and of size K x K, with K being the number of rows in geodata. The above example corresponds to

hashtag
Examples

hashtag
Example 1

To simulate a simple population structure with two subpopulations, a large province with 10,000 individuals and a small province with only 1,000 individuals, where every day 100 residents of the large province travel to the small province and interact with residents there, and 50 residents of the small province visit the large province

geodata.csv contains the population structure (with columns subpop and population)

mobility.csv contains

name: test_simulation
model_output_dirname: model_output
start_date: 2020-01-01
end_date: 2020-12-31
nslots: 100

subpop_setup:
  geodata: model_input/geodata.csv
  mobility: model_input/mobility.csv
, the
mobility
data will also be filtered.

geodata

required

path to file

path to geodata file

mobility

required

path to file

path to mobility file

selected

optional

string or list of strings

Model Description section

name of selected location ingeodata

subpop,population
10001,1000
20002,2000
ori, dest, amount
10001, 20002, 3
20002, 10001, 3
0 3
3 0
subpop_setup:
  geodata: model_input/geodata.csv
  mobility: model_input/mobility.csv
subpop,          population
large_province, 10000
small_province, 1000
ori,            dest,           amount
large_province, small_province, 100
small_province, large_province, 50