This version is no longer being maintained. For an updated version of DITRAS, please visit https://github.com/scikit-mobility/scikit-mobility
DITRAS (DIary-based TRAjectory Simulator) is a framework to simulate the spatio-temporal patterns of human mobility in a realistic way. DITRAS operates in two steps: the generation of a mobility diary and the translation of the mobility diary into a mobility trajectory. The mobility diary is constructed by a Markov model which captures the tendency of individuals to follow or break their routine. The mobility trajectory is produced by a model based on the concept of preferential exploration and preferential return. DITRAS can reproduce the statistical properties of real human mobility trajectories in an accurate way. For technical details on DITRAS please read the scientific article at this link: http://arxiv.org/abs/1607.05952
If you use this code, please cite the following scientific article:
To run the code of DITRAS, download all the folder in this repository and write on the terminal a command in the following format:
python DITRAS.py n_agents time_slots spatial_tessellation od_matrix diary_generator_1hour.pkl filename, where:
spatial_tessellationfile must be the following:
latitude,longitude,relevance. Latitude and longitude are float numbers indicating the geographic position of a location and relevance is an integer indicating the importance of the location (e.g., the number of residents in the locations or the number of calls made in that location during a given period). We provide you an example of spatial tessellation in the Italian regione of Trentino, stored in the file
location2info_trentino. This spatial tessellation is released under a Open Data Commons Open Database License (ODbL) and it is obtained from the publicly available dataset described in this paper http://www.nature.com/articles/sdata201555#data-records.
For example type the following command on the terminal to start your DITRAS simulation:
python DITRAS.py 10000 720 location2info_trentino od_matrix.pkl diary_generator_1hour.pkl trajs_10000_720.csv
DITRAS will simulate the mobility of 10,000 agents for 720 hours (1 months), using the
location2info_trentino weighted spatial tessellation and the diary generator
diary_generator_1hour.pkl. The produced synthetic trajectories will be stored in a file named
trajs_10000_720.csv. DITRAS will also compute the origin destination matrix
od_matrix.pkl the first time you run the command.
First, read the spatial tessellation from the corresponding file and load it in a dictionary, using the function
load_spatial_tessellation. In this repository we provide an example of spatial tessellation regarding the Italian region of Trentino, it is stored in the file
location2info_trentino. Second, initialize a DITRAS object with the parameters you prefer. Finally, start the execution of DITRAS by using the method
spatial_tessellation = load_spatial_tessellation('location2info_trentino') ditras = DITRAS(n_agents=10000, length=720, diary_generator=MD(filename='diary_generator_1hour.pkl'), trajectory_generator=dEPR(rho=0.6, gamma=0.21), filename='trajs_10000_720.csv') ditras.start_simulation(spatial_tessellation, od_matrix_file='od_matrix.pkl')
ditras_example.ipynb notebook in this repository to try different executions of DITRAS.
DITRAS produces a file with the following format: