Welcome to the surface-dynamics documentation!¶
Installation¶
The basic way to install the surface-dynamics package is via the pip Python installer that comes with your SageMath installation.
If you installed Sage from a downloaded binary (including the Cygwin version on Windows) or if you compiled Sage from source, then run:
$ sage -pip install surface-dynamics
You might want (or need) to provide the option --user
to this command in order
to install surface-dynamics in your home directory and keep intact your SageMath
installation.
In case you use the sagemath package in a Debian or Ubuntu system you need to perform a two step installation:
$ source /usr/share/sagemath/bin/sage-env
$ sage -pip install surface-dynamics --user
If you use the sagemath package from Archlinux, run:
$ pip3 install git+https://github.com/flatsurf/surface-dynamics --user
Other sources of information:
short tutorial: https://www.labri.fr/perso/vdelecro/flatsurf.html
development webpage (including source code): https://github.com/flatsurf/surface-dynamics
Walk through¶
Module documentation¶
References¶
Citation¶
To cite the library, follow the instructions on our zenodo website.