Embedded Jupyter Notebook for NVIDIA Omniverse

This extension is deprecated in favor of omni.isaac.jupyternotebook

See more details in Isaac Sim docs.

This extension can be described as the Jupyter notebook version of Omniverse's Script Editor. It allows to open a Jupyter Notebook embedded in the current NVIDIA Omniverse application scope.

Target applications: Any NVIDIA Omniverse app

Supported OS: Windows and Linux

Changelog: CHANGELOG.md

Table of Contents:

• Extension setup

• Extension usage

• Configuring the extension
• Implementation details

Extension setup

• Add the extension using the Extension Manager or by following the steps in Extension Search Paths

git+https://github.com/Toni-SM/semu.misc.jupyter_notebook.git?branch=main&dir=exts

* Compressed (.zip) file for import

semu.misc.jupyter_notebook.zip

• Enable the extension using the Extension Manager or by following the steps in Extension Enabling/Disabling

Troubleshooting

• Failed installation (particularly in Kit 105 based applications - Python 3.10)

[Warning] [omni.kit.pipapi.pipapi] 'jupyterlab' failed to install.
  [Warning] [omni.kit.pipapi.pipapi] 'notebook' failed to install.

Solution:

Upgrade pip to the latest version and install required libraries manually. Replace <USER>, <OMNIVERSEAPP>, <APPNAME>, and <APP_VERSION> according to your system configuration. Example: - <USER>: toni - <OMNIVERSE_APP>: create-2023.1.1 - <APP_NAME>: USD.Composer - <APP_VERSION>: 2023.1

Linux

/home/<USER>/.local/share/ov/pkg/<OMNIVERSE_APP>/kit/python/bin/python3 -m pip install --upgrade pip
  /home/<USER>/.local/share/ov/pkg/<OMNIVERSEAPP>/kit/python/bin/python3 -m pip --isolated install --upgrade --target=/home/<USER>/.local/share/ov/data/Kit/<APPNAME>/<APP_VERSION>/pip3-envs/default jupyterlab notebook jedi

Windows

C:\Users\<USER>\AppData\Local\ov\pkg\<OMNIVERSE_APP>\kit\python\python.exe -m pip install --upgrade pip
  C:\Users\<USER>\AppData\Local\ov\pkg\<OMNIVERSEAPP>\kit\python\python.exe -m pip --isolated install --upgrade --target=C:\Users\<USER>\AppData\Local\ov\data\Kit\<APPNAME>\<APP_VERSION>\pip3-envs\default jupyterlab notebook jedi

Extension usage

Omniverse app

Enabling the extension launches the Jupyter Notebook server (JupyterLab or Jupyter Notebook) in the background. The notebook can then be opened in the browser via its URL (http://WORKSTATION_IP:PORT/), which is also indicated inside the Omniverse application in the Windows > Embedded Jupyter Notebook menu.

Note: The Jupyter Notebook URL port may change if the configured port is already in use.

Disabling the extension shutdowns the Jupyter Notebook server and the openened kernels.

Jupyter Notebook

To execute Python code in the current NVIDIA Omniverse application scope use the following kernel:

Code autocompletion

Use the Tab key for code autocompletion.

Code introspection

Use the Ctrl + i keys for code introspection (display docstring if available).

Configuring the extension

The extension can be configured by editing the config.toml file under [settings] section. The following parameters are available:

Extension settings

Jupyter Notebook server settings

Implementation details

Both the Jupyter Notebook server and the IPython kernels are designed to be launched as independent processes (or subprocesses). Due to this specification, the Jupyter Notebook server and the IPython kernels are launched in separate (sub)processes.