[isaacsim.code_editor.jupyter] Jupyter notebook integration#

Version: 1.0.9

Jupyter notebook version of Omniverse’s script editor

Enable Extension#

The extension can be enabled (if not already) in one of the following ways:

Command-line interface

Define the next entry as an application argument from a terminal.

APP_SCRIPT.(sh|bat) --enable isaacsim.code_editor.jupyter

Experience/extension configuration

Define the next entry under [dependencies] in an experience (.kit) file or an extension configuration (extension.toml) file.

[dependencies]
"isaacsim.code_editor.jupyter" = {}

Extension Manager UI

Open the Window > Extensions menu in a running application instance and search for isaacsim.code_editor.jupyter. Then, toggle the enable control button if it is not already active.

Settings#

Extension Settings#

The table list the extension-specific settings.

Setting name	Description	Type	Default value
`host`	IP address where the extension server will listen for connections.	`str`	`'0.0.0.0'`
`port`	Port number where the extension server will listen for connections.	`int`	`8227`
`kill_processes_with_port_in_use`	Whether to kill applications/processes that use the same ports before enabling the extension. Disable this option if you want to launch multiple applications with this extension enabled.	`bool`	`False`
`classic_notebook_interface`	Whether to use the classic notebook interface. If false, the Jupyter Lab interface is used.	`bool`	`False`
`notebook_ip`	IP address where the Jupyter server is being started.	`str`	`'0.0.0.0'`
`notebook_port`	Port number where the Jupyter server is being started.	`int`	`8228`
`notebook_token`	Jupyter server token for token-based authentication. If empty, the server will start without authentication.	`str`	`''`
`notebook_dir`	The directory to use for notebooks. If empty, the directory is `data/notebooks` within the extension tree.	`str`	`''`
`command_line_options`	Jupyter server command line options other than `--ip`, `--port`, `--token` and `--notebook-dir`.	`str`	`'--allow-root --no-browser --JupyterApp.answer_yes=True'`

The extension-specific settings can be either specified (set) or retrieved (get) in one of the following ways:

Set setting

Command-line interface

Define the key and value of the setting as an application argument from a terminal.

APP_SCRIPT.(sh|bat) --/exts/isaacsim.code_editor.jupyter/SETTING_NAME=SETTING_VALUE

Experience/extension configuration

Define the key and value of the setting under [settings] in an experience (.kit) file or an extension configuration (extension.toml) file.

[settings]
exts."isaacsim.code_editor.jupyter".SETTING_NAME = SETTING_VALUE

By programming

Define the key and value of the setting using the carb framework (in Python).

import carb

settings = carb.settings.get_settings()
settings.set("/exts/isaacsim.code_editor.jupyter/SETTING_NAME", SETTING_VALUE)

Get setting

By programming

Define the key to query the value of the setting using the carb framework (in Python).

import carb

settings = carb.settings.get_settings()
value = settings.get("/exts/isaacsim.code_editor.jupyter/SETTING_NAME")