JohanMabille / xeus-pywrap

create jupyter kernels with the help of xeus and python

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

xeus-pywrap

Build Status

Documentation Status Binder

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

Installation

xeus-pywrap has not been packaged for the mamba (or conda) package manager.

To ensure that the installation works, it is preferable to install xeus-pywrap in a fresh environment. It is also needed to use a miniforge or 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-pywrap

mamba create -n  `xeus-pywrap`
source activate  `xeus-pywrap`

Installing from source

Or you can install it from the sources, you will first need to install dependencies

mamba install cmake cxx-compiler xeus-zmq nlohmann_json cppzmq xtl jupyterlab -c conda-forge

Then you can compile the sources (replace $CONDA_PREFIX with a custom installation prefix if need be)

mkdir build && cd build
cmake .. -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib
make && make install

Documentation

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

http://xeus-pywrap.readthedocs.io

Dependencies

xeus-pywrap depends on

Contributing

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

License

This software is licensed under the BSD 3-Clause License. See the LICENSE file for details.

About

create jupyter kernels with the help of xeus and python

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:C++ 43.2%Language:CMake 33.5%Language:Python 21.8%Language:Jupyter Notebook 1.5%