hiro/emacs-ipython-notebook
1
0
Fork 0
mirror of https://github.com/vale981/emacs-ipython-notebook synced 2025-03-05 09:01:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
109 commits 35 branches 33 tags 8.1 MiB
Emacs Lisp 96.1%
Gherkin 2.6%
Makefile 0.6%
Shell 0.5%
Jupyter Notebook 0.2%
Find a file
Takafumi Arakaki e259b4f3c7 Added a command to kill kernel
2012-05-13 07:40:15 +02:00
tests Add ein:notebook-test-notebook-name 2012-05-13 04:47:41 +02:00
debug-ein.el Hack to shorten *Backtrace* lines 2012-05-11 04:24:05 +02:00
ein-cell.el Fix ein:cell-convert(-inplace) 2012-05-11 23:52:04 +02:00
ein-events.el First commit of bare bone version 2012-05-07 14:41:15 +02:00
ein-kernel.el Added a command to kill kernel 2012-05-13 07:40:15 +02:00
ein-log.el Add ein:deflocal to eliminate boilerplate 2012-05-12 22:55:44 +02:00
ein-mumamo.el Remove suspicious code "(not end)" 2012-05-10 23:14:00 +02:00
ein-node.el First commit of bare bone version 2012-05-07 14:41:15 +02:00
ein-notebook.el Added a command to kill kernel 2012-05-13 07:40:15 +02:00
ein-notebooklist.el Notebook can be deleted now 2012-05-13 06:51:26 +02:00
ein-pager.el Implement ein-pager.el: help? works now 2012-05-11 05:24:34 +02:00
ein-utils.el Notebook can be deleted now 2012-05-13 06:51:26 +02:00
ein-websocket.el Add ein:$websocket-closed-by-client (~= wasClean) 2012-05-09 08:54:02 +02:00
ein.el First commit of bare bone version 2012-05-07 14:41:15 +02:00
README.rst Improve usage section in README 2012-05-11 00:12:16 +02:00

README.rst 

========================
 Emacs IPython Notebook
========================

.. warning:: This is **very** early version.
             Do not use it in a serious situation!

Screenshot
==========

.. figure:: http://farm8.staticflickr.com/7125/7006219050_2d424b4ece_z.jpg
   :alt: Plotting in Emacs IPython Notebook


Requirements
============

* IPython_ **0.12.1**: EIN won't work with older versions.
* `websocket.el`_
* (optional) mumamo_:
  It will be automatically loaded when it is on the path.
  The official way to setup path is to load nXhtml_.
  So you will need to load nXhtml_ *before* loading EIN.
* (optional) markdown-mode
* (optional) python-mode:
  It should work with either python.el or python-mode.el.

EIN is currently tested in Emacs 24.

.. _IPython: http://ipython.org/
.. _websocket.el: https://github.com/ahyatt/emacs-websocket
.. _mumamo: http://www.emacswiki.org/emacs/MuMaMo
.. _nXhtml: http://ourcomments.org/Emacs/nXhtml/doc/nxhtml.html


Usage
=====

1. Install module.
   Put Emacs lisp ``ein*.el`` files in your load path.

2. Require module::

     (require 'ein)

3. Start `IPython notebook server`_.

4. Hit ``M-x ein:notebooklist-open`` to open notebook list.

.. _`IPython notebook server`:
   http://ipython.org/ipython-doc/stable/interactive/htmlnotebook.html