Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jupyter-xeus/xeus-cling
Jupyter kernel for the C++ programming language
https://github.com/jupyter-xeus/xeus-cling
c-plus-plus-14 jupyter-kernels
Last synced: about 18 hours ago
JSON representation
Jupyter kernel for the C++ programming language
- Host: GitHub
- URL: https://github.com/jupyter-xeus/xeus-cling
- Owner: jupyter-xeus
- License: bsd-3-clause
- Created: 2017-04-20T15:35:44.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T15:55:46.000Z (10 months ago)
- Last Synced: 2024-10-29T15:07:50.516Z (4 months ago)
- Topics: c-plus-plus-14, jupyter-kernels
- Language: C++
- Homepage:
- Size: 10.4 MB
- Stars: 3,087
- Watchers: 66
- Forks: 299
- Open Issues: 176
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jupyter-resources - GitHub - 53% open · ⏱️ 17.01.2022): (Jupyter内核)
- best-of-jupyter - GitHub - 56% open · ⏱️ 16.04.2024): (Jupyter Kernels)
- awesome-starred - jupyter-xeus/xeus-cling - Jupyter kernel for the C++ programming language (others)
- StarryDivineSky - jupyter-xeus/xeus-cling
README
# 
[](https://dev.azure.com/jupyter-xeus/jupyter-xeus/_build/latest?definitionId=4&branchName=master)
[](https://ci.appveyor.com/project/jupyter-xeus/xeus-cling)
[](https://xeus-cling.readthedocs.io/en/latest/?badge=latest)
[](https://mybinder.org/v2/gh/jupyter-xeus/xeus-cling/stable?filepath=notebooks/xcpp.ipynb)
[](https://gitter.im/QuantStack/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
`xeus-cling` is a Jupyter kernel for C++ based on the C++ interpreter [cling](https://github.com/root-project/cling) and
the native implementation of the Jupyter protocol [xeus](https://github.com/jupyter-xeus/xeus).
## Installation
xeus-cling has been packaged for the mamba (or 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 environment. It is also needed to use a [miniforge](https://github.com/conda-forge/miniforge) or [miniconda](https://conda.io/miniconda.html) installation because with the full [anaconda](https://www.anaconda.com/) you may have a conflict with the `ZeroMQ` library which is already installed in the anaconda distribution.
### Installation with mamba or conda
The safest usage is to create an environment named `cling`:
```
mamba create -n cling
source activate cling
```
Then you can install in this environment `xeus-cling` and its dependencies
```
mamba install xeus-cling -c conda-forge
```
### Installation from source
You will first need to create a new environment and install the dependencies:
```bash
mamba create -n xeus-cling -c conda-forge cmake xeus-zmq cling nlohmann_json=3.11.2 cppzmq xtl pugixml doctest cpp-argparse
source activate xeus-cling
```
Please refer to [environment-host.yml](https://github.com/jupyter-xeus/xeus-cling/blob/main/environment-host.yml) for packages specific versions to install if applicable.
You can then compile the sources. From the build directory, run:
```bash
cmake -D CMAKE_INSTALL_PREFIX=${CONDA_PREFIX} -D CMAKE_C_COMPILER=$CC -D CMAKE_CXX_COMPILER=$CXX -D CMAKE_INSTALL_LIBDIR=${CONDA_PREFIX}/lib ..
make && make install
```
If you don't have a frontend already installed (classic Jupyter Notebook or JupyterLab for instance), install one:
```bash
mamba install jupyterlab -c conda-forge
```
## Trying it online
To try out xeus-cling interactively in your web browser, just click on the binder
link:
[](https://mybinder.org/v2/gh/jupyter-xeus/xeus-cling/stable?filepath=notebooks/xcpp.ipynb)
## 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++17** kernel in the *new* dropdown.
### A C++ notebook
You can now make use of the C++ programming language in the Jupyter notebook.
### Inline help and tab-completion
Quick help is shown on the pager with the special `?` magic.
Content for the quick help is available for the standard library, and can be made available for third-party packages.
### Rendering of rich outputs
### Jupyter interactive widgets
A C++ backend for the Jupyter interactive widgets is available in the [`xwidgets`](https://github.com/jupyter-xeus/xwidgets/) package.
## Dependencies
``xeus-cling`` depends on
- [xeus-zmq](https://github.com/jupyter-xeus/xeus-zmq)
- [xtl](https://github.com/xtensor-stack/xtl)
- [cling](https://github.com/root-project/cling)
- [pugixml](https://github.com/zeux/pugixml)
- [cpp-argparse](https://github.com/p-ranav/argparse)
- [nlohmann_json](https://github.com/nlohmann/json)
| `xeus-cling` | `xeus-zmq` | `xtl` | `cling` | `pugixml` | `cppzmq` | `cpp-argparse`| `nlohmann_json` | `dirent` (windows only) |
|--------------|-----------------|-----------------|---------------|---------------|----------|---------------|-----------------|-------------------------|
| main | >=1.1.0,<2.0.0 | >=0.7.0,<0.8.0 | >=0.9,<0.10 | ~1.8.1 | ~4.3.0 | ~3.0 | ~3.11.2 | >=2.3.2,<3 |
| 0.15.3 | >=1.1.0,<2.0.0 | >=0.7.0,<0.8.0 | >=0.9,<0.10 | ~1.8.1 | ~4.3.0 | ~2.9 | >=3.6.1,<4.0 | >=2.3.2,<3 |
| 0.15.2 | >=1.1.0,<2.0.0 | >=0.7.0,<0.8.0 | >=0.9,<0.10 | ~1.8.1 | ~4.3.0 | ~2.9 | >=3.6.1,<4.0 | >=2.3.2,<3 |
| 0.15.1 | >=1.0.0,<2.0.0 | >=0.7.0,<0.8.0 | >=0.9,<0.10 | ~1.8.1 | ~4.3.0 | ~2.9 | >=3.6.1,<4.0 | >=2.3.2,<3 |
| 0.15.0 | >=1.0.0,<2.0.0 | >=0.7.0,<0.8.0 | >=0.9,<0.10 | ~1.8.1 | ~4.3.0 | ~2.9 | >=3.6.1,<4.0 | >=2.3.2,<3 |
Prior to version 0.15, `xeus-cling` was depending on `cxxopts` instead of `cpp-argparse`.
| `xeus-cling` | `xeus-zmq` | `xtl` | `cling` | `pugixml` | `cppzmq` | `cxxopts` | `nlohmann_json` | `dirent` (windows only) |
|--------------|-----------------|-----------------|---------------|---------------|----------|---------------|-----------------|-------------------------|
| 0.14.0 | >=1.0.0,<2.0.0 | >=0.7.0,<0.8.0 | >=0.6,<0.9 | ~1.8.1 | ~4.3.0 | >=2.1.1,<=2.2 | >=3.6.1,<4.0 | >=2.3.2,<3 |
Prior to version 0.14, `xeus-cling` was depending on `xeus` instead of `xeus-zmq`:
| `xeus-cling` | `xeus` | `xtl` | `cling` | `pugixml` | `cppzmq` | `cxxopts` | `nlohmann_json` | `dirent` (windows only) |
|--------------|-----------------|-----------------|---------------|---------------|----------|---------------|-----------------|-------------------------|
| 0.13.0 | >=2.0.0,<3.0.0 | >=0.7.0,<0.8.0 | >=0.6,<0.9 | ~1.8.1 | ~4.3.0 | >=2.1.1,<=2.2 | >=3.6.1,<3.10 | >=2.3.2,<3 |
| 0.12.1 | >=1.0.0,<2.0.0 | >=0.7.0,<0.8.0 | >=0.6,<0.9 | ~1.8.1 | ~4.3.0 | >=2.1.1,<=2.2 | >=3.6.1,<4.0 | >=2.3.2,<3 |
| 0.12.0 | >=1.0.0,<2.0.0 | >=0.7.0,<0.8.0 | >=0.6,<0.9 | ~1.8.1 | ~4.3.0 | >=2.1.1,<=2.2 | >=3.6.1,<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](./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](LICENSE) file for details.