algorithmx 1.0.0

A library for network visualization and algorithm simulation.

AlgorithmX Python

AlgorithmX Python is a library for network visualization and algorithm simulation, based on AlgorithmX. It works through either a HTTP server, or as a widget in Jupyter Notebooks and JupyterLab.

Resources

• Website
• Documentation

Installation

Python 3.6 or higher is required.

AlgorithmX can be installed using pip:

pip install algorithmx

or using conda:

conda install algorithmx

Jupyter Widget

In classic Jupyter notebooks, the widget will typically be enabled by default. However, if you installed using pip with notebook version <5.3, you will have to manually enable it by running:

jupyter nbextension enable --sys-prefix --py algorithmx

with the appropriate flag. To enable in JupyterLab, run:

jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install algorithmx-jupyter

Example Usage

If you wish to use the library through a HTTP/WebSocket server, follow the template below:

import algorithmx

server = algorithmx.http_server()
canvas = server.canvas()

def start():
    canvas.nodes([1, 2]).add()
    canvas.edge((1, 2)).add()

canvas.listen('start', start)
server.start()

If you are using Jupyter, add the following to a cell:

import algorithmx

widget = algorithmx.jupyter_widget()
canvas = widget.canvas()

canvas.nodes([1, 2]).add()
canvas.edge((1, 2)).add()

display(widget)