ZeroMQ-based middleware for xeus
xeus-zmq provides various implementations of the xserver API from xeus, based on the ZeroMQ library. These implementations all conform to the Jupyter Kernel Protocol specification.
xeus-zmq has been packaged on all platforms for the mamba (or conda) package manager.
mamba install xeus-zmq -c conda-forge
The documentation can be found with that of xeus at http://xeus-zmq.readthedocs.io/
xeus-zmq provides server building functions that can be passed to the kernel constructor:
#include <iostream>
#include <memory>
#include "xeus/xkernel.hpp"
#include "xeus/xkernel_configuration.hpp"
#include "xeus-zmq/xzmq_context.hpp"
#include "xeus-zmq/xserver_zmq.hpp"
#include "xmock_interpreter.hpp"
int main(int argc, char* argv[])
{
std::string file_name = (argc == 1) ? "connection.json" : argv[2];
xeus::xconfiguration config = xeus::load_configuration(file_name);
auto context = xeus::make_zmq_context();
using interpreter_ptr = std::unique_ptr<my_custom_interpreter>;
interpreter_ptr interpreter = interpreter_ptr(new my_custom_interpreter());
xeus::xkernel kernel(config,
xeus::get_user_name(),
std::move(context),
std::move(interpreter),
xeus::make_xserver_default);
std::cout << "starting kernel" << std::endl;
kernel.start();
return 0;
}
See the documentation for an exhaustive list of the available functions.
xeus-zmq depends on the following libraries: xeus, ZeroMQ, cppzmq, OpenSSL, and nlohmann_json.
Versions prior to version 3 depend have an additional dependency on xtl.
xeus-zmq xeus ZeroMQ cppzmq nlohmann json OpenSSL xtl main ^4.0.0 ^4.2.5 ^4.8.1 ^3.11.3 ^3.0 >=0.7.0,<0.8.0 2.0.0 ^4.0.0 ^4.2.5 ^4.8.1 ^3.11.3 ^3.0 >=0.7.0,<0.8.0 1.x ^3.0.0 ^4.2.5 ^4.8.1 ^3.2.0 ^3.0 >=0.7.0,<0.8.0We have packaged all these dependencies on conda-forge. The simplest way to install them is to run:
mamba install cmake pkg-config zeromq cppzmq OpenSSL nlohmann_json=3.11.2 xeus -c conda-forge
Once you have installed the dependencies, you can build and install xeus-zmq:
cmake -D CMAKE_BUILD_TYPE=Release make make installInstalling the Dependencies from Source
The dependencies can also be installed from source. Simply clone the directories and run the following cmake (cmake >= 3.8) and make instructions.
xeus is the core implementation of the Jupyter kernel protocol.
cmake -D CMAKE_BUILD_TYPE=Rlease make make install
ZeroMQ is the messaging library underlying the Jupyter kernel protocol.
cmake -D WITH_PERF_TOOL=OFF -D ZMQ_BUILD_TESTS=OFF -D ENABLE_CPACK=OFF -D CMAKE_BUILD_TYPE=Release make make install
OpenSSL is packaged for most package managers (apt-get, rpm, mamba). We recommend making use of an off-the-shelf build of OpenSSL for your system.
For more information on building OpenSSL, check out the official OpenSSL wiki.
cppzmq is a header only library:
cmake -D CMAKE_BUILD_TYPE=Release make install
nlohmann_json is a header only library
See CONTRIBUTING.md to know how to contribute and set up a development environment.
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.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4