Skip to content

Latest commit

 

History

History
91 lines (67 loc) · 3.44 KB

README.md

File metadata and controls

91 lines (67 loc) · 3.44 KB
Raw

logo

sage-flatsurf

sage-flatsurf is a Python package for working with flat surfaces in SageMath.

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 and half-translation surfaces.

Take the Tour of flatsurf to see some of the capabilities of sage-flatsurf.

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

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.

Installation

If you are on Linux or macOS, download the latest .unix.tar.gz file from our Releases page.

Extract it anywhere (make sure there are no spaces in the directory name) and run ./sage or ./jupyterlab.

tar zxf sage-flatsurf-0.6.2.unix.tar.gz
./sage-flatsurf-0.6.2/jupyterlab  # or
./sage-flatsurf-0.6.2/sage

If you are on Windows, download the latest .exe installer from our Releases page.

Please also consult our documentation for other options and more detailed instructions.

Developing sage-flatsurf

We recommend you install pixi to provide all the dependencies for sage-flatsurf. Once installed, git clone this repository and then

pixi run sage  # to run SageMath with your version of sage-flatsurf installed
pixi run test  # to run the test suite
pixi run lint  # to check for errors and formatting issues

Please consult our Developer's Guide for more details.

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.

How to Cite This Project

If you have used this project, please cite us as described on our zenodo website.

Acknowledgements

  • sage-flatsurf was started during a thematic semester at ICERM.
  • 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.