Docs/epstein civil violence tutorial

[gamal1osama]

Summary

Added a tutorial for the Epstein Civil Violence example and linked it in getting_started.md. The example already existed in the repo but had no tutorial like the negotiation one, so new users had no guided entry point into it.

Motive

Looking at getting_started.md, the Tutorials section only covered the first model and the negotiation example. The Epstein civil violence example is one of the more interesting ones in the repo — it has spatial dynamics, two different agent types, tools, emergent behavior — but there was nothing walking people through it. Felt like a gap worth closing.

Implementation

• Created epstein_civil_violence_tutorial.md modeled after the negotiation tutorial structure
• Pulled content from the existing Readme.md and source files inside epstein_civil_violence
• The tutorial covers the Citizen and Cop classes, their tools (change_state, arrest_citizen, move_one_step), the model setup, and the core rebellion mechanics (grievance formula, arrest probability)
• Also added a section explaining why this model needs a spatial grid, since that's a notable difference from the negotiation example
• Updated getting_started.md to link the new tutorial in the Tutorials section

Usage Examples

Users can follow the tutorial at epstein_civil_violence_tutorial.md to build the model step by step. The full runnable example is still at epstein_civil_violence.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gamal1osama]

@wang-boyu, @colinfrisch can i get review when you have a time

[wang-boyu]

Thanks for the work and yes we will. Recently we're flooded with PRs (not just this repo) and we're trying to keep up with them. Sorry about that.