Development#

Getting started#

Node.js and Yarn are required for building and developing the client.

Clone the repository:

git clone git@github.com:KitwareMedical/tensorboard-plugin-3d.git

In a virtualenv with TensorBoard installed, run:

python setup.py build_client develop

This will install and build the frontend and link the plugin into your virtualenv.

Changes to the client#

If you have made changes to the client you will need to re-run the setup python script and the build_client command to re-build the client and update the static file.

python setup.py build_client develop

Starting TensorBoard#

Run the following, pointing to the log directory you would like to use:

tensorboard --logdir ~/path/to/logdir

Open TensorBoard to see the tensorboard plugin 3D tab.

Uninstall#

Run the following:

python setup.py develop --uninstall

to unlink the plugin from your virtualenv, after which you can also delete the tensorboard_plugin_3d.egg-info/ directory that the original setup.py invocation created.