This release is a pre-release and may not be stable for production use.
JupyterLab NiiVue
WebGL 2.0 medical image viewer for JupyterLab
A JupyterLab extension that uses NiiVue to display neuroimaging files directly in JupyterLab. View NIfTI files, meshes, tractography, and DICOM images with an interactive, hardware-accelerated viewer integrated into your JupyterLab environment.
Installation
Install the extension using pip:
pip install jupyterlab-niivue
Usage
Opening Files
- File Browser: Simply double-click any supported neuroimaging file in the JupyterLab file browser
- Right-click Menu: Right-click on a file and select "Open With" → "NiiVue Viewer"
- Compare Multiple Files: Select multiple files (2 or more), right-click, and choose "Compare in NiiVue" to view them side-by-side in a multi-panel layout
Screenshots
Keyboard Shortcuts
Mouse Controls
- Right Mouse: Drag to adjust contrast/brightness (windowing); when Zoom button is pressed, drag to zoom
- Middle Mouse: Drag to pan
- Mouse Scroll: Change slice in currently hovered image
- Shift + Mouse: 2D dragging and 3D viewplane rotation
Navigation
- ← →: Change volume in 4D image
- V: Cycle through view modes
- C: Cycle through clip plane orientations in 3D render
Crosshair Movement
- H: Move crosshair to R (Right)
- L: Move crosshair to L (Left)
- J: Move crosshair to P (Posterior)
- K: Move crosshair to A (Anterior)
- Ctrl+U: Move crosshair to S (Superior)
- Ctrl+D: Move crosshair to I (Inferior)
Supported Formats
NiiVue can open several formats popular with brain imaging:
- Voxel-based: NIfTI (.nii, .nii.gz), NRRD (.nrrd, .nhdr), MRtrix MIF (.mif), AFNI HEAD/BRIK, MGH/MGZ, ITK MHD (.mhd, .mha), ECAT7 (.v), DICOM (.dcm), NumPy (.npy, .npz)
- Mesh-based: GIfTI (.gii), FreeSurfer (pial, white, inflated), MZ3 (.mz3), STL (.stl), Wavefront OBJ (.obj), PLY (.ply), BrainSuite DFS (.dfs), Legacy VTK (.vtk), X3D (.x3d), and others (ASC, BYU, GEO, ICO, TRI, OFF, SRF, NV)
- Mesh Overlays: GIfTI (.gii), CIfTI-2 (.nii), MZ3 (.mz3), FreeSurfer (CURV, ANNOT), SMP, STC
- Tractography: TCK (.tck), TRK (.trk), TRX (.trx), VTK (.vtk), AFNI (.niml.tract)
Requirements
- JupyterLab >= 4.0.0
- A modern web browser with WebGL 2.0 support (Chrome, Firefox, Edge, Safari)
Troubleshooting
Extension not appearing
If the extension doesn't appear after installation, try:
jupyter labextension list
You should see jupyterlab-niivue in the list. If not, try rebuilding JupyterLab:
jupyter lab build
Files not opening
If files don't open when double-clicked:
- Check that the file format is supported (see list above)
- Try right-clicking the file and selecting "Open With" → "NiiVue Viewer"
- Check the browser console for any error messages
Development
This extension is part of the NiiVue monorepo. Contributions are welcome!
If you encounter issues or have feature requests, please open an issue on GitHub.
Support This Project
If you find this extension useful, please consider supporting its development through a financial contribution:
License
BSD-2-Clause
Credits
- Built with NiiVue
- Part of Neurodesk, a flexible and scalable data analysis environment for reproducible neuroimaging
- Part of the NiiVue ecosystem for neuroimaging visualization
Related Projects
- NiiVue VS Code Extension - NiiVue for Visual Studio Code
- NiiVue - The core NiiVue library
- NiiVue Web App - Online NiiVue viewer
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file jupyterlab_niivue-0.2.8.dev138.tar.gz.
File metadata
- Download URL: jupyterlab_niivue-0.2.8.dev138.tar.gz
- Upload date:
- Size: 3.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
889d53e0ca314b55aa6d0a3cfc0925c61f47b8004b187f495aa88389161d145a
|
|
| MD5 |
e33513f058c2486293f92c338a3f6459
|
|
| BLAKE2b-256 |
c28479f33295553f4c4eee5254d97777ed9e58e80602cf5ddfdc35e367f007a5
|
File details
Details for the file jupyterlab_niivue-0.2.8.dev138-py3-none-any.whl.
File metadata
- Download URL: jupyterlab_niivue-0.2.8.dev138-py3-none-any.whl
- Upload date:
- Size: 6.8 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b867836053732ba09d6f626c12f77788453072d3aa9a4a819f8f6884cc5658b7
|
|
| MD5 |
661a5e47807cc80127d731909235578b
|
|
| BLAKE2b-256 |
8dc0887fb3ad95bc4ca179d37f36e125c3666bf5929055024a4d90386eb11ddc
|
