This Python implementation tries to model school choice and resulting school segregation based on the work of Schelling (1971) and Stoica & Flache (2014).
It's required to firstly install GDAL on your computer.
To install the package, run pip install compass-school
.
To run a demo with web-based GUI, run python run.py
from the root directory of the project. This will start a local server to automatically open your web browser and show the program as a webpage. If not seeing the webpage open, manually input http://localhost:5004/
in the link bar.
Install pdoc3 if you haven't already done so. Browse to the compassproject folder in your terminal and run pdoc3 --html --force --output-dir docs compass
. The documentation should be updated now.
The repository consists of:
Information on how to run the code here.
Setup a virtualenv with the required dependencies.
$ python -m venv env
$ . env/bin/activate
$ pip install -r requirements.txt
Install the package locally (in developement, or editing mode):
$ pip install -e .
Then run the tests with:
$ pytest
Some profiling result can be found in this notebook. Also, some scaling graphs can be found in this notebook.