Skip to content

Latest commit

 

History

History
87 lines (67 loc) · 3.19 KB

README.md

File metadata and controls

87 lines (67 loc) · 3.19 KB

IJavascript: A Javascript Kernel for IPython's Graphical Notebook

IJavascript is an npm package that implements a Javascript kernel for IPython's graphical notebook (also known as Jupyter). An IPython notebook combines the creation of rich-text documents (including equations, plots and videos) with the execution of code in a number of programming languages.

The execution of code is carried out by means of a kernel that implements the IPython messaging protocol. There are kernels available for Python, Julia, Ruby, Haskell and many other languages.

Main Features

Installation

The instructions to install IJavascript are platform-dependent. For example, in Ubuntu 14.04, IJavascript and its prerequisites can be installed simply by running:

sudo apt-get install nodejs-legacy npm ipython ipython-notebook libzmq-dev
sudo npm install -g ijavascript

For other platforms, please, refer to the installation notes.

Usage

To start an IPython notebook session with the IJavascript kernel, run:

ijs

This command should open the IPython notebook dashboard in your default web browser:

Screenshot: IPython Notebook Dashboard

Here's a sample notebook that makes use of the IJavascript kernel:

Screenshot: Notebook Hello Sample

Please, refer to the usage notes for further details.

Contributions

First of all, thank you for taking the time to contribute. Please, read CONTRIBUTING and use the issue tracker for any contributions: support requests, bug reports, enhancement requests, pull requests, submission of tutorials...

TO DO

  • Use module:jmp~Socket
  • Use Mocha test framework
  • Update tutorial on globals to discuss the use of var
  • Implement $$text$$
  • Add tutorial to demonstrate animated graphs and javascript injection
  • Complete the implementation of IPython's messaging protocol v4.1
  • Complete the implementation of IPython's messaging protocol v5.0