pybabylonjs 1.1.0b1

BabylonJS widget

TileDB-PyBabylonJS

The TileDB-PyBabylonJS library is a geospatial data visualization Python library that interactively visualizes TileDB arrays with Babylon.js in a Jupyter notebook widget.

Installation

This project is available from PyPI and can be installed with pip:

pip install pybabylonjs

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

Development Installation

Create and activate a dev environment:

mamba create -n pybabylonjs-dev -c conda-forge nodejs yarn python jupyterlab

conda activate pybabylonjs-dev

Fork or clone the repo. Install the TileDB-PyBabylonJS Python package. This will also build the TS package.

pip install -e ".[test, examples]"

When developing your extensions, you need to manually enable your extensions with the notebook / lab frontend. For jupyter lab, this is done by the command:

jupyter labextension install @jupyter-widgets/jupyterlab-manager
yarn run build
jupyter labextension install .

For a classic notebook, you need to run:

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

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

Typescript:

If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the widget.

# Watch the source directory in one terminal, automatically rebuilding when needed
yarn run watch
# Run JupyterLab in another terminal
jupyter lab

After a change wait for the build to finish and then refresh your browser and the changes should take effect.

Python:

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

Usage

Jupyter notebooks are provided in the Examples.

Create a default visualization from a local sparse array containing LiDAR data by specifying the bounding box (bbox) of the slice of the data in the array uri:

from pybabylonjs import Show as show

bbox = {
    'X': [636800, 637800],
    'Y': [851000, 853000],
    'Z': [406.14, 615.26]
}

show.point_cloud(source="local",
                 mode="default",
                 uri="./data/autzen",
                 bbox=bbox)

This creates an interactive visualization in a notebook widget of which the below is a screenshot:

To add a slider over GpsTime change the mode to time:

show.point_cloud(source="local",
                 mode="time",
                 uri=uri,
                 bbox=bbox)