Visualize -- A package to help visualize algebraic objects in the browser using javascript

Description

Using JavaScript, this package creates interactive visualizations of a variety of objects in a modern browser. While viewing the object, the user has the ability to manipulate and run various tests. Once finished, the user can export the finished result back to the Macaulay2 session.

Javascript Packages Used

Built on the shoulders of giants, this package utilizes a variety of existing open-source javascript packages.

Contributors

The following people have generously contributed code or worked on our code at various Macaulay2 workshops.

Ata Firat Pir
Elliot Korte
Will Smith
Julio Urenda

In particular we are thankful to Dan Grayson and Mike Stillman for their help in creating communication between Macaulay2 and the browser.

Interactive Examples

The following links are interactive examples without the communication between Macaulay2 and the browser. The editing, manipulation, and TikZ should work. Depending on the browser, some features may require you to open the links in a new tab.

Methods and Workflow

Basic Workflow for Visualize
visualize(Graph) -- visualizes a graph in a modern browser
visualize(Digraph) -- visualizes a digraph in the browser
visualize(Poset) -- visualizes a poset in the browser
visualize(SimplicialComplex) -- visualizes a simplicial complex in the browser
visualize(Ideal) -- visualizes an ideal in the browser

Authors

Version

This documentation describes version 1.7 of Visualize.

Citation

If you have used this package in your research, please cite it as follows:

@misc{VisualizeSource,
  title = {{Visualize: interactive visualization and manipulation of combinatorial objects in a browser. Version~1.7}},
  author = {Brett Barwick and Thomas Enkosky and Branden Stone and Jim Vallandingham and Doug Torrance},
  howpublished = {A \emph{Macaulay2} package available at
    \url{https://github.com/Macaulay2/M2/tree/master/M2/Macaulay2/packages}}
}

Exports

Functions and commands
- closePort -- closes and open port
- openPort -- opens a port
- visualize -- creates an interactive object in a modern browser
Methods
- openPort(String) -- see openPort -- opens a port
- visualize(Digraph) -- visualizes a digraph in the browser
- visualize(Graph) -- visualizes a graph in a modern browser
- visualize(Ideal) -- visualizes an ideal in the browser
- visualize(Poset) -- visualizes a poset in the browser
- visualize(SimplicialComplex) -- visualizes a simplicial complex in the browser
Symbols
- FixExtremeElements -- an option to fix extreme elements of a poset
- VisPath -- an option to define a path to save visualizations
- VisTemplate -- an option defining the template path
- Warning -- an option to squelch warnings

For the programmer

The object Visualize is a package, defined in Visualize.m2, with auxiliary files in Visualize/.

The source of this document is in Visualize.m2:1104:0.