An OCaml kernel for the IPython notebook
Jupyter Notebook OCaml JavaScript Makefile C Shell Other
Permalink
Failed to load latest commit information.
notebooks update README Dec 21, 2015
profile fix logos May 5, 2014
.gitignore fix installation May 3, 2014
.travis-ci.sh Add CONTRIBUTING.md and fix build Dec 11, 2015
.travis.yml Update OPAM version used for tests Dec 10, 2015
Ipython_json.atd Fix completion mechanism Dec 10, 2015
LICENSE add license Feb 5, 2014
META has_ocp fix Aug 29, 2014
META.in modify iocaml package name May 28, 2014
Makefile rename makefile (been annoying me) Aug 30, 2014
README.md cherry pick from #45 instructions for jupyter Jun 30, 2016
_tags 1st steps towards an internal ZMQ binding May 3, 2014
base64.ml remove ocamlnet, cryptokit and optcomp depends Mar 14, 2014
base64.mli remove ocamlnet, cryptokit and optcomp depends Mar 14, 2014
completion.ml 1st steps towards an internal ZMQ binding May 3, 2014
completion.mli send ocaml reponses as pyout to get cell no's. Mar 17, 2014
exec.ml comatibility with 4.00.1 Aug 31, 2014
exec.mli Split cell execution and status rendering out Mar 18, 2014
iocaml.ml Fix notebook start by custom msg handling Dec 10, 2015
iocaml.mli optional compilation for 4.02 Aug 26, 2014
iocaml.mltop 1st steps towards an internal ZMQ binding May 3, 2014
iocaml_main.ml added command line options; -suppress_*, and -package. Syntax highlig… Feb 9, 2014
iocaml_zmq.ml comatibility with 4.00.1 Aug 31, 2014
iocaml_zmq.mli include new zmq bindings May 3, 2014
iocaml_zmq_stubs.c fix installation May 3, 2014
log.ml load .iocamlinit startup script Mar 17, 2014
log.mli make messaging more robust, add command line, better installation Feb 6, 2014
message.ml Fix notebook start by custom msg handling Dec 10, 2015
message.mli Fix notebook start by custom msg handling Dec 10, 2015
sockets.ml 1st steps towards an internal ZMQ binding May 3, 2014
sockets.mli 1st steps towards an internal ZMQ binding May 3, 2014

README.md

IOCaml logo

Build Status

IOCaml

IOCaml is an OCaml kernel for the IPython notebook. 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

This repository hosts the iocaml-kernel package.

Example picture

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

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

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 <filename> open log file
  • -init <file> 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 <filename> connection file name