SchoolChoice DA

Python package developed by TetherEducation with the main implementation of the Galey-Shapley algorithm (deferred acceptance).

Installation

git clone https://github.com/TetherEducation/SchoolChoice_da
pip install -e schoolchoice_da

or alternatively

pip install git+https://github.com/TetherEducation/SchoolChoice_da

Getting started

Read 'Inputs_description.md' and make sure you have all required files in the appropriate format. Open 'run_algorithm.py' with your editor and follow further instructions in order to apply the DA algorithm.

Contributing

Be mindful when trying to improve or add to this code base as you could break things that are running, this means that in general thinking should precede typing.

Additionally strive for succinctness and to avoid dependencies on third party packages if possible - keeping things lightweight is a good thing.