Skip to content
Python bindings to and Jupyter Notebook+Lab integration for the HiGlass viewer
Jupyter Notebook Python JavaScript Makefile Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create .github folder Jun 26, 2019
higlass Bump to v0.2.0 Sep 20, 2019
js
notebooks Update one more time Sep 20, 2019
test Restore track and view creation methods as distinct from add methods Jul 6, 2019
.editorconfig Proper JS formatting Sep 4, 2019
.gitattributes
.gitignore
.travis.yml Fix installation in travis Jun 26, 2019
CHANGELOG.md Update Sep 20, 2019
LICENSE More packaging boilerplate Nov 18, 2018
MANIFEST.in Update manifest.in Jun 26, 2019
Makefile Update makefile Jul 8, 2019
README.md Update README.md Sep 20, 2019
requirements-dev.txt Change version pinning for jlab and ipywidgets Sep 4, 2019
requirements.txt Change version pinning for jlab and ipywidgets Sep 4, 2019
setup.cfg
setup.py Replace environment.yml with install and dev requirements.txt files Jun 26, 2019

README.md

HiGlass Python

HiGlass Docs Python Build Status

Python bindings to the HiGlass for tile serving, view config generation, and Jupyter Notebook + Lab integration.

This package provide access to:

  • server: a lightweight flask server
  • tilesets: tileset API
  • client: an API for generating view configs
  • viewer: an API for launching HiGlass in Jupyter Notebook or Lab

Installation

Requirements

  • Python >= 3.7
  • FUSE or MacFuse
  • Jupyter Notebook >= 5.7
  • Jupyter Lab >= 0.35 & < 1.0
  • ipywidgets <= 7.4.2

Install package

First install higlass-python via pip:

pip install higlass-python

Jupyter Notebook integration

Open a terminal and execute the following code to activate the integration:

# The following is only required if you have not enabled the ipywidgets nbextension yet
jupyter nbextension enable --py --sys-prefix widgetsnbextension
jupyter nbextension install --py --sys-prefix higlass
jupyter nbextension enable --py --sys-prefix higlass

Jupyter Lab integration

Open a terminal and execute the following code to activate the integration:

# The following is only required if you have not enabled the jupyterlab manager yet
jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install higlass-jupyter

Getting started

Take a look at notebooks/Examples.ipynb on how to get started.

Development

  • Install the package in editable mode. (The module will be imported from the development directory, rather than copied to site-packages).

    pip install -e .
  • Build and enable the Jupyter Notebook Extension. (With the --symlink option, the assets in higlass/static are linked to the extension registry rather than copied.)

    python setup.py jsdeps
    jupyter nbextension enable --py --sys-prefix widgetsnbextension
    jupyter nbextension install --py --symlink --sys-prefix higlass
    jupyter nbextension enable --py --sys-prefix higlass
  • Uninstall the Jupyter Notebook Extension

    jupyter nbextension uninstall --py --sys-prefix higlass
  • Experimental: install the Jupyter Lab Extension

    cd js && jupyter labextension link .

Troubleshooting

You can’t perform that action at this time.