/ipyniivue

Python and Jupyter integration of NiiVue using webgl 2.0

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

demo

ipyNiiVue

ipyNiiVue is a Python / Niivue bridge for Jupyter Widgets. A Python API is used to interact with NiiVue.

Try it online

You can try ipyniivue online at , JupyterLite, or Binder.

Getting started

Installation

pip install ipyniivue

Development

conda create -n ipyniivue-dev -c conda-forge nodejs yarn python jupyterlab=3.6.3
conda activate ipyniivue-dev
git clone https://github.com/niivue/ipyniivue.git
cd ipyniivue
yarn install
jupyter labextension develop --overwrite .
yarn run watch

Then, in another terminal/cmd window:

cd ipyniivue
conda activate ipyniivue-dev
jupyter lab

To view changes made in the typescript, reload the jupyter page. To view changes made in the python, restart the kernel.

Usage

documentation