boids is a python 2.7 program that generates an animation of flocking boids which can be saved as a movie. This program is an implementation of the Boids model as described in the article by Reynolds \(1987\).

Please refer to CITATION for information regarding cite this package.

© Joshua D. Foster 2015-2016 under MIT License.

Install using pip with:

pip install -e git+https://github.com/jdfoster/boids.git#egg=boids

Alternatively, this repository can be cloned and then installed with:

python setup.py install

boids [--save/-s SAVE] [--config/-c CONFIG] [--generate/-g GENERATE]

All switches are optional. In the absence of any switch the program is use the default configuration to generate a windowed matplotlib animation.

Open a window to showing boids animation using the default values:

boids

Create and save a MP4 movie (boids.mp4) of the boids animation:

boids --save boids.mp4

Generate a configuration files (conf.yml) populated with the default settings:

boids --generate conf.yml

Using a modified configuration file (conf.yml) and override the defaults:

boids --config conf.yml