Skip to content

Commit

Permalink
Update screencast to use JupyterLab
Browse files Browse the repository at this point in the history
  • Loading branch information
SylvainCorlay committed Jun 30, 2018
1 parent 1bfc04c commit d1b00c1
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,19 @@ The C++ backend for Jupyter interactive widgets.

## Introduction

`xwidgets` is a C++ implementation of the Jupyter interactive widgets protocol. The Python reference implementation is available in the [ipywidgets](https://github.com/jupyter-widgets/ipywidgets) project.
`xwidgets` is a C++ implementation of the Jupyter interactive widgets protocol.
The Python reference implementation is available in the
[ipywidgets](https://github.com/jupyter-widgets/ipywidgets) project.

`xwidgets` enables the use of the Jupyter interactive widgets in the C++ notebook, powered by the `xeus-cling` kernel and the `cling` C++ interpreter from CERN. `xwidgets` can also be used to create applications making use of the Jupyter interactive widgets without the C++ kernel *per se*.
`xwidgets` enables the use of the Jupyter interactive widgets in the C++
notebook, powered by the `xeus-cling` kernel and the `cling` C++ interpreter
from CERN. `xwidgets` can also be used to create applications making use of the
Jupyter interactive widgets without the C++ kernel *per se*.

## Usage

Launch the jupyter notebook with `jupyter notebook` and launch a new C++ notebook by selecting the **xeus C++14** kernel in the *new* dropdown.
Launch the jupyter notebook with `jupyter notebook` and launch a new C++
notebook by selecting the **xeus C++14** kernel in the *new* dropdown.

![Widgets](widgets.gif)

Expand All @@ -30,7 +36,8 @@ We provide a package for the conda package manager.
conda install xeus-cling xwidgets -c QuantStack -c conda-forge
```

Then, the front-end extension must be installed for either the classic notebook or JupyterLab.
Then, the front-end extension must be installed for either the classic notebook
or JupyterLab.

- Installing the extension for the classic notebook

Expand All @@ -54,7 +61,8 @@ Specific version of

## Installation from sources

Or you can directly install it from the sources if you have all the dependencies already installed:
Or you can directly install it from the sources if you have all the
dependencies already installed:

```bash
cmake -D CMAKE_INSTALL_PREFIX=your_install_prefix
Expand Down Expand Up @@ -97,4 +105,5 @@ All the dependencies of xwidgets are available for the conda package manager.
We use a shared copyright model that enables all contributors to maintain the
copyright on their contributions.

This software is licensed under the BSD-3-Clause license. See the [LICENSE](LICENSE) file for details.
This software is licensed under the BSD-3-Clause license.
See the [LICENSE](LICENSE) file for details.
Binary file modified widgets.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d1b00c1

Please sign in to comment.