<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).
Take the [Tour of flatsurf](https://flatsurf.github.io/sage-flatsurf/examples/tour)
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
If you are on **Linux or macOS**, download the latest `.unix.tar.gz` file from our
[Releases page](https://github.com/flatsurf/sage-flatsurf/releases).
Extract it anywhere (make sure there are no spaces in the directory name) and
run `./sage` or `./jupyterlab`.
```sh
tar zxf sage-flatsurf-0.7.1.unix.tar.gz
./sage-flatsurf-0.7.1/jupyterlab # or
./sage-flatsurf-0.7.1/sage
```
If you are on **Windows**, download the latest `.exe` installer from our [Releases
page](https://github.com/flatsurf/sage-flatsurf/releases).
Please also consult [our
documentation](https://flatsurf.github.io/sage-flatsurf/#installation) for
other options and more detailed instructions.
## Developing sage-flatsurf
We recommend you install [pixi](https://pixi.sh) to provide all the
dependencies for sage-flatsurf. Once installed, `git clone` this repository and
then
```sh
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](https://flatsurf.github.io/sage-flatsurf/developer.html) 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](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.
Raw data
{
"_id": null,
"home_page": null,
"name": "sage-flatsurf",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Abelian differentials, Riemann surfaces, dynamics, flat surfaces, geometry, quadratic differentials, surfaces",
"author": "Vincent Delecroix, W. Patrick Hooper, Julian R\u00fcth",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/8b/48/d59e87a39fb6308c129dd5afa69ffd13a83babd5d9406891f3d2aab202e2/sage_flatsurf-0.7.1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img alt=\"logo\" src=\"https://github.com/flatsurf/sage-flatsurf/raw/master/doc/static/logo.svg?sanitize=true\">\n</p>\n\n<h1><p align=\"center\">sage-flatsurf</p></h1>\n\nsage-flatsurf is a Python package for working with flat surfaces in\n[SageMath](https://sagemath.org).\n\nWe aim for sage-flatsurf to support the investigation of geometric, algebraic\nand dynamical questions related to flat surfaces. By flat surface we mean a\nsurface modeled on the plane with monodromy given by similarities of the plane,\nthough current efforts are focused on [translation\nsurfaces](https://en.wikipedia.org/wiki/Translation_surface) and\n[half-translation\nsurfaces](https://en.wikipedia.org/wiki/Translation_surface#Half-translation_surfaces).\n\nTake the [Tour of flatsurf](https://flatsurf.github.io/sage-flatsurf/examples/tour)\nto see some of the capabilities of sage-flatsurf.\n\nsage-flatsurf is free software, released under the [GPL v2 (or later)](./COPYING).\n\nWe welcome any help to improve sage-flatsurf. If you would like to help, have\nideas for improvements, or if you need any assistance in using sage-flatsurf,\nplease don't hesitate to [contact us](https://flatsurf.github.io#contact).\n\n## Installation\n\nIf you are on **Linux or macOS**, download the latest `.unix.tar.gz` file from our\n[Releases page](https://github.com/flatsurf/sage-flatsurf/releases).\n\nExtract it anywhere (make sure there are no spaces in the directory name) and\nrun `./sage` or `./jupyterlab`.\n\n```sh\ntar zxf sage-flatsurf-0.7.1.unix.tar.gz\n./sage-flatsurf-0.7.1/jupyterlab # or\n./sage-flatsurf-0.7.1/sage\n```\n\nIf you are on **Windows**, download the latest `.exe` installer from our [Releases\npage](https://github.com/flatsurf/sage-flatsurf/releases).\n\nPlease also consult [our\ndocumentation](https://flatsurf.github.io/sage-flatsurf/#installation) for\nother options and more detailed instructions.\n\n## Developing sage-flatsurf\n\nWe recommend you install [pixi](https://pixi.sh) to provide all the\ndependencies for sage-flatsurf. Once installed, `git clone` this repository and\nthen\n\n```sh\npixi run sage # to run SageMath with your version of sage-flatsurf installed\npixi run test # to run the test suite\npixi run lint # to check for errors and formatting issues\n```\n\nPlease consult our [Developer's\nGuide](https://flatsurf.github.io/sage-flatsurf/developer.html) for more\ndetails.\n\n## Contributors\n\nThe main authors and current maintainers of sage-flatsurf are:\n\n* Vincent Delecroix (Bordeaux)\n* W. Patrick Hooper (City College of New York and CUNY Graduate Center)\n* Julian R\u00fcth\n\nWe welcome others to [contribute](https://flatsurf.github.io#contact).\n\n## How to Cite This Project\n\nIf you have used this project, please cite us as described [on our\nzenodo website](https://zenodo.org/badge/latestdoi/13970050).\n\n## Acknowledgements\n\n* sage-flatsurf was started during a thematic semester at\n [ICERM](https://icerm.brown.edu).\n* Vincent Delecroix's contribution to the project has been supported by\n OpenDreamKit, Horizon 2020 European Research Infrastructures project #676541.\n* W. Patrick 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 Science\n Foundation.\n* Julian R\u00fcth's contributions to this project have been supported by the Simons\n Foundation Investigator grant of Alex Eskin.\n",
"bugtrack_url": null,
"license": null,
"summary": "Flat surfaces in SageMath",
"version": "0.7.1",
"project_urls": null,
"split_keywords": [
"abelian differentials",
" riemann surfaces",
" dynamics",
" flat surfaces",
" geometry",
" quadratic differentials",
" surfaces"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd8467a161a6f830ae9db9024f90701c3b699e5c19b6afd838c2c209c7f4d4e4",
"md5": "702abd6c06429795f68ae445f24342ef",
"sha256": "4c5cf21083459afd991b5588fadc0a252e50dc0ef8f65c0468df2a04d641c915"
},
"downloads": -1,
"filename": "sage_flatsurf-0.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "702abd6c06429795f68ae445f24342ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 449144,
"upload_time": "2024-12-19T23:29:53",
"upload_time_iso_8601": "2024-12-19T23:29:53.355996Z",
"url": "https://files.pythonhosted.org/packages/dd/84/67a161a6f830ae9db9024f90701c3b699e5c19b6afd838c2c209c7f4d4e4/sage_flatsurf-0.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b48d59e87a39fb6308c129dd5afa69ffd13a83babd5d9406891f3d2aab202e2",
"md5": "999cb1bc12512134660959bc72908ac0",
"sha256": "31acfdbe476c27d369f609633289e0f3cd25a06688a48679c4342d7198d942b0"
},
"downloads": -1,
"filename": "sage_flatsurf-0.7.1.tar.gz",
"has_sig": false,
"md5_digest": "999cb1bc12512134660959bc72908ac0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 685822,
"upload_time": "2024-12-19T23:29:56",
"upload_time_iso_8601": "2024-12-19T23:29:56.555539Z",
"url": "https://files.pythonhosted.org/packages/8b/48/d59e87a39fb6308c129dd5afa69ffd13a83babd5d9406891f3d2aab202e2/sage_flatsurf-0.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 23:29:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sage-flatsurf"
}
JSON