Skip to content

jupyter-xeus/xeus-wren

Repository files navigation

xeus-wren

Build Status

Documentation Status Binder

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

Installation

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

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

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

Installing from source

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

mamba install cmake xeus 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

Trying it online

To try out xeus-wren interactively in your web browser, just click on the binder link: (Once Conda Package is Ready)

Binder

Documentation

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

http://xeus-wren.readthedocs.io

Dependencies

xeus-wren 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.