Skip to content

Latest commit

 

History

History
89 lines (60 loc) · 3.5 KB

README.md

File metadata and controls

89 lines (60 loc) · 3.5 KB
Raw

xeus-nelson

Build Status Documentation Status Binder

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

Installation

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

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

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

Then you can install in this environment xeus-nelson and its dependencies

mamba install`xeus-nelson` notebook -c conda-forge

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 nelson-core 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

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

Binder

Documentation

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

http://xeus-nelson.readthedocs.io

Dependencies

xeus-nelson depends on

xeus-nelson xeus-zmq nlohmann_json nelson-core
main >=3.0,<4.0 >=3.11.3 >=0.3,<0.4
0.5.x >=3.0,<4.0 >=3.11.3 >=0.3,<0.4

Prior vo version 0.2, xeus-nelson was also depending on xtl & cppzmq:

xeus-nelson xeus-zmq xtl cppzmq nlohmann_json nelson-core
0.4.x >=1.0.0,<2.0 >=0.7.0,<0.8 ~4.4.1 >=3.11.2 >=0.3,<0.4

Contributing

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

License

This software is licensed under the GNU Lesser General Public License version 3. See the LICENSE file for details.