Skip to content

Latest commit

 

History

History
136 lines (98 loc) · 4.39 KB

README.in.rst

File metadata and controls

136 lines (98 loc) · 4.39 KB

EIN -- Emacs IPython Notebook Build Status MELPA development version MELPA stable version

--- or EIN Is not only for pythoN.

Install

Install from MELPA (recommended) or make install from github source.

Usage

Start EIN using one of the following:

  • Open an .ipynb file normally in emacs and press C-c C-o, or,
  • M-x ein:run launches a jupyter process from emacs, or,
  • M-x ein:login to a running jupyter server

Use C-u M-x ein:login for services such as mybinder.org requiring cookie authentication.

Alternatively, ob-ein.

Reporting bugs

EIN is tested on GNU Emacs versions .. CI VERSION (see Makefile) and later. We presently do not recommend the spacemacs layer.

Please file issues using M-x ein:dev-bug-report-template.

You may also try to self-diagnose.

First invoke M-x ein:dev-start-debug. Then reproduce the error.

General logging M-x ein:log-pop-to-all-buffer.

Notebook server M-x ein:log-pop-to-request-buffer.

Kernel messaging (must be run from notebook buffer) M-x ein:dev-pop-to-debug-channels.

I want to use Elpy, ESS, julia-mode

Enable polymode via:

M-x customize-group RET ein
Toggle Ein:Polymode

ob-ein

Configuration:

M-x customize-group RET org-babel
Org Babel Load Languages:
  Insert (ein . t)
  For example, '((emacs-lisp . t) (ein . t))

Snippet:

#BEGIN_SRC ein-python :session localhost :results raw drawer
  import numpy, math, matplotlib.pyplot as plt
  %matplotlib inline
  x = numpy.linspace(0, 2*math.pi)
  plt.plot(x, numpy.sin(x))
#+END_SRC

The :session is the notebook url, e.g., http://localhost:8888/my.ipynb, or simply localhost, in which case org evaluates anonymously. A port may also be specified, e.g., localhost:8889.

Language can be ein-python, ein-r, or ein-julia. The relevant jupyter kernel must be installed before use. Additional languages can be configured via:

M-x customize-group RET ein
Ob Ein Languages

Connected Buffers

Use M-x ein:connect-to-notebook to submit code from an arbitrary buffer to a running jupyter kernel. See connected buffer details.

Keymap (C-h m)

.. KEYS NOTEBOOK (see Makefile)

Links

License

Emacs IPython Notebook is licensed under GPL v3. See COPYING for details.