Database of New Rochelle, NY, US and code for its conversion into an agent-based computational model
Details about the code and usage examples can be found in the documentation, and the manual.
The directories are as follows:
src- python source filestools- python scripts for general use throughout the repositorytestsandinput_verification- tests developed for this codeNewRochelle- town database and Census datacreated_communities- final populations to be used in ABMcovid_model- final population used in the ABM code
Specific features of all directories are available in their own README files.
The database, located in NewRochelle directory consists of Census data and manually collected information on all the public and residential buildings in New Rochelle, NY, US. The building information, original and preprocessed for converting into an ABM is located in the database directory. Preprocessed relevant census data is in the census_data directory.
The code is fully written in Python, and was ran with Python 3.6. Other 3.X versions should work as well.
The code was developed and tested on MacOS and Linux, some of its parts may not be compatible with Windows.
Tests consisted of checking generated community structure with Python and MATLAB scripts. Visual verification was also part of the process. In the near future the tests will be better decsribed and automated.
Documentation and a user manual will soon be provided.
We encourage the users and developers to report any issues, including platform incompatibility and failed tests on our GitHub page or directly, by sending us an email.
If you find this software useful, consider citing
Truszkowska A, Behring B, Hasanyan J, Zino L, Butail S, Caroppo E, Jiang ZP, Rizzo A, Porfiri M. COVID‐19 Modeling: High‐Resolution Agent‐Based Modeling of COVID‐19 Spreading in a Small Town (Adv. Theory Simul. 3/2021). Advanced Theory and Simulations. 2021 Mar;4(3):2170005.