Skip to content

flatsurf/ipyvue-flatsurf

Repository files navigation

logo

ipyvue-flatsurf

License: GPL 3.0 or later Test DOI 10.5281/zenodo.5208761

Jupyter Widgets for flatsurf


This project provides Jupyter Widgets for the flatsurf suite. In particular it provides interactive widgets for surfaces from sage-flatsurf and their quotients and flow decompositions. Behind the scenes, this project provides the glue between the mathematical objects of sage-flatsurf and their visualization in the browser which is implemented in vue-flatsurf.

Note that this project is in an alpha stage. The interface is mostly a proof-of-concept and very likely to change substantially in the future.

Installation

If you already have sage-flatsurf and pyflatsurf, you can install ipyvue-flatsurf with pip:

pip install ipyvue-flatsurf

Development

Install a local copy of this package:

git clone https://github.com/flatsurf/ipyvue-flatsurf.git
cd ipyvue-flatsurf
pixi run jupyter lab  # to explore the examples/

To use the Vue.js devtools, you should also install this hack since otherwise, Vue won't be detected properly.

How to Cite this Project

If you have used this project in the preparation of a publication, please cite it as described on our Zenodo page.

Acknowledgements

  • Julian Rüth's contributions to this project have been supported by the Simons Foundation Investigator grant of Alex Eskin.

Maintainers

About

Jupyter Widgets for flatsurf

Resources

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •