Skip to content

Fix Schelling documentation #197

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

Merged
merged 2 commits into from
Mar 30, 2016
Merged

Fix Schelling documentation #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a7c2e6
Updating the Schelling launch instructions
dmasad Mar 29, 2016
7d725b3
Fix Schelling.py docstring
dmasad Mar 29, 2016
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
26 changes: 5 additions & 21 deletions examples/Schelling/Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,13 @@
A simple implementation of a Schelling segregation model.


Implemented here to test / demonstrate several Mesa concepts and features:
- This version demonstrates the ASCII renderer.

Implemented here to test / demonstrate several Mesa concepts and features.

### To run this example

* Launch the model
```python
python Schelling.py
* Launch the model with the browser visualization:
```sh
python SchellingModular.py
```
* Visit your browser: http://127.0.0.1:8888/
* Open your browser to: http://127.0.0.1:8888/
* In your browser hit *reset*, then *run*


To use with iPython, run this code from the command line, e.g.
$ ipython -i Schelling.py

viz is the visualization wrapper around
To print the current state of the model:
viz.render()

To advance the model by one step and print the new state:
viz.step()

To advance the model by e.g. 10 steps and print the new state:
viz.step_forward(10)
15 changes: 0 additions & 15 deletions examples/Schelling/Schelling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,6 @@
=========================================

A simple implementation of a Schelling segregation model.

This version demonstrates the ASCII renderer.
To use, run this code from the command line, e.g.
$ ipython -i Schelling.py

viz is the visualization wrapper around
To print the current state of the model:
viz.render()

To advance the model by one step and print the new state:
viz.step()

To advance the model by e.g. 10 steps and print the new state:
viz.step_forward(10)

'''

from __future__ import division # For Python 2.x compatibility
Expand Down