https://github.com/danielvartan/odd-protocol-template

📓 ODD Protocol Template
https://github.com/danielvartan/odd-protocol-template

agent-based-modeling complexity-science dynamic-systems generative-science individual-based-modeling modeling odd-protocol simulations

Last synced: about 1 year ago
JSON representation

📓 ODD Protocol Template

• Host: GitHub
• URL: https://github.com/danielvartan/odd-protocol-template
• Owner: danielvartan
• License: mit
• Created: 2025-02-27T20:44:13.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-28T07:41:47.000Z (over 1 year ago)
• Last Synced: 2025-03-09T23:13:29.885Z (about 1 year ago)
• Topics: agent-based-modeling, complexity-science, dynamic-systems, generative-science, individual-based-modeling, modeling, odd-protocol, simulations
• Language: TeX
• Homepage: https://danielvartan.github.io/odd-protocol-template/
• Size: 2.82 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# odd-protocol-template

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](http://creativecommons.org/publicdomain/zero/1.0/)

## Overview

🕹️🤖🧑‍🤝‍🧑🔄✨🌀🌍️🔎🔗🕸⏳

This repository offers a [LaTeX](https://www.latex-project.org/) template for the ODD protocol, a widely used standard for structuring and documenting Agent-Based Models (ABMs), developed by Volker Grimm et al. ([2006](https://www.sciencedirect.com/science/article/pii/S0304380006002043), [2020](https://www.doi.org/10.18564/jasss.4259)). Designed to streamline the adoption of ODD in technical and academic writing, this template provides a structured and visually intuitive framework.

Built on the LaTeX [`apa7`](https://ctan.org/pkg/apa7) class, the template ensures compliance with the formatting guidelines of the American Psychological Association ([APA](https://apastyle.apa.org/)) for manuscripts and bibliographic references.

To enhance clarity and usability, each section begins with **guiding questions**, highlighted using **color-coding** for quick reference. These questions are drawn from key sources, including Grimm et al. ([2010](https://www.doi.org/10.1016/j.envsoft.2010.03.021), [2020](https://www.doi.org/10.18564/jasss.4259)), Müller et al. ([2013](https://doi.org/10.1016/j.envsoft.2013.06.003)), and Railsback & Grimm ([2019](https://www.springer.com/gp/book/9783030041673)).

The template also includes placeholder texts with examples from Grimm et al. ([2020](https://www.doi.org/10.18564/jasss.4259)) to assist users in structuring their models. Additionally, it features a concise, visual summary of the protocol—*Visual ODD* (Szangolies, [2024](https://www.jasss.org/27/4/1.html))—for an alternative, more intuitive representation.

To keep the template broadly applicable, some elements from the extended ODD+D version proposed by Müller et al. ([2013](https://doi.org/10.1016/j.envsoft.2013.06.003)) were omitted. Redundant or overlapping questions were consolidated. These missing questions remains available in the appendix.

## Formats

The template is available in two formats:

- **LaTeX**: The primary format, available in this repository.

- **Google Docs**: Click [here](https://docs.google.com/document/d/1_oAGdrshKgWNWvXFXenaJSPeWxKhw0oOo9XzKpd2cXM/edit?usp=sharing) to access the template.

## License

[![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](http://creativecommons.org/publicdomain/zero/1.0/)

The code and template are licensed under the [Creative Commons CC0 1.0 Universal License](https://creativecommons.org/publicdomain/zero/1.0/). This means that you can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission.

## Citation

To cite this template in publications, use:

Vartanian, D. (2025). *ODD protocol template*. [https://github.com/danielvartan/odd-protocol-template](https://github.com/danielvartan/odd-protocol-template)

A BibTeX entry for LaTeX users is:

```bibtex

@Misc{,

  title = {ODD protocol template},

  author = {Daniel Vartanian},

  year = {2025},

  url = {https://github.com/danielvartan/odd-protocol-template}

}

```

## Contributing

Contributions are welcome! Whether you want to improve the code, enhance the template, or suggest new features, we appreciate your help.

If you want to know more about why and how to contribute to open source projects like this one, see this [Open Source Guide](https://opensource.guide/how-to-contribute/).