https://github.com/andrewray/iocaml

An OCaml kernel for the IPython notebook
https://github.com/andrewray/iocaml

Last synced: about 1 month ago
JSON representation

An OCaml kernel for the IPython notebook

• Host: GitHub
• URL: https://github.com/andrewray/iocaml
• Owner: andrewray
• License: mit
• Created: 2014-02-05T11:51:00.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2017-10-17T08:24:27.000Z (over 7 years ago)
• Last Synced: 2025-01-11T13:11:55.967Z (about 1 month ago)
• Language: Jupyter Notebook
• Homepage:
• Size: 258 KB
• Stars: 193
• Watchers: 18
• Forks: 20
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![IOCaml logo](https://raw.githubusercontent.com/andrewray/iocamlserver/master/logos/IOlogo.png "IOCaml logo")

[![Build Status](https://travis-ci.org/andrewray/iocaml.svg?branch=master)](https://travis-ci.org/andrewray/iocaml)

IOCaml

======

IOCaml is an OCaml kernel for the 

[IPython notebook](http://ipython.org/notebook.html). 

This provides a REPL within a web browser with a nice user interface 

including markdown based comments/documentation, mathjax formula and 

the possibility of generating all manner of HTML based output media 

from your code.  

See also

* [IOCaml-kernel](https://github.com/andrewray/iocaml)

* [IOCamlJS-kernel](https://github.com/andrewray/iocamljs)

* [IOCaml-server](https://github.com/andrewray/iocamlserver)

This repository hosts the iocaml-kernel package.

![Example picture](https://github.com/andrewray/iocaml/raw/master/notebooks/notebook-example-polys.png)

# Installation

Installation requires opam and OCaml >= 4.01.0.  To use the OCaml server 

```

$ opam install iocaml

```

which will install the kernels and server.  The individual kernels can be instaled with

```

$ opam install iocaml-kernel

$ opam install iocamljs-kernel

```

# Running

Simply run iocaml from the command-line. This should automatically start the iocaml web interface and open a browser window 

```

$ iocaml

```

When opening a new notebook,an iocaml-kernel process should be automatically started. For example enter `let a = 12 + 30`, hit ctrl-enter, and you should see the response `val a : int = 42`. 

Note that starting up the kernel might take a while the first time, during which your input prompt will look like `In [*]`. 

## Jupyter

The kernel can also be used with the IPython/Jupyter server.

* [IPython](https://github.com/andrewray/iocaml/wiki/ipython_install) 

* [Jupyter](https://github.com/andrewray/iocaml/wiki/jupyter)

**Note:** To use IOCaml with the latest IPython/Jupyter notebook, you'll need to start it with `--Session.key=''`:

```

jupyter notebook --Session.key=''

```

This disables some security measures that iocaml doesn't yet support.

## Command line options

The following options may be given to the IOCaml-kernel (via

the IPython profile config) or IOCaml-server.

* ``` -log  ``` open log file

* ``` -init  ``` load ```file``` instead of default init file

* ``` -completion ``` enable tab completion

* ``` -object-info ``` enable introspection

The following option is for use with IPython

* ``` -connection-file  ``` connection file name