Metadata-Version: 2.1
Name: sage_flatsurf
Version: 0.5.2
Summary: Flat surfaces in SageMath
Home-page: https://github.com/flatsurf/sage-flatsurf
Author: Vincent Delecroix, W. Patrick Hooper, and Julian Rüth
Author-email: contact@flatsurf.org
License: GNU General Public License, version 2
Keywords: surfaces,dynamics,geometry,flat surfaces,Abelian differentials,quadratic differentials,Riemann surfaces
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/markdown
License-File: COPYING

<p align="center">
    <img alt="logo" src="https://github.com/flatsurf/sage-flatsurf/raw/master/doc/static/logo.svg?sanitize=true">
</p>

<h1><p align="center">sage-flatsurf</p></h1>

sage-flatsurf is a Python package for working with flat surfaces in
[SageMath](https://sagemath.org).

We aim for sage-flatsurf 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](https://en.wikipedia.org/wiki/Translation_surface) and
[half-translation
surfaces](https://en.wikipedia.org/wiki/Translation_surface#Half-translation_surfaces).

Please consult our [documentation](https://flatsurf.github.io/sage-flatsurf/)
to see some of the capabilities of sage-flatsurf.

sage-flatsurf is free software, released under the [GPL v2 (or later)](./COPYING).

We welcome any help to improve sage-flatsurf. If you would like to help, have
ideas for improvements, or if you need any assistance in using sage-flatsurf,
please don't hesitate to [contact us](https://flatsurf.github.io#contact).

## Installation

See [our documentation](https://flatsurf.github.io/sage-flatsurf/#installation)
for detailed installation instructions.

## Run with Binder in the Cloud

You can try out sage-flatsurf in an environment online; unfortunately it might
take a long time for this environment to start:
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/flatsurf/sage-flatsurf/0.5.2?filepath=doc%2Fexamples)

## Developing sage-flatsurf

Please consult our [Developer's
Guide](https://flatsurf.github.io/sage-flatsurf/developer.html) to build
sage-flaturf from source and to run our test suite.

## Contributors

The main authors and current maintainers of sage-flatsurf are:

* Vincent Delecroix (Bordeaux)
* W. Patrick Hooper (City College of New York and CUNY Graduate Center)
* Julian Rüth

We welcome others to [contribute](https://flatsurf.github.io#contact).

## How to Cite This Project

If you have used this project, please cite us as described [on our
zenodo website](https://zenodo.org/badge/latestdoi/13970050).

## Acknowledgements

* sage-flatsurf was started during a thematic semester at
  [ICERM](https://icerm.brown.edu).
* Vincent Delecroix's contribution to the project has been supported by
  OpenDreamKit, Horizon 2020 European Research Infrastructures project #676541.
* W. Patrick 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.
* Julian Rüth's contributions to this project have been supported by the Simons
  Foundation Investigator grant of Alex Eskin.
