Skip to content

Commit

Permalink
Updating README with version 1.4.0 featues
Browse files Browse the repository at this point in the history
  • Loading branch information
nathancarter committed Feb 21, 2019
1 parent ec8fb5d commit 9549133
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,20 @@ integrated into GAP or its build system.

## Purpose

This package adds visualization tools to GAP for use in Jupyter notebooks.
These include standard line and bar graphs, pie charts, scatter plots, and
graphs in the vertices-and-edges sense.
This package adds visualization tools to GAP that can be used either in
Jupyter notebooks or from the GAP REPL. These include standard line and bar
graphs, pie charts, scatter plots, and graphs in the vertices-and-edges
sense.

## Implementation

These are implemented by importing existing JavaScript visualization
libraries into the notebook as needed, based on the kind of visualization
requested by the GAP code.
In a Jupyter notebook, these visualizations are implemented by importing
existing JavaScript visualization libraries into the notebook as needed,
based on the kind of visualization requested by the GAP code.

Outside of the notebook, a visualization command creates a temporary HTML
file with the Javascript code and JSON data needed to build the
visualization, then displays it using the system default web browser.

The architecture of the package is such that additional JavaScript
visualization libraries can be added easily.
Expand All @@ -30,7 +35,7 @@ The package does not need to be compiled.
See the manual on [the package website](http://nathancarter.github.io/jupyterviz),
which contains many usage examples.

Or experiment with a live notebook on Binder:
Or experiment with a live Jupyter notebook on Binder:
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/nathancarter/jupyterviz/master?filepath=inst%2Fgap-4.10.0%2Fpkg%2Fjupyterviz%2F).
(It can be a long loading time, so have patience!)

Expand Down

0 comments on commit 9549133

Please sign in to comment.