Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Schelling Readme.md #2406

Merged
merged 2 commits into from
Oct 24, 2024
Merged

Update Schelling Readme.md #2406

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e012ab
Update Readme.md
quaquel Oct 23, 2024
1e686fa
Update mesa/examples/basic/schelling/Readme.md
quaquel Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions mesa/examples/basic/schelling/Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,6 @@ The Schelling segregation model is a classic agent-based model, demonstrating ho

By default, the number of similar neighbors the agents need to be happy is set to 3. That means the agents would be perfectly happy with a majority of their neighbors being of a different color (e.g. a Blue agent would be happy with five Red neighbors and three Blue ones). Despite this, the model consistently leads to a high degree of segregation, with most agents ending up with no neighbors of a different color.

## Installation

To install the dependencies use pip and the requirements.txt in this directory. e.g.

```
$ pip install -r requirements.txt
```

## How to Run

To run the model interactively, in this directory, run the following command
Expand All @@ -32,8 +24,9 @@ To run the model with the grid displayed as an ASCII text, run `python run_ascii

## Files

* ``model.py``: Contains the Schelling model class
* ``agents.py``: Contains the Schelling agent class
* ``app.py``: Code for the interactive visualization.
* ``schelling.py``: Contains the agent class, and the overall model class.
* ``analysis.ipynb``: Notebook demonstrating how to run experiments and parameter sweeps on the model.

## Further Reading
Expand Down