Skip to content

Commit 98434d1

Browse files
committed
Enhance documentation to clarify Xeus-Python foundation, connection methods, and cross-platform support for DataLab-Kernel
1 parent 84032b0 commit 98434d1

3 files changed

Lines changed: 28 additions & 3 deletions

File tree

doc/index.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,17 @@ notebook-based workflows for signal and image analysis with
6868
Key Features
6969
------------
7070

71+
**Xeus-Python Foundation**
72+
Built on `Xeus-Python <https://github.com/jupyter-xeus/xeus-python>`_ for
73+
improved performance, native debugger support, and excellent Qt event loop integration.
74+
7175
**Dual Operating Modes**
7276
- **Standalone mode**: Work independently with HDF5 persistence
73-
- **Live mode**: Synchronize with running DataLab instance via XML-RPC
77+
- **Live mode**: Synchronize with running DataLab via Web API (recommended) or XML-RPC
78+
79+
**Cross-Platform Jupyter Support**
80+
Works in native Jupyter (JupyterLab, Notebook, VS Code) and
81+
`JupyterLite <https://jupyterlite.readthedocs.io/>`_ (browser-based, no server required).
7482

7583
**Unified API**
7684
Same code works in both modes - switch seamlessly between local notebooks

doc/user_guide/features.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,18 +186,30 @@ Jupyter Integration
186186

187187
Works seamlessly with:
188188

189+
**Native Jupyter environments:**
190+
189191
- **Jupyter Notebook**: Classic notebook interface
190192
- **JupyterLab**: Modern lab environment
191193
- **VS Code**: With Jupyter extension
192194

193-
Register the kernel once:
195+
**Browser-based:**
196+
197+
- **JupyterLite**: No server required, runs entirely in the browser via WebAssembly
198+
199+
For native environments, register the kernel once:
194200

195201
.. code-block:: console
196202
197203
$ datalab-kernel-install
198204
199205
Then select "DataLab" kernel in any Jupyter frontend.
200206

207+
For JupyterLite, load the extension in your notebook:
208+
209+
.. code-block:: python
210+
211+
%load_ext datalab_kernel
212+
201213
202214
Error Handling
203215
--------------

doc/user_guide/overview.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,18 @@ This mode is ideal for:
8080
Live Mode
8181
^^^^^^^^^
8282

83-
When DataLab is running, the kernel connects via XML-RPC:
83+
When DataLab is running, the kernel connects via Web API or XML-RPC:
8484

8585
- Objects synchronized with DataLab panels
8686
- Access to DataLab's full processing pipeline via ``calc()``
8787
- Direct proxy access for advanced operations
8888
- Changes visible in real-time in DataLab GUI
8989

90+
Two connection methods are supported:
91+
92+
- **Web API** (recommended): HTTP/JSON connection, WASM/Pyodide compatible
93+
- **XML-RPC** (legacy): Automatic connection when DataLab has remote control enabled
94+
9095
This mode enables:
9196

9297
- Interactive exploration with GUI feedback

0 commit comments

Comments
 (0)