jupyterlab-webviz

适用于webviz/机器人的jupyterlab扩展

此扩展由名为 jupyterlab-webviz 的服务器扩展Python包和名为 jupyterlab-webviz 的前端扩展NPM包组成。

提供的webviz是从webviz存储库（gh-pages分支）中提取的。需要将所有对 /dist/ 的引用替换为 ../dist。

需求

• JupyterLab >= 3.0

安装

要安装扩展，请执行

pip install jupyterlab-webviz

卸载

要删除扩展，请执行

pip uninstall jupyterlab-webviz

故障排除

如果您看到前端扩展，但它没有工作，请检查服务器扩展是否已启用

jupyter server extension list

如果服务器扩展已安装并启用，但您没有看到前端扩展，请检查前端扩展是否已安装

jupyter labextension list

贡献

开发安装

注意：您将需要NodeJS来构建扩展包。

jlpm 命令是JupyterLab的固定版本 yarn，它是与JupyterLab一起安装的。您可以使用 yarn 或 npm 替代下面的 jlpm。

# Clone the repo to your local environment
# Change directory to the jupyterlab-webviz directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyterlab-webviz
# Rebuild extension Typescript source after making changes
jlpm run build

您可以在不同的终端中同时监视源目录并运行JupyterLab，以监视扩展源的变化并自动重新构建扩展。

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

当监视命令运行时，每次保存的更改都会立即本地构建并可供您的运行JupyterLab使用。刷新JupyterLab以在浏览器中加载更改（您可能需要等待几秒钟以重新构建扩展）。

默认情况下，jlpm run build 命令会为该扩展生成源映射，以便使用浏览器开发者工具进行调试。若要为 JupyterLab 核心扩展生成源映射，可以运行以下命令：

jupyter lab build --minimize=False

开发模式卸载

# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyterlab-webviz
pip uninstall jupyterlab-webviz

在开发模式下，您还需要删除由 jupyter labextension develop 命令创建的符号链接。要找到其位置，可以运行 jupyter labextension list 命令以确定 labextensions 文件夹的位置。然后您可以删除该文件夹中的名为 jupyterlab-webviz 的符号链接。