Skip to content
Jupyter kernel for the C++ programming language
C++ CMake Jupyter Notebook Python
Branch: master
Clone or download

README.md

xeus-cling

Travis Appveyor Documentation Status Binder Join the Gitter Chat

xeus-cling is a Jupyter kernel for C++ based on the C++ interpreter cling and the native implementation of the Jupyter protocol xeus.

Installation

xeus-cling has been packaged for the conda package manager on the Linux and OS X platforms. At the moment, we are not providing packages for the Windows platform.

To ensure that the installation works, it is preferable to install xeus-cling in a fresh conda environment. It is also needed to use a miniconda installation because with the full anaconda you may have a conflict with the ZeroMQ library which is already installed in the anaconda distribution.

The safest usage is to create an environment named cling with your miniconda installation

conda create -n cling
conda activate cling  # Or `source activate cling` for conda < 4.6

Then you can install in this environment xeus-cling and its dependencies

conda install xeus-cling -c conda-forge

Or you can install it directly from the sources, if all the dependencies are already installed.

cmake -DCMAKE_INSTALL_PREFIX=your_conda_path -DCMAKE_INSTALL_LIBDIR=your_conda_path/lib
make && make install

Trying it online

To try out xeus-cling interactively in your web browser, just click on the binder link:

Binder

Documentation

To get started with using xeus-cling, check out the full documentation

http://xeus-cling.readthedocs.io/

Usage

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

A C++ notebook

You can now make use of the C++ programming language in the Jupyter notebook.

A C++ notebook

Inline help and tab-completion

Quick help is shown on the pager with the special ? magic.

Help

Content for the quick help is available for the standard library, and can be made available for third-party packages.

Rendering of rich outputs

Rich output

Jupyter interactive widgets

A C++ backend for the Jupyter interactive widgets is available in the xwidgets package.

Widgets

Dependencies

xeus-cling depends on

xeus-cling xeus xtl cling pugixml cppzmq cxxopts nlohmann_json dirent (windows only)
master >=0.23.2,<0.24 >=0.6.5,<0.7 >=0.6,<0.7 ~1.8.1 ~4.3.0 >=2.1.1,<=3.0 >=3.6.1,<4.0 >=2.3.2,<3
0.8.1 >=0.23.2,<0.24 >=0.6.5,<0.7 >=0.6,<0.7 ~1.8.1 ~4.3.0 >=2.1.1,<=3.0 >=3.6.1,<4.0 >=2.3.2,<3
0.8.0 >=0.23.2,<0.24 >=0.6.5,<0.7 >=0.6,<0.7 ~1.8.1 ~4.3.0 >=2.1.1,<=3.0 >=3.6.1,<4.0 >=2.3.2,<3
0.7.1 >=0.21.1,<0.22 >=0.6.5,<0.7 >=0.5,<0.6 ~1.8.1 ~4.3.0 >=2.1.1,<=3.0 >=3.6.1,<4.0 >=2.3.2,<3
0.7.0 >=0.21.1,<0.22 >=0.6.5,<0.7 >=0.5,<0.6 ~1.8.1 ~4.3.0 >=2.1.1,<=3.0 >=3.6.1,<4.0 >=2.3.2,<3
0.6.0 >=0.20.0,<0.21 >=0.6.1,<0.7 >=0.5,<0.6 ~1.8.1 ~4.3.0 >=2.1.1,<=3.0 >=3.3.0,<4.0 >=2.3.2,<3
0.5.1 >=0.19.1,<0.20 >=0.6.1,<0.7 >=0.5,<0.6 ~1.8.1 ~4.3.0 >=2.1.1,<=3.0 >=3.3.0,<4.0 >=2.3.2,<3
0.5.0 >=0.19.1,<0.20 >=0.6.1,<0.7 >=0.5,<0.6 ~1.8.1 ~4.3.0 >=2.1.1,<=3.0 >=3.3.0,<4.0 >=2.3.2,<3

xeus-cling requires its dependencies to be built with the same compiler and same C runtime as the one used to build cling.

Contributing

See CONTRIBUTING.md to know how to contribute and set up a development environment.

License

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 file for details.

You can’t perform that action at this time.