mirror of
https://github.com/vale981/emacs-ipython-notebook
synced 2025-03-06 01:21:38 -05:00
234cf391f9
M-x customize-group RET ein Toggle Ein:Polymode Avoid trying to emulate jump-to-definition, eldoc, and autocompletion functionalities that Elpy will always do better. Fixes #497 #482 #418
122 lines
4 KiB
ReStructuredText
122 lines
4 KiB
ReStructuredText
========================================================================
|
|
EIN -- Emacs IPython Notebook |build-status| |melpa-dev| |melpa-stable|
|
|
========================================================================
|
|
|
|
--- or **E**\ IN **I**\ s not only for **N**\ otebooks.
|
|
|
|
.. COMMENTARY (see Makefile)
|
|
|
|
.. |build-status|
|
|
image:: https://secure.travis-ci.org/millejoh/emacs-ipython-notebook.png?branch=master
|
|
:target: http://travis-ci.org/millejoh/emacs-ipython-notebook
|
|
:alt: Build Status
|
|
.. |melpa-dev|
|
|
image:: http://melpa.milkbox.net/packages/ein-badge.svg
|
|
:target: http://melpa.milkbox.net/#/ein
|
|
:alt: MELPA development version
|
|
.. |melpa-stable|
|
|
image:: http://melpa-stable.milkbox.net/packages/ein-badge.svg
|
|
:target: http://melpa-stable.milkbox.net/#/ein
|
|
:alt: MELPA stable version
|
|
.. _Jupyter: http://jupyter.org
|
|
.. _tkf: https://tkf.github.io/emacs-ipython-notebook
|
|
|
|
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.
|
|
|
|
.. _Cask: https://cask.readthedocs.io/en/latest/guide/installation.html
|
|
.. _MELPA: http://melpa.org/#/
|
|
|
|
It doesn't work
|
|
---------------
|
|
|
|
EIN is tested on GNU Emacs versions
|
|
.. CI VERSION (see Makefile)
|
|
and later. Your mileage may vary with the `spacemacs layer`_ and other *emacsen*.
|
|
|
|
You may also try to self-diagnose:
|
|
|
|
First invoke ``M-x ein:dev-start-debug``. Then reproduce the error.
|
|
|
|
High level diagnostics appear in ``M-x ein:log-pop-to-all-buffer``.
|
|
|
|
Low level diagnostics appear in ``M-x ein:log-pop-to-request-buffer``.
|
|
|
|
If you cannot resolve the problem, file an issue using ``M-x ein:dev-bug-report-template``.
|
|
|
|
.. _spacemacs layer: https://github.com/syl20bnr/spacemacs/tree/master/layers/%2Blang/ipython-notebook
|
|
.. _auto-complete: https://github.com/auto-complete/auto-complete
|
|
.. _company-mode: https://github.com/company-mode/company-mode
|
|
.. _jupyterhub: https://github.com/jupyterhub/jupyterhub
|
|
|
|
I want to use Elpy, ESS, LSP, etc.
|
|
==================================
|
|
|
|
Enable `polymode`_ via::
|
|
|
|
M-x customize-group RET ein
|
|
Toggle Ein:Polymode
|
|
|
|
Org-mode Integration
|
|
====================
|
|
|
|
EIN provides org-babel functionality similar to ob-ipython_ and scimax_.
|
|
|
|
*Language* is ``ein``. The ``:session`` header argument is the notebook url, e.g., ``https://localhost:8888/my.ipynb``, or simply ``localhost``, in which case EIN will evaluate org blocks in an anonymous notebook::
|
|
|
|
#BEGIN_SRC ein :session localhost :results raw drawer :image output.png
|
|
import matplotlib.pyplot as plt
|
|
import numpy as np
|
|
|
|
%matplotlib inline
|
|
x = np.linspace(0, 1, 100)
|
|
y = np.random.rand(100,1)
|
|
plt.plot(x,y)
|
|
#+END_SRC
|
|
|
|
You may also specify the port, i.e., ``localhost:8889``. See `ob-ein details`_.
|
|
|
|
.. _polymode: https://github.com/polymode/polymode
|
|
.. _ob-ipython: https://github.com/gregsexton/ob-ipython
|
|
.. _scimax: https://github.com/jkitchin/scimax
|
|
.. _ob-ein details: http://millejoh.github.io/emacs-ipython-notebook/#org-mode-integration
|
|
|
|
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`_.
|
|
|
|
.. _connected buffer details: http://millejoh.github.io/emacs-ipython-notebook/#connected-buffer
|
|
|
|
Keymap (C-h m)
|
|
==============
|
|
|
|
::
|
|
|
|
.. KEYS NOTEBOOK (see Makefile)
|
|
|
|
Links
|
|
=====
|
|
* `Complete documentation <http://millejoh.github.io/emacs-ipython-notebook/>`_
|
|
|
|
* `Wiki <https://github.com/millejoh/emacs-ipython-notebook/wiki>`_
|
|
|
|
+ `Screenshots <https://github.com/millejoh/emacs-ipython-notebook/wiki/Screenshots>`_
|
|
+ `Tips <https://github.com/millejoh/emacs-ipython-notebook/wiki/Tips>`_
|
|
|
|
License
|
|
=======
|
|
|
|
Emacs IPython Notebook is licensed under GPL v3.
|
|
See COPYING for details.
|