ipysigma 0.21.0

A Jupyter widget using sigma.js to render interactive networks.

ipysigma

A Jupyter widget using sigma.js and graphology to render interactive networks directly within the result of a notebook cell.

ipysigma has been designed to work with either networkx or igraph.

Summary

• Installation
• Quick start
• TODO: Examples
• TODO: Available visual variables
• TODO: What can be used as visual variable
• TODO: Visual variables and kwarg naming rationale
• TODO: API Reference
  • Sigma
  • SigmaGrid
• Using in Google Colab

Installation

You can install using pip:

pip install ipysigma

You will also need to install either networkx or igraph of course.

If you are using an older version of Jupyter, you might also need to enable the nbextension likewise:

jupyter nbextension enable --py --sys-prefix ipysigma

# You might need one of those other commands
jupyter nbextension enable --py --user ipysigma
jupyter nbextension enable --py --system ipysigma

Quick start

Using networkx

import networkx as nx
from ipysigma import Sigma

# Importing a gexf graph
g = nx.read_gexf('./my-graph.gexf')

# Displaying the graph with a size mapped on degree and
# a color mapped on a categorical attribute of the nodes
Sigma(g, node_size=g.degree, node_color='category')

Using igraph

import igraph as ig
from ipysigma import Sigma

# Generating a graph
g = ig.Graph.Famous('Zachary')

# Displaying the graph with a size mapped on degree and
# a color mapped on node betweenness centrality, using
# the a continuous color scale named "Viridis"
Sigma(g, node_size=g.degree, node_color=g.betweenness(), node_color_gradient='Viridis')

Using in Google Colab

If you want to be able to use ipysigma on Google Colab, you will need to enable widget output using the following code:

from google.colab import output

output.enable_custom_widget_manager()

Remember you can always install packages in Colab by executing the following command in a cell:

!pip install networkx ipysigma