vue-flatsurf
Visualization for flatsurf
This package provides interactive visualization for many of the objects in the flatsurf suite such as triangulated surfaces and their flow decompositions. It is written in TypeScript and vue.js to run in the browser. For the most part, this project exists as the frontend code for ipyvue-flatsurf which implements Jupyter widgets for sage-flatsurf.
Install from NPM
This package is available on NPM. To use vue-flatsurf in your project, install it with yarn add --dev vue-flatsurf or the corresponding NPM command.
Run Demo Application
The demo application App.vue is deployed at https://flatsurf.github.io/vue-flatsurf/app/. To run it locally, install the dependencies with yarn and run the app with yarn serve.
Run Tests
The project has a small amount of unit tests. During development they can be run with
yarn test
Release Cycle
We release this package frequently and upload a new version to NPM, typically with most merges into the master branch. To release a new version, checkout the master branch locally, and run rever VERSION.
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.
