An annotation Jupyter Widget based on Annotorious.
You can install using
pip install ipannotoryous
You can also use
conda install ipannotoryous
Or if you use JupyterLab < 3:
pip install ipannotoryous jupyter labextension install @jupyter-widgets/jupyterlab-manager ipannotoryous
If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable the nbextension:
jupyter nbextension enable --py [--sys-prefix|--user|--system] ipannotoryous
# First install the python package. This will also build the JS packages. pip install -e ".[test, examples]"
When developing your extensions, you need to manually enable your extensions with the notebook / lab frontend. For JupyterLab 3, this is done by the command:
jupyter labextension develop . --overwrite
For classic notebook, you can run:
jupyter nbextension install --sys-prefix --symlink --overwrite --py ipannotoryous jupyter nbextension enable --sys-prefix --py ipannotoryous
Note that the
--symlink flag doesn't work on Windows, so you will here have to run
install command every time that you rebuild your extension. For certain installations
you might also need another flag instead of
--sys-prefix, but we won't cover the meaning
of those flags here.
How to see your changes
To continuously monitor the project for changes and automatically trigger a rebuild, start Jupyter in watch mode:
jupyter lab --watch
And in a separate session, begin watching the source directory for changes:
npm run watch
After a change wait for the build to finish and then refresh your browser and the changes should take effect.
If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.