Getting started

Setting up

First things first, clone the project repository from GitHub using the GitHub CLI:

$ gh repo clone VictorianHues/AgentBasedModeling

You can also clone the repository using HTTPS or SSH.

This project uses uv for Python environment management. To ensure consistent results, we recommend using uv when working with this project or re-running experiments. The following steps assume that you are using uv.

To reproduce our results, first confgure the Python environment and install all required dependencies:

$ uv sync

And then run your simulation code:

$ make

Important

If you are trying to recreate the results from the report, visit the Reproducing experiments section for details on how to run the experiments.

What next? See Contributing to contribute changes to the project.