installation.rst

Installation

With mamba or conda

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

To ensure that the installation works, it is preferable to install xeus-zmq 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 already installed in the distribution.

The safest usage is to create an environment named xeus-env

mamba create -n xeus-env
mamba activate xeus-env

Then you can install xeus-zmq and its dependencies in this freshly created environment:

mamba install xeus-zmq -c conda-forge

From source

xeus-zmq depends on the following libraries:

• libzmq
• cppzmq
• OpenSSL
• xtl
• nlohmann_json
• xeus

We have packaged all these dependencies on conda-forge. The simplest way to install them is to run:

mamba env create -f environment-dev.yml -n xeus-env
mamba activate xeus-env

You can then build and install xeus-zmq:

cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX -DCMAKE_PREFIX_PATH=$CONDA_PREFIX
make
make install