gallavant 0.2.1

A Custom Jupyter Widget Library

Gallavant

A jupyter widget for analysis of geospatial video data

Installation

You can install using pip:

pip install gallavant

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] gallavant

Usage

Initialization

The first load may be a bit slow but will create a .peaks.json file in the same directory as your source video. Subsequent loads will be significantly faster.

Optional:

for more screen real estate run

from IPython.core.display import display, HTML
display(HTML("<style>.container { width:100% !important; }</style>"))

Navigation

Navigate a video by clicking the timeline, a transcript line, or a point on the map.

Tag Selection

Data Formats and Structure

Development Installation

Create a dev environment:

conda create -n gallavant-dev -c conda-forge nodejs yarn python jupyterlab
conda activate gallavant-dev

Install the python. This will also build the TS package.

pip install -e .

When developing your extensions, you need to manually enable your extensions with the notebook frontend.

You need to run:

jupyter nbextension install --sys-prefix --symlink --overwrite --py gallavant
jupyter nbextension enable --sys-prefix --py gallavant

Note that the --symlink flag doesn't work on Windows, so you will here have to run the 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

Jupyter Notebook:

For Jupyter Notebook you can just watch for JS changes:

yarn watch

Python:

If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.