Skip to main content

Tiny Jupyter Wrapper for neuroglancer viewer

Project description

jupyter-neuroglancer

Simple Jupyter (and jupyter-server-proxy) integration with neuroglancer.

Pops up a neuroglancer viewer in a split pane in JupyterLab (via jupyterlab-sidecar) so you can more easily see real-time live visualizations driven by your python code.

When running on a remote JupyterHub, the viewer is automatically (and securely) proxied through jupyter-server-proxy so users get the exact same experience on theier local machine as well as a JupyterHub.

Installation

jupyter-neuroglancer is available on PyPI.

pip install jupyter-neuroglancer

Usage

jupyter_neuroglancer provides a display_in_sidecar function that accepts a regular neuroglancer Viewer object. You don't have to modify your neuroglancer code in any way!

import neuroglancer
from jupyter_neuroglancer import SidecarViewer

# Create a neuroglancer Viewer instance. This controls the visualization
viewer = neuroglancer.Viewer()

# Display the neuroglancer in JupyterLab as a sidecar
display_in_sidecar(viewer)

Using on a JupyterHub

When using this on a JupyterHub, you need jupyter-server-proxy installed in the image you are using. Since neuroglancer uses eventstreams for communication, you need it to be a version of jupyter-server-proxy that has this PR included. Until that PR is merged and released, you can install that with:

pip install --upgrade git+https://github.com/ganisback/jupyter-server-proxy@support-stream

Other than that, you do not have to modify your code in any way.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter_neuroglancer-0.2.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

jupyter_neuroglancer-0.2-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_neuroglancer-0.2.tar.gz.

File metadata

  • Download URL: jupyter_neuroglancer-0.2.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for jupyter_neuroglancer-0.2.tar.gz
Algorithm Hash digest
SHA256 2a44c78f96b5773d6f72553774f36cb2987dbbd0e667b78238b5ac6b87a44ef0
MD5 b52073fd6e2df0912f2a248ac615f259
BLAKE2b-256 3b97442960565904c9c96000ade7a469d53079e5b91740109fddf66a8e6734ec

See more details on using hashes here.

Provenance

File details

Details for the file jupyter_neuroglancer-0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_neuroglancer-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 60ca868113628a66401f33d911d23e2eafc3e5e2e515d181c2e6b43f3613ad25
MD5 b76ef718d1d56a05af8756298e2cd760
BLAKE2b-256 349483241d8c249113c6abae09b04b3fdd88e25160185180ab5d6d2e16fb31d1

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page