https://github.com/echemdb/vue-echemdb

https://github.com/echemdb/vue-echemdb

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/echemdb/vue-echemdb
• Owner: echemdb
• License: apache-2.0
• Created: 2022-07-05T10:50:55.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-07-05T14:05:35.000Z (over 2 years ago)
• Last Synced: 2023-03-04T01:28:50.329Z (almost 2 years ago)
• Language: JavaScript
• Size: 362 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog
  • License: LICENSE

Awesome Lists containing this project

README

        




    



vue-flatsurf




  

  



Visualization for flatsurf



This package provides interactive visualization for many of the objects in the [flatsurf suite](https://flatsurf.github.io) such as triangulated surfaces and their flow decompositions. It is written in [TypeScript](https://typescriptlang.org/) and [vue.js](https://vuejs.org) to run in the browser. For the most part, this project exists as the frontend code for [ipyvue-flatsurf](https://github.com/flatsurf/ipyvue-flatsurf) which implements [Jupyter](https://jupyter.org) widgets for [sage-flatsurf](https://github.com/flatsurf/sage-flatsurf).



Install from NPM

----------------

This package is available on [NPM](npmjs.com/). 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](demo/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](https://www.npmjs.com/package/vue-flatsurf), 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](https://zenodo.org/record/5192364).