Skip to content

JohanMabille/xeus-python

Repository files navigation

xeus-python

Travis Appveyor Documentation Status Binder Join the Gitter Chat

xeus-python is a Jupyter kernel for Python based on the native implementation of the Jupyter protocol xeus.

xeus-python is an early developer preview, and is not suitable for general usage yet. Features and implementation are subject to change.

Installation

xeus-python has been packaged for the conda package manager.

To ensure that the installation works, it is preferable to install xeus-python 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 xeus with your miniconda installation

conda create -n xeus
source activate xeus

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

conda install xeus-python notebook -c QuantStack -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-python interactively in your web browser, just click on the binder link:

Binder

Documentation

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

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

Usage

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

Dependencies

xeus-python depends on

xeus-python xeus xtl cppzmq nlohmann_json pybind11 jedi
master >=0.17.0,<0.18 >=0.5.0,<0.6 ~4.3.0 >=3.3.0,<4.0 >=2.2.4,<3.0 >=0.13.1,<0.14.0
0.0.2 >=0.16.0,<0.17 >=0.4.0,<0.5 ~4.3.0 >=3.3.0,<4.0 >=2.2.4,<3.0
0.0.1 >=0.15.0,<0.16 >=0.4.0,<0.5 ~4.3.0 >=3.3.0,<4.0 >=2.2.4,<3.0

The QuantStack channel provides xeus dependencies built with gcc-7. 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 the Python programming language

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 80.9%
  • Jupyter Notebook 8.8%
  • CMake 8.1%
  • Python 2.0%
  • JavaScript 0.2%