Skip to content

IsabelParedes/xeus-ruby

Repository files navigation

xeus-ruby

Build Status

Documentation Status Binder

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

Installation

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

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

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

Installing from source

Or you can install it from source, 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 needed)

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

Or skip all of the above and install it with pixi.

pixi run -e dev start

Dependencies

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