Giter VIP home page Giter VIP logo

xeus-cpp's Introduction

xeus-cpp

Build Status Documentation Status Binder codecov

Conda-Forge Anaconda-Server Badge Conda Platforms Anaconda-Server Badge

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

Installation within a mamba environment (non wasm build instructions)

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

First clone the repository, and move into that directory

git clone --depth=1 https://github.com/compiler-research/xeus-cpp.git
cd ./xeus-cpp

The safest usage of xeus-cpp from source is to build and install it within a clean environment named xeus-cpp. You can create and activate this environment with mamba by executing the following

mamba create -n  "xeus-cpp"
source activate  "xeus-cpp"

We will now install the dependencies needed to compile xeux-cpp from source within this environment by executing the following

mamba install notebook cmake cxx-compiler xeus-zmq nlohmann_json=3.11.2 cppzmq xtl jupyterlab CppInterOp cpp-argparse<3.1 pugixml doctest -c conda-forge

Now you can compile the kernel from the source by executing (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

To test the build you execute the following to test the C++ tests

cd test
./test_xeus_cpp

and

pytest -sv .

to perform the python tests. Once the build is passing all the tests you can install it by executing the following from the test folder

cd ..
make install

Installation within a mamba environment (wasm build instructions)

First clone the repository, and move into that directory

git clone --depth=1 https://github.com/compiler-research/xeus-cpp.git
cd ./xeus-cpp

Now you'll want to create a clean mamba environment containing the tools you'll need to do a wasm build. This can be done by executing the following

micromamba create -n "xeus-cpp-wasm-build" -y environment-wasm-build.yml

You'll now want to make sure you're using emsdk version "3.1.45" and activate it. You can get this by executing the following

emsdk install 3.1.45
emsdk activate 3.1.45
source $CONDA_EMSDK_DIR/emsdk_env.sh

You are now in a position to build the xeus-cpp kernel. You build it by executing the following

micromamba create -f environment-wasm-host.yml --platform=emscripten-wasm32
mkdir build
pushd build
export EMPACK_PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-build
export PREFIX=$MAMBA_ROOT_PREFIX/envs/xeus-cpp-wasm-host 
export CMAKE_PREFIX_PATH=$PREFIX
export CMAKE_SYSTEM_PREFIX_PATH=$PREFIX

emcmake cmake \
        -DCMAKE_BUILD_TYPE=Release                        \
        -DCMAKE_PREFIX_PATH=$PREFIX                       \
        -DCMAKE_INSTALL_PREFIX=$PREFIX                    \
        -DXEUS_CPP_EMSCRIPTEN_WASM_BUILD=ON               \
        -DCMAKE_FIND_ROOT_PATH_MODE_PACKAGE=ON            \
        ..
EMCC_CFLAGS='-sERROR_ON_UNDEFINED_SYMBOLS=0' emmake make install

To test building Jupyter Lite with this kernel without creating a website you can execute the following

micromamba create -n xeus-lite-host jupyterlite-core
micromamba activate xeus-lite-host
python -m pip install jupyterlite-xeus
jupyter lite build --XeusAddon.prefix=$PREFIX

Trying it online

To try out xeus-cpp interactively in your web browser, just click on the binder link:

Binder

Documentation

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

http://xeus-cpp.readthedocs.io

Dependencies

xeus-cpp depends on

xeus-cpp xeus-zmq xtl CppInterOp clang pugixml cppzmq cpp-argparse nlohmann_json dirent (windows only)
main >=1.0.0,<2.0.0 >=0.7.7,<0.8.0 >=1.2.0 ~1.8.1 ~4.3.0 <3.1 >=3.11.2,<4.0 >=2.3.2,<3
0.4.0 >=1.0.0,<2.0.0 >=0.7.7,<0.8.0 >=16,<17 ~1.8.1 ~4.3.0 ~2.9 >=3.6.1,<4.0 >=2.3.2,<3
0.3.0 >=1.0.0,<2.0.0 >=0.7.7,<0.8.0 >=16,<17 ~1.8.1 ~4.3.0 ~2.9 >=3.6.1,<4.0 >=2.3.2,<3
0.2.0 >=1.0.0,<2.0.0 >=0.7.7,<0.8.0 >=16,<17 ~1.8.1 ~4.3.0 ~2.9 >=3.6.1,<4.0 >=2.3.2,<3
0.1.0 >=1.0.0,<2.0.0 >=0.7.0,<0.8.0 >=16,<17 ~1.8.1 ~4.3.0 ~2.9 >=3.6.1,<4.0 >=2.3.2,<3
0.0.1 >=1.0.0,<2.0.0 >=0.7.0,<0.8.0 >=16,<17 ~1.8.1 ~4.3.0 ~2.9 >=3.6.1,<4.0 >=2.3.2,<3

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.

xeus-cpp's People

Contributors

mcbarton avatar vgvassilev avatar alexander-penev avatar anutosh491 avatar mvassilev avatar sylvaincorlay avatar johanmabille avatar tharun571 avatar krishna-13-cyber avatar chococandy63 avatar brauliorivas avatar davy39 avatar derthorsten avatar ioanaif avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.