JSPM – clustergrammer2@0.4.1

Package Exports

clustergrammer2

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (clustergrammer2) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

An interactive WebGL heatmap Jupyter widget built using the widget-ts-cookiecutter library.

Run Clustergrammer2 on MyBinder

Click the MyBinder badges above to launch Clustergrammer2 example Jupyter Notebooks. Also see the Clustergrammer2-Examples repo for more examples.

JupyterCon 2018 Presentation

The Clustergrammer project was recently presented at JupyterCon 2018 (see slides).

Installation

A typical installation requires the following commands to be run:

pip install clustergrammer2
jupyter nbextension enable --py --sys-prefix clustergrammer2

Optionally: --sys-prefix|--user|--system

Or, if you use jupyterlab:

pip install clustergrammer2
jupyter labextension install @jupyter-widgets/jupyterlab-manager

jupyter nbconvert --to html notebook.ipynb

Development and Releasing new Versions

During development run npm run watch for real time updates. When releasing a new version, first confirm that latest version of the front and back ends are working locally (check console logs, etc).

Updating versions

Update the versions in the following files

JavaScript

package.json
widget.ts

Python

_version.py
example.py
requirements.txt
_frontend.py

Webpack

Run the following commands to build the JavaScript bundle:

npm run build
npm run build:nbextension
npm run build:labextension

Publish to npm using

npm publish

These instructions are based on the release instructions from the jupyter-widgets/widget-ts-cookiecutterREADME.

Bundling the Python Package

Next, bundle the python package using

python setup.py sdist bdist_wheel

Then, upload the PYPI:

twine upload dist/*

Checklist after release

After releasing a new version several things need to be checked to ensure proper widget functioning.

Check Package Managers

https://www.npmjs.com/package/clustergrammer2 (can be slow to update)
https://pypi.org/project/clustergrammer2/

Check HTML Embedding

Run jupyter nbconvert --to html introduction_nb.ipynb (from the examples directory) to generate a static HTML and check that the latest widget is working (uses unpkg.com)
Check NBViewer using link to notebook on GitHub (e.g. https://nbviewer.jupyter.org/github/ismms-himc/clustergrammer2/blob/master/examples/introduction_nb.ipynb?flush_cache=true). Make sure to use the querystring flush_cache=True in the URL to ensure that NBVIewer re-runs nbconvert.

Check Cloud Services

Check MyBinder
Check Kaggle (re-install clustergrammer2)

clustergrammer2