{
    "info": {
        "author": "Vincent Delecroix and W. Patrick Hooper",
        "author_email": "vincent.delecroix@u-bordeaux.fr",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Intended Audience :: Science/Research",
            "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Topic :: Scientific/Engineering :: Mathematics"
        ],
        "description": "sage-flatsurf\n=============\n\nThis is a software package for working with flat surfaces in\n`SageMath`_. The flatsurf documentation\nis available at http://www.labri.fr/perso/vdelecro/flatsurf/latest/\n\nWe aim for this module to support the investigation of geometric, algebraic and\ndynamical questions related to flat surfaces. By flat surface we mean a surface\nmodeled on the plane with monodromy given by similarities of the plane, though\ncurrent efforts are focused on translation surfaces and half-translation\nsurfaces.\n\nCurrently, the program can generate images of flat surfaces, plot straight-line\ntrajectories, deform surfaces through the SL(2,R) action, and compute Delaunay\ndecompositions. `SageMath`_ is used to perform exact arithmetic.\n\nThis software is open source released under GPL v2 (see the COPYING file). We\nwelcome any help to improve the package and especially to broaden the package's\nmathematical abilities.\n\nThe package is currently in active development. If you would like assistance\nin using the package, please contact the authors.\n\nThere is also a related `surface-dynamics`_.\nThe code in this repository is currently independent of the package but\nthe aim is to get them merged.\n\nInstalling the dependency\n-------------------------\n\nOur software depends on the `surface-dynamics`_.\nThe module is distributed on PyPI. To install it, you just need to run the\nfollowing command::\n\n    $ sage -pip install surface_dynamics [--user]\n\nThe --user option is optional and allows to install the module in your user\nspace (and does not require administrator rights).\n\nInstalling the module\n---------------------\n\nsage-flatsurf is available on PyPI at https://pypi.org/project/sage-flatsurf/. To install the\nreleased version of sage-flatsurf, run the following command::\n\n    $ sage -pip install sage-flatsurf [--user] [--upgrade]\n\nTo install the development version of sage-flatsurf, run::\n\n    $ sage -pip install git+https://github.com/videlec/sage-flatsurf [--user] [--upgrade]\n\nThe options `--user` and `--upgrade` are optional. The option `--user` make\nthe installation in your home directory instead of the Sage sources. The\noption `--upgrade` allows you to upgrade if the package is already installed.\n\nThis might fail because [git](https://git-scm.com/) is not installed on your computer\n(this is for example if you run Sage in Windows). In this situation you have two options.\nEither you install git. Or you download this project from the \"Clone or download\" drop\nmenu above (you should get a zip file). Then you need to run the command::\n\n    $ sage -pip install TARBALL_NAME [--user] [--upgrade]\n\nwhere `TARBALL_NAME` has to be replaced with the full path to your tarball. If you\nrun windows, it should be a cygwin path and will looks something like\n`/cygdrive/c/Users/You/Downloads/sage-flatsurf-master.zip`.\n\nThen you should be able to use the following within sage::\n\n    sage: import flatsurf.geometry.similarity_surface_generators as sfg\n    sage: T = sfg.translation_surfaces.regular_octagon()\n    sage: T\n    Translation surface built from 1 polygon\n    sage: T.stratum()\n    H_2(2)\n\nTo uninstall the package, you can do `$ sage -pip uninstall flatsurf`.\n\nRun the tests\n-------------\n::\n    $ sage -t --force-lib ARG\n\nwhere `ARG` is either a directory or file. In particular, to test all the\nfiles in the module just do::\n\n    $ sage -t --force-lib flatsurf\n\nTests on the master branch are automatically run through `Travis-CI <https://travis-ci.org/videlec/sage-flatsurf?branch=master>`_.\n\nPrimary Contributors\n--------------------\n\n* Vincent Delecroix (Bordeaux)\n* Pat Hooper (City College of New York and CUNY Graduate Center)\n\nWe welcome others to contribute.\n\nAcknowledgements\n----------------\n\n* This software project was created during a thematic semester at `ICERM <https://icerm.brown.edu>`_.\n* Hooper's contribution to the project has been supported by the National\n  Science Foundation under Grant Number DMS-1500965. Any opinions, findings,\n  and conclusions or recommendations expressed in this material are those of\n  the authors and do not necessarily reflect the views of the National\n  Science Foundation.\n* Delecroix' contribution to the project has been supported by OpenDreamKit,\n  Horizon 2020 European Research Infrastructures project #676541.\n\n.. _SageMath: http://sagemath.org\n.. _surface-dynamics:",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/videlec/sage-flatsurf",
        "keywords": "surfaces,dynamics,geometry,flat surfaces,Abelian differentials,quadratic differentials,Riemann surfaces",
        "license": "GNU General Public License, version 2",
        "maintainer": "",
        "maintainer_email": "",
        "name": "sage-flatsurf",
        "package_url": "https://pypi.org/project/sage-flatsurf/",
        "platform": "",
        "project_url": "https://pypi.org/project/sage-flatsurf/",
        "project_urls": {
            "Homepage": "https://github.com/videlec/sage-flatsurf"
        },
        "release_url": "https://pypi.org/project/sage-flatsurf/0.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "flat surfaces",
        "version": "0.1"
    },
    "last_serial": 5646560,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a8f28600cc6a48bddcc4c696a8039899",
                    "sha256": "67e516cf6cd99f29eb05010af44c7717cf39d347f8d0c31e2026dd728989c672"
                },
                "downloads": -1,
                "filename": "sage_flatsurf-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "a8f28600cc6a48bddcc4c696a8039899",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 135352,
                "upload_time": "2019-08-07T19:11:56",
                "url": "https://files.pythonhosted.org/packages/ac/dc/1d09a866defdc2c4125e7a132b0e8d7c85f976c6c3890754685009c25f34/sage_flatsurf-0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "a8f28600cc6a48bddcc4c696a8039899",
                "sha256": "67e516cf6cd99f29eb05010af44c7717cf39d347f8d0c31e2026dd728989c672"
            },
            "downloads": -1,
            "filename": "sage_flatsurf-0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a8f28600cc6a48bddcc4c696a8039899",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 135352,
            "upload_time": "2019-08-07T19:11:56",
            "url": "https://files.pythonhosted.org/packages/ac/dc/1d09a866defdc2c4125e7a132b0e8d7c85f976c6c3890754685009c25f34/sage_flatsurf-0.1.tar.gz"
        }
    ]
}