Skip to content

Commit 9d0d6c0

Browse files
committed
Add Readme for examples
Add a Readme for the Example folder, largely taken from the mesa-examples Readme.
1 parent 2270116 commit 9d0d6c0

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

examples/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Mesa core examples
2+
This folder contains a collection of example models built using Mesa. These core models are maintained by the Mesa team and are intended to demonstrate the capabilities of Mesa.
3+
4+
More user examples and showcases can be found in the [mesa-examples](https://github.com/projectmesa/mesa-examples) repository.
5+
6+
## Basic Examples
7+
The basic examples are relatively simple and only use stable Mesa features. They are good starting points for learning how to use Mesa.
8+
9+
### [Boltzmann Wealth Model](basic/boltzmann_wealth_model)
10+
Completed code to go along with the [tutorial](https://mesa.readthedocs.io/latest/tutorials/intro_tutorial.html) on making a simple model of how a highly-skewed wealth distribution can emerge from simple rules.
11+
12+
### [Boids Flockers Model](basic/boid_flockers)
13+
[Boids](https://en.wikipedia.org/wiki/Boids)-style flocking model, demonstrating the use of agents moving through a continuous space following direction vectors.
14+
15+
### [Conway's Game of Life](basic/conways_game_of_life)
16+
Implementation of [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life), a cellular automata where simple rules can give rise to complex patterns.
17+
18+
### [Schelling Segregation Model](basic/schelling)
19+
Mesa implementation of the classic [Schelling segregation](http://nifty.stanford.edu/2014/mccown-schelling-model-segregation/) model.
20+
21+
### [Virus on a Network Model](basic/virus_on_network)
22+
This model is based on the NetLogo [Virus on a Network](https://ccl.northwestern.edu/netlogo/models/VirusonaNetwork) model.
23+
24+
## Advanced Examples
25+
The advanced examples are more complex and may use experimental Mesa features. They are good starting points for learning how to build more complex models.
26+
27+
### [Epstein Civil Violence Model](advanced/epstein_civil_violence)
28+
Joshua Epstein's [model](http://www.uvm.edu/~pdodds/files/papers/others/2002/epstein2002a.pdf) of how a decentralized uprising can be suppressed or reach a critical mass of support.
29+
30+
### [Demographic Prisoner's Dilemma on a Grid](advanced/pd_grid)
31+
Grid-based demographic prisoner's dilemma model, demonstrating how simple rules can lead to the emergence of widespread cooperation -- and how a model activation regime can change its outcome.
32+
33+
### [Sugarscape Model with Traders](advanced/sugarscape_g1mt)
34+
This is Epstein & Axtell's Sugarscape model with Traders, a detailed description is in Chapter four of *Growing Artificial Societies: Social Science from the Bottom Up (1996)*. The model shows how emergent price equilibrium can happen via decentralized dynamics.
35+
36+
### [Wolf-Sheep Predation Model](advanced/wolf_sheep)
37+
Implementation of an ecological model of predation and reproduction, based on the NetLogo [Wolf Sheep Predation](http://ccl.northwestern.edu/netlogo/models/WolfSheepPredation) model.

0 commit comments

Comments
 (0)