Minimal Native kernel for Jupyter

The goal of this kernel is to provide a unified frontend for working with native languages from jupyter.

It was started from the jupyter C kernel.

Usage:

C/C++

• load to load a file to the cell

//%load https://passlab.github.io/CSCE569/resources/axpy.c
//%compiler: gcc
//%cflags: -fopenmp
//%ldflags: -lm
//%args: 1024

• Set a different compiler, such as clang, using magic keyword //%compiler

//%compiler: clang
//%cflags: -fopenmp

#include <stdio.h>
#include <stdlib.h>
#include <omp.h>

int main (int argc, char** argv) {
    int i;
    #pragma omp parallel for num_threads(6)
    for (i = 0; i < 12; i++)
        printf("Thread: %d, i = %d\n", omp_get_thread_num(), i);
    
    return 0;
    
    
}

Fortran

The Jupyter kernel adds the magic keyword as a comment in the source code. Since the keywords for comment in C/C++ and Fortran are different, we need to specify the magic keywords for Jupyter kernel accordingly. In the following example of Fortran program, we must use the leading magic keyword !!% instead of //%.

!!%compiler: gfortran
!!%cflags: -fopenmp

PROGRAM Parallel_Hello_World
USE OMP_LIB

!$OMP PARALLEL

  PRINT *, "Hello from process: ", OMP_GET_THREAD_NUM()

!$OMP END PARALLEL

END

Setup

Works only on Linux and OS X. Windows is not supported yet. If you want to use this project on Windows, please use Docker.

Make sure you have the following requirements installed:

• gcc
• jupyter
• python 3
• pip

Install (virtualenv, pip)

This kernel has been uploaded to the official Python package repository. Instead of building from source code, it can be installed directly by pip as follows.

1. virtualenv -p python3 venv
2. source venv/bin/activate
3. pip3 install jupyter-native-kernel
4. install_native_kernel --user

Install (system)

This installs the kernel at the system level. (Not tested yet.)

1. git clone <this repo>
2. sudo pip3 install -e jupyter-native-kernel
3. sudo install_native_kernel

To install on system folder, do sudo install_native_kernel --sys-prefix

Install (virtualenv)

This installs the kernel within the current virtualenv.

1. git clone <this repo>
2. virtualenv -p python3 venv
3. source venv/bin/activate
4. pip3 install -e jupyter-native-kernel
5. install_native_kernel --user

License

This project is released under the MIT License.