
Flipper is a program for computing the action of mapping classes on
laminations on punctured surfaces using ideal triangulation coordinates.

It can decide the Nielsen--Thurston type of a given mapping class and,
for pseudo-Anosov mapping classes, construct a layered, veering
triangulation of their mapping torus, as described by Agol.

Flipper can be run as a Python 2, Python 3 or Sage Python module. Currently
it is fastest as a Sage Python module.


Flipper is available on the Python Package Index (PyPI). The preferred method
for installing the latest stable release is to use pip:
	> python -m pip install flipper-triangulation --user --upgrade
Pip can be installed using get-pip.py from
	http://pip.readthedocs.org/en/latest/installing.html
and is included in Python 3.4 by default.

Flipper can also be installed through the older easy_install:
	> python -m easy_install flipper-triangulation


For more information about installing and using flipper see "A users
guide to flipper". Open by running:
	> python -m flipper.doc


If you find flipper useful in your research, please consider citing it.
A suggested reference is:
	Mark Bell. flipper (Computer Software).
	https://bitbucket.org/Mark_Bell/flipper/, 2013--2014. Version <<version>>
or the BibTeX entry:
	@Misc{flipper,
		author = {Bell, Mark},
		title = {flipper (Computer Software)},
		howpublished = {\url{https://bitbucket.org/Mark_Bell/flipper/}},
		year = {2013--2014},
		note = {Version <<version number used>>}
	}
or the BibItem:
	\bibitem{flipper} Mark bell: \emph{flipper (Computer Software)},
		\url{https://bitbucket.org/Mark_Bell/flipper/}}, (2013--2014),
		Version <<version number used>>


Quick install, test and start the GUI as a Python module:
> python -m pip install flipper-triangulation --user --upgrade
> python -m flipper.test
> python -m flipper.app

Quick install, test and start the GUI as a Sage module:
> sage -python -m pip install flipper-triangulation --user --upgrade
> sage -python -m flipper.test
> sage -python -m flipper.app


The latest development version of flipper is available from:
	https://bitbucket.org/Mark_Bell/flipper
Alternatively, you can clone the mercurial repository directly using
the command:
	> hg clone https://bitbucket.org/mark_bell/flipper

