Welcome to BharatSim on GitHub

BharatSim is an open-source collaborative project that was initially developed through a collaboration between Ashoka University and Thoughtworks, funded by the Bill & Melinda Gates Foundation. The ongoing development of BharatSim at Ashoka University is funded by Mphasis. BharatSim provides a distributed, multi-scale, simulation framework for agent-based models. It was originally designed to model the epidemiological dynamics of the COVID-19 pandemic in India, including the social determinants of disease. BharatSim is easily extended to describe other communicable as well as non-communicable diseases. In addition to disease modelling, it may be used to study a wide range of social phenomena.

This organization brings together the main repositories used to develop, build, test, and use BharatSim:

• BharatSim contains the source-code for the BharatSim simulation engine. Documentation on how to download and use BharatSim is available here. This repository also serves as a hub for raising issues about using the simulation engine.
• BharatSim-Visualisation contains the source-code for the BharatSim visualisation engine. This repository also serves as a hub for raising issues about using the visualisation engine.
• documentation contains the source-code for the BharatSim documentation, hosted on ReadTheDocs here. If you wish to contribute to the documentation, please read the Contributing section of the README.md file.
• bharatsim.github.io contains the sources of the BharatSim website.
• bharatsim-showcase contains the source-code for models described in the paper BharatSim: An agent-based modelling framework for India.

• Write to us at [email protected].

• Open a new GitHub pull request if you think your addition is worth being included in the relevant repository. If this contribution concerns the documentation, head to the documentation repository.
• Ensure that the pull request description clearly describes the problem and solution or the new addition. Include the relevant issue number if applicable.

• Ensure that this bug was not already reported by searching on GitHub in BharatSim issues.
• If you're unable to find an open issue addressing your problem, open a new one in the corresponding repository. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or a test case demonstrating the expected behavior that is not occurring.

• If you have any about how to use BharatSim, first go through the documentation on the website.
• If you need more assistance, write to us at [email protected].