Metadata-Version: 2.1
Name: sage-flatsurf
Version: 0.4.0
Summary: flat surfaces
Home-page: https://github.com/videlec/sage-flatsurf
Author: Vincent Delecroix and W. Patrick Hooper
Author-email: vincent.delecroix@u-bordeaux.fr
License: GNU General Public License, version 2
Description: sage-flatsurf
        =============
        
        This is a software package for working with flat surfaces in `SageMath`_.
        For the documentation, see the Links section below.
        
        We aim for this package to support the investigation of geometric, algebraic and
        dynamical questions related to flat surfaces. By flat surface we mean a surface
        modeled on the plane with monodromy given by similarities of the plane, though
        current efforts are focused on translation surfaces and half-translation
        surfaces.
        
        Currently, the package can:
        
        - generate images of flat surfaces
        
        - compute and plot straight-line trajectories
        
        - deform translation surfaces through the GL(2,R) action and
          compute GL(2,R)-orbit closures (the latter requires `libflatsurf`_)
        
        - compute Delaunay decompositions.
        
        `SageMath`_, `e-antic`_ and `exact-real`_ are used to perform exact arithmetic.
        
        This package is free software, released under the GPL v2 (see the ``COPYING``
        file). We welcome any help to improve the package and especially to broaden
        the package's mathematical abilities.
        
        The package is currently in active development. If you would like assistance
        in using it, please contact the authors.
        
        Links
        -----
        
        * Documentation: https://flatsurf.github.io/sage-flatsurf/
        
        * Page on the Python package index: https://pypi.org/project/sage-flatsurf/
        
        * Development website: https://github.com/flatsurf/sage-flatsurf/
        
        Dependencies
        ------------
        
        - `surface_dynamics`_
        - (optional) `libflatsurf`_
        
        Installing the package
        ----------------------
        
        Since sage-flatsurf is available on PyPI (see Links section above),
        the released version of sage-flatsurf can be installed by running the following command::
        
            $ sage --pip install sage-flatsurf [--user] [--upgrade]
        
        To install the development version of sage-flatsurf, run instead::
        
            $ sage --pip install git+https://github.com/flatsurf/sage-flatsurf [--user] [--upgrade]
        
        The options ``--user`` and ``--upgrade`` are optional; ``--user`` is to
        perform the installation in your user home instead of in the Sage sources;
        ``--upgrade`` is to upgrade the package in case it is already installed.
        
        This might fail if `Git <https://git-scm.com/>`_ is not installed on your
        computer (which could happen for example with certain versions of Sage in Windows).
        In this situation you have two options. Either you install Git. Or you download
        this project from the "Clone or download" drop-down menu above (you should get
        a zip file). Then you need to run the command::
        
            $ sage --pip install TARBALL_NAME [--user] [--upgrade]
        
        where ``TARBALL_NAME`` has to be replaced with the full path to your tarball.
        Under Windows, it should be a Cygwin path and will look something like
        ``/cygdrive/c/Users/You/Downloads/sage-flatsurf-master.zip``.
        
        Then you should be able to use the following within Sage::
        
            sage: import flatsurf.geometry.similarity_surface_generators as sfg
            sage: T = sfg.translation_surfaces.regular_octagon()
            sage: T
            Translation surface built from 1 polygon
            sage: T.stratum()
            H_2(2)
        
        To uninstall the package, you can do::
        
            $ sage --pip uninstall flatsurf
        
        Run the tests
        -------------
        
        Running the tests of a specific file or directory is done by running::
        
            $ sage -t --force-lib ARG
        
        where ``ARG`` is either a directory or file. In particular, to test all the
        files in the module just do::
        
            $ sage -t --force-lib flatsurf
        
        Related projects
        ----------------
        
        There are several related projects
        
        * `surface_dynamics`_ (SageMath module): more focused on dynamics (interval
          exchanges)
        
        * `veerer`_ (Python module): to handle specific triangulations of
          half-translation surfaces
        
        * `libflatsurf`_: (C++ library with Python interface) computing GL(2,R)-orbit
          closures of translation surfaces
        
        * `curver`_ (Python module): computation in the curve complex and the mapping
          class group
        
        Contributors
        ------------
        
        * Vincent Delecroix (Bordeaux)
        * Pat Hooper (City College of New York and CUNY Graduate Center)
        * Julian Rüth
        
        We welcome others to contribute.
        
        Acknowledgements
        ----------------
        
        * This software project was created during a thematic semester at
          `ICERM <https://icerm.brown.edu>`_.
        * Hooper's contribution to the project has been supported by the National
          Science Foundation under Grant Number DMS-1500965. Any opinions, findings,
          and conclusions or recommendations expressed in this material are those of
          the authors and do not necessarily reflect the views of the National
          Science Foundation.
        * Delecroix's contribution to the project has been supported by OpenDreamKit,
          Horizon 2020 European Research Infrastructures project #676541.
        
        .. _SageMath: https://www.sagemath.org
        .. _surface_dynamics: https://github.com/flatsurf/surface_dynamics
        .. _veerer: https://gitlab.com/videlec/veerer/
        .. _libflatsurf: https://github.com/flatsurf/flatsurf
        .. _e-antic: https://github.com/flatsurf/e-antic
        .. _exact-real: https://github.com/flatsurf/exact-real
        .. _curver: https://github.com/MarkCBell/curver
        
Keywords: surfaces,dynamics,geometry,flat surfaces,Abelian differentials,quadratic differentials,Riemann surfaces
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Mathematics
Description-Content-Type: text/x-rst
