Skip to content

skyformat99/xeus-cling

 
 

Repository files navigation

xeus-cling

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 platform. To be sure 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 anaconda you can have a conflict with the zeromq library which is already installed with anaconda.

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

conda create -n cling
source activate cling

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

conda install cling -c QuantStack -c conda-forge
conda install xeus-cling -c QuantStack -c conda-forge
conda install notebook -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

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.

A C++ notebook

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

A C++ notebook

Quick help and tab completion.

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

Help

Content for the help is available for the standard library and the QuantStack packages.

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
master >0.8.0,<0.9 >=0.3.4,<0.4 >=0.3,<0.4 ~1.8.1 ~4.2.1 >=1.4.1,<=1.4.4
0.0.8 >0.8.2,<0.9 >=0.3.4,<0.4 >=0.3,<0.4 ~1.8.1 ~4.2.1 >=1.4.1,<=1.4.4
0.0.7 >0.8.0,<0.9 >=0.3.4,<0.4 >=0.3,<0.4 ~1.8.1 ~4.2.1 >=1.4.1,<=1.4.4
0.0.6 >0.6.0,<0.8 >=0.2.2,<0.3 >=0.3,<0.4 ~1.8.1 ~4.2.1 >=1.4.1,<=1.4.4

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

The QuantStack channel provides a xeus, cling and their dependencies built with gcc-6. We highly recommend installing these dependencies from QuantStack in a clean conda installation or 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.

About

Jupyter Kernel for C++ based on xeus and cling

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 72.3%
  • Jupyter Notebook 14.9%
  • CMake 6.8%
  • Python 6.0%