ipycytoscape

Version: 1.0.3

A Custom Jupyter Widget Library

Quickstart

To get started with ipycytoscape, install with pip:

pip install ipycytoscape

or with conda:

conda install ipycytoscape

Contents

Installation

The simplest way to install ipycytoscape is via pip:

pip install ipycytoscape

or via conda:

conda install ipycytoscape

If you installed via pip, and notebook version < 5.3, you will also have to install / configure the front-end extension as well. If you are using classic notebook (as opposed to Jupyterlab), run:

jupyter nbextension install [--sys-prefix / --user / --system] --py ipycytoscape

jupyter nbextension enable [--sys-prefix / --user / --system] --py ipycytoscape

with the appropriate flag. If you are using Jupyterlab, install the extension with:

jupyter labextension install ipycytoscape

If you are installing using conda, these commands should be unnecessary, but If you need to run them the commands should be the same (just make sure you choose the –sys-prefix flag).

Introduction

Examples

This section contains several examples generated from Jupyter notebooks. The widgets have been embedded into the page for demonstrative pruposes.

Developer install

To install a developer version of ipycytoscape, you will first need to clone the repository:

git clone https://github.com/Quantstack/ipycytoscape
cd ipycytoscape

Next, install it with a develop install using pip:

pip install -e .

If you are planning on working on the JS/frontend code, you should also do a link installation of the extension:

jupyter nbextension install [--sys-prefix / --user / --system] --symlink --py ipycytoscape

jupyter nbextension enable [--sys-prefix / --user / --system] --py ipycytoscape

with the appropriate flag. Or, if you are using Jupyterlab:

jupyter labextension install .