<p align="center">
<img alt="logo" src="https://user-images.githubusercontent.com/373765/255104540-451305f4-42e4-4c16-aee1-b38a0e6d41ad.svg">
</p>
<h1><p align="center">Surface dynamics</p></h1>
The ``surface-dynamics`` package for SageMath adds functionality related to
interval exchange transformations, translation surfaces, mapping classes
and more. It is based on `SageMath <https://www.sagemath.org>`_ and relies
heavily on:
* gmp or mpir for arbitrary precision arithmetic
* PARI/GP for number field computations
* GAP for finite groups representation and permutation groups
* PPL (Parma Polyhedra Library) and LattE (Lattice point Enumeration)
for polytope computations
## Prerequisites
Installing ``surface-dynamics`` requires a working Sage installation (with
Cython and gcc). Installing the optional SageMath packages ``gap_packages``,
and ``latte_int`` is recommended and will improve or extend the functionality
in ``surface-dynamics``. The optional package ``database_gap`` is also
recommended if using SageMath < 8.6 (in SageMath 8.6 it was merged partly
into the ``gap`` and partly into the ``gap_packages`` packages).
## Installation
The module is distributed on PyPI and is easily installed through the
Python package manager ``pip``. If you downloaded a binary from the SageMath
website (including the Cygwin version running on Windows) or compiled
from source, run the following command::
$ sage -pip install surface-dynamics [--user]
The ``--user`` option is optional and allows to install the module in your
user space (and does not require administrator rights).
If you use Debian or Ubuntu and you installed Sage through the operating
system's package manager (that is, the package ``sagemath``), run these
two commands::
$ source /usr/share/sagemath/bin/sage-env
$ pip install surface-dynamics --user
If you use Arch Linux, you need to install from source (see next section).
## Install and use source version
This section provides detailed instructions on how to download, modify
and install the development version of ``surface-dynamics``. In all commands,
* ``PIP`` has to be replaced by either ``pip``, ``pip2``, or ``sage -pip``
* ``PYTHON`` has to be replaced by either ``python``, ``python2`` or ``sage -python``
If you are an Arch Linux user with the ``sagemath`` package installed, use
``PIP=pip2`` and ``PYTHON=python2``. If you downloaded SageMath as a tarball
or installed it from source use ``PIP='sage -pip'`` and ``PYTHON='sage -python'``.
You can install the latest development version in one line with::
$ PIP install git+https://github.com/flatsurf/surface-dynamics [--user]
As before, the ``--user`` option is optional and when specified will
install the module in your user space.
You can also perform a two stage installation that will allow you to
modify the source code. The first step is to clone the repository::
$ git clone https://github.com/flatsurf/surface-dynamics
The above command creates a repository ``surface-dynamics`` with the source code,
documentation and miscellaneous files. You can then change to the directory
thus created and install the surface dynamics module with::
$ cd surface-dynamics
$ PIP install . [--user]
Do not forget the ``.`` that refers to the current directory.
When you don't want to install the package or you are testing some
modifications to the source code, a more convenient way of using
surface dynamics is to do everything locally. To do so, you need
to compile the module in place via::
$ PYTHON setup.py build_ext --inplace
Once done, you can import the ``surface_dynamics`` module. To check that you
are actually using the right module (i.e. the local one) you can do in a
SageMath session::
sage: import surface_dynamics
sage: surface_dynamics.__path__ # random
['/home/you/surface-dynamics/surface_dynamics/']
The result of the command must correspond to the path of the repository
created by the command ``git clone`` given above. The compilation step
``PYTHON setup.py build_ext`` has to be redone each time you modify
a C or Cython source file (i.e. with ``.c``, ``.h``, ``.pxd`` or ``.pyx``
extension). In other words, it is not needed if you only
modify or create Python files (i.e. ``.py`` files).
If you wish to install your custom version of ``surface-dynamics``
just use ``PIP`` as indicated before.
## Documentation
* short tutorial: https://www.labri.fr/perso/vdelecro/flatsurf.html
* complete module documentation: https://flatsurf.github.io/surface-dynamics/
## Check
After installing ``surface-dynamics``, check that it works by launching Sage
and typing the following commands. You should get the same
output as below. ::
sage: from surface_dynamics.all import *
sage: o = Origami('(1,2)', '(1,3)')
sage: o
(1,2)(3)
(1,3)(2)
sage: o.sum_of_lyapunov_exponents()
4/3
sage: o.lyapunov_exponents_approx() # abs tol 0.05
[0.33441823619678734]
sage: o.veech_group()
Arithmetic subgroup with permutations of right cosets
S2=(2,3)
S3=(1,2,3)
L=(1,2)
R=(1,3)
sage: q = QuadraticStratum(1, 1, 1, 1)
sage: q.orientation_cover()
H_5(2^4)
sage: q.components()
[Q_2(1^4)^hyp]
sage: c = q.components()[0]
sage: c
Q_2(1^4)^hyp
sage: c.orientation_cover_component()
H_5(2^4)^odd
sage: AbelianStrata(genus=3).list()
[H_3(4), H_3(3, 1), H_3(2^2), H_3(2, 1^2), H_3(1^4)]
sage: O = OrigamiDatabase()
sage: q = O.query(("stratum", "=", AbelianStratum(2)), ("nb_squares", "=", 5))
sage: q.number_of()
2
sage: for o in q:
....: print("%s\n- - - - - - - -" % o)
(1)(2)(3)(4,5)
(1,2,3,4)(5)
- - - - - - - -
(1)(2)(3,4,5)
(1,2,3)(4)(5)
- - - - - - - -
sage: Q12_reg = QuadraticStratum(12).regular_component()
sage: Q12_reg.lyapunov_exponents_H_plus(nb_iterations=2**20) # abs tol 0.05
[0.6634, 0.4496, 0.2305, 0.0871]
sage: Q12_reg.lyapunov_exponents_H_minus(nb_iterations=2**20) # abs tol 0.05
[1.0000, 0.3087, 0.1192]
## Installing development version - source code
The development webpage is
* https://github.com/flatsurf/surface-dynamics
Assuming you have the program ``git`` on your computer, you can install the
development version with the command::
$ sage -pip install git+https://github.com/flatsurf/surface-dynamics [--user]
## Contact
Your comments and help are welcome: vincent.delecroix@labri.fr
For problems with macOS: samuel.lelievre@gmail.com
## Authors
* Vincent Delecroix: maintainer
* Samuel Lelièvre: origami and permutation representatives for quadratic strata
* Charles Fougeron: Lyapunov exponents for strata coverings
* Luke Jeffreys: single cylinder representatives for strata of Abelian
differentials
* Ivan Yakovlev: Masur-Veech volumes of connected components of minimal strata
of Abelian differentials
## How to cite this project
If you have used this project for please cite us
as described [on our zenodo site](https://zenodo.org/badge/latestdoi/347440823).
## Versions
The first release of ``surface-dynamics`` as a sagemath spkg happened on the
30th of july 2015. Versions are now track on [zenodo](https://zenodo.org/badge/latestdoi/347440823).
Raw data
{
"_id": null,
"home_page": "",
"name": "surface-dynamics",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "surfaces,dynamics,geometry,flat surfaces,Abelian differentials,quadratic differentials,Riemann surfaces",
"author": "Vincent Delecroix",
"author_email": "vincent.delecroix@u-bordeaux.fr",
"download_url": "https://files.pythonhosted.org/packages/ab/d6/618209b51ae80f06b3ea2da871d9dfe322262928b8ba35ff04a778f61d73/surface-dynamics-0.5.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img alt=\"logo\" src=\"https://user-images.githubusercontent.com/373765/255104540-451305f4-42e4-4c16-aee1-b38a0e6d41ad.svg\">\n</p>\n\n<h1><p align=\"center\">Surface dynamics</p></h1>\n\nThe ``surface-dynamics`` package for SageMath adds functionality related to\ninterval exchange transformations, translation surfaces, mapping classes\nand more. It is based on `SageMath <https://www.sagemath.org>`_ and relies\nheavily on:\n\n* gmp or mpir for arbitrary precision arithmetic\n* PARI/GP for number field computations\n* GAP for finite groups representation and permutation groups\n* PPL (Parma Polyhedra Library) and LattE (Lattice point Enumeration)\n for polytope computations\n\n## Prerequisites\n\nInstalling ``surface-dynamics`` requires a working Sage installation (with\nCython and gcc). Installing the optional SageMath packages ``gap_packages``,\nand ``latte_int`` is recommended and will improve or extend the functionality\nin ``surface-dynamics``. The optional package ``database_gap`` is also\nrecommended if using SageMath < 8.6 (in SageMath 8.6 it was merged partly\ninto the ``gap`` and partly into the ``gap_packages`` packages).\n\n## Installation\n\nThe module is distributed on PyPI and is easily installed through the\nPython package manager ``pip``. If you downloaded a binary from the SageMath\nwebsite (including the Cygwin version running on Windows) or compiled\nfrom source, run the following command::\n\n $ sage -pip install surface-dynamics [--user]\n\nThe ``--user`` option is optional and allows to install the module in your\nuser space (and does not require administrator rights).\n\nIf you use Debian or Ubuntu and you installed Sage through the operating\nsystem's package manager (that is, the package ``sagemath``), run these\ntwo commands::\n\n $ source /usr/share/sagemath/bin/sage-env\n $ pip install surface-dynamics --user\n\nIf you use Arch Linux, you need to install from source (see next section).\n\n## Install and use source version\n\nThis section provides detailed instructions on how to download, modify\nand install the development version of ``surface-dynamics``. In all commands,\n\n* ``PIP`` has to be replaced by either ``pip``, ``pip2``, or ``sage -pip``\n* ``PYTHON`` has to be replaced by either ``python``, ``python2`` or ``sage -python``\n\nIf you are an Arch Linux user with the ``sagemath`` package installed, use\n``PIP=pip2`` and ``PYTHON=python2``. If you downloaded SageMath as a tarball\nor installed it from source use ``PIP='sage -pip'`` and ``PYTHON='sage -python'``.\n\nYou can install the latest development version in one line with::\n\n $ PIP install git+https://github.com/flatsurf/surface-dynamics [--user]\n\nAs before, the ``--user`` option is optional and when specified will\ninstall the module in your user space.\n\nYou can also perform a two stage installation that will allow you to\nmodify the source code. The first step is to clone the repository::\n\n $ git clone https://github.com/flatsurf/surface-dynamics\n\nThe above command creates a repository ``surface-dynamics`` with the source code,\ndocumentation and miscellaneous files. You can then change to the directory\nthus created and install the surface dynamics module with::\n\n $ cd surface-dynamics\n $ PIP install . [--user]\n\nDo not forget the ``.`` that refers to the current directory.\n\nWhen you don't want to install the package or you are testing some\nmodifications to the source code, a more convenient way of using\nsurface dynamics is to do everything locally. To do so, you need\nto compile the module in place via::\n\n $ PYTHON setup.py build_ext --inplace\n\nOnce done, you can import the ``surface_dynamics`` module. To check that you\nare actually using the right module (i.e. the local one) you can do in a\nSageMath session::\n\n sage: import surface_dynamics\n sage: surface_dynamics.__path__ # random\n ['/home/you/surface-dynamics/surface_dynamics/']\n\nThe result of the command must correspond to the path of the repository\ncreated by the command ``git clone`` given above. The compilation step\n``PYTHON setup.py build_ext`` has to be redone each time you modify\na C or Cython source file (i.e. with ``.c``, ``.h``, ``.pxd`` or ``.pyx``\nextension). In other words, it is not needed if you only\nmodify or create Python files (i.e. ``.py`` files).\n\nIf you wish to install your custom version of ``surface-dynamics``\njust use ``PIP`` as indicated before.\n\n## Documentation\n\n* short tutorial: https://www.labri.fr/perso/vdelecro/flatsurf.html\n* complete module documentation: https://flatsurf.github.io/surface-dynamics/\n\n## Check\n\nAfter installing ``surface-dynamics``, check that it works by launching Sage\nand typing the following commands. You should get the same\noutput as below. ::\n\n sage: from surface_dynamics.all import *\n sage: o = Origami('(1,2)', '(1,3)')\n sage: o\n (1,2)(3)\n (1,3)(2)\n sage: o.sum_of_lyapunov_exponents()\n 4/3\n sage: o.lyapunov_exponents_approx() # abs tol 0.05\n [0.33441823619678734]\n sage: o.veech_group()\n Arithmetic subgroup with permutations of right cosets\n S2=(2,3)\n S3=(1,2,3)\n L=(1,2)\n R=(1,3)\n sage: q = QuadraticStratum(1, 1, 1, 1)\n sage: q.orientation_cover()\n H_5(2^4)\n sage: q.components()\n [Q_2(1^4)^hyp]\n sage: c = q.components()[0]\n sage: c\n Q_2(1^4)^hyp\n sage: c.orientation_cover_component()\n H_5(2^4)^odd\n\n sage: AbelianStrata(genus=3).list()\n [H_3(4), H_3(3, 1), H_3(2^2), H_3(2, 1^2), H_3(1^4)]\n\n sage: O = OrigamiDatabase()\n sage: q = O.query((\"stratum\", \"=\", AbelianStratum(2)), (\"nb_squares\", \"=\", 5))\n sage: q.number_of()\n 2\n sage: for o in q:\n ....: print(\"%s\\n- - - - - - - -\" % o)\n (1)(2)(3)(4,5)\n (1,2,3,4)(5)\n - - - - - - - -\n (1)(2)(3,4,5)\n (1,2,3)(4)(5)\n - - - - - - - -\n sage: Q12_reg = QuadraticStratum(12).regular_component()\n sage: Q12_reg.lyapunov_exponents_H_plus(nb_iterations=2**20) # abs tol 0.05\n [0.6634, 0.4496, 0.2305, 0.0871]\n sage: Q12_reg.lyapunov_exponents_H_minus(nb_iterations=2**20) # abs tol 0.05\n [1.0000, 0.3087, 0.1192]\n\n## Installing development version - source code\n\nThe development webpage is\n\n* https://github.com/flatsurf/surface-dynamics\n\nAssuming you have the program ``git`` on your computer, you can install the\ndevelopment version with the command::\n\n $ sage -pip install git+https://github.com/flatsurf/surface-dynamics [--user]\n\n## Contact\n\nYour comments and help are welcome: vincent.delecroix@labri.fr\n\nFor problems with macOS: samuel.lelievre@gmail.com\n\n## Authors\n\n* Vincent Delecroix: maintainer\n* Samuel Leli\u00e8vre: origami and permutation representatives for quadratic strata\n* Charles Fougeron: Lyapunov exponents for strata coverings\n* Luke Jeffreys: single cylinder representatives for strata of Abelian\n differentials\n* Ivan Yakovlev: Masur-Veech volumes of connected components of minimal strata\n of Abelian differentials\n\n## How to cite this project\n\nIf you have used this project for please cite us\nas described [on our zenodo site](https://zenodo.org/badge/latestdoi/347440823).\n\n## Versions\n\nThe first release of ``surface-dynamics`` as a sagemath spkg happened on the\n30th of july 2015. Versions are now track on [zenodo](https://zenodo.org/badge/latestdoi/347440823).\n",
"bugtrack_url": null,
"license": "GPL v2",
"summary": "Dynamics on surfaces",
"version": "0.5.0",
"project_urls": {
"Bug Tracker": "https://github.com/flatsurf/surface-dynamics/issues",
"Documentation": "https://flatsurf.github.io/surface-dynamics/",
"Source Code": "https://github.com/flatsurf/surface-dynamics"
},
"split_keywords": [
"surfaces",
"dynamics",
"geometry",
"flat surfaces",
"abelian differentials",
"quadratic differentials",
"riemann surfaces"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "abd6618209b51ae80f06b3ea2da871d9dfe322262928b8ba35ff04a778f61d73",
"md5": "fb6023a1197d849c0f05e22689cac455",
"sha256": "0027b615289769c7aadc07b39b1ce2d673f613f4eecec26b06411d037ddd03be"
},
"downloads": -1,
"filename": "surface-dynamics-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "fb6023a1197d849c0f05e22689cac455",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8372233,
"upload_time": "2024-03-15T12:44:44",
"upload_time_iso_8601": "2024-03-15T12:44:44.671829Z",
"url": "https://files.pythonhosted.org/packages/ab/d6/618209b51ae80f06b3ea2da871d9dfe322262928b8ba35ff04a778f61d73/surface-dynamics-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-15 12:44:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "flatsurf",
"github_project": "surface-dynamics",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "surface-dynamics"
}
JSON
