Skip to content

Commit 9549133

Browse files
committed
Updating README with version 1.4.0 featues
1 parent ec8fb5d commit 9549133

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,20 @@ integrated into GAP or its build system.
1010

1111
## Purpose
1212

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

1718
## Implementation
1819

19-
These are implemented by importing existing JavaScript visualization
20-
libraries into the notebook as needed, based on the kind of visualization
21-
requested by the GAP code.
20+
In a Jupyter notebook, these visualizations are implemented by importing
21+
existing JavaScript visualization libraries into the notebook as needed,
22+
based on the kind of visualization requested by the GAP code.
23+
24+
Outside of the notebook, a visualization command creates a temporary HTML
25+
file with the Javascript code and JSON data needed to build the
26+
visualization, then displays it using the system default web browser.
2227

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

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

0 commit comments

Comments
 (0)