Agent-Based Modelling with Python Mesa on flood adaptation

Welcome to the Agent-Based Modelling (ABM) repository for Q2 2023. This project focusses on the development of ABM-models to display protection motivation theory for flood adaptation

Table of Contents

• About the Project
• Getting Started
• Usage
• Contributing
• License
• Contact

About the Project

This repository contains the coursework and final assignment for the course. The main objective is to implement and explore agent-based models using Python and the Mesa framework.

Key Components

• Base Models: Initial models used as the foundation for more complex simulations.
• Final Assignment: Detailed report and implementation of the final project.
• Tutorials: Jupyter notebooks with step-by-step instructions on using the Mesa framework.

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

• Python 3.x
• Virtual environment tools (e.g., venv or virtualenv)

Installation

1. Clone the repo

   git clone https://github.com/thomaslautenb/ABM.git

2. Create a virtual environment

   python -m venv env

3. Activate the virtual environment
   • On Windows:

     .\env\Scripts�ctivate

   • On MacOS/Linux:

     source env/bin/activate

4. Install dependencies

   pip install -r requirements.txt

Usage

Run the Jupyter notebooks to explore the models and tutorials.

jupyter notebook

Navigate to the desired notebook and run the cells to see the model in action.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.