|
Size: 2390
Comment:
|
Size: 2450
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = Sage in Emacs = | {{https://www.gnu.org/software/emacs/images/emacs.png||width=128px}} |
| Line 3: | Line 3: |
| There is support for using SAGE interactively from within emacs, and editing Python code in emacs: |
= Sage and Emacs = |
| Line 6: | Line 5: |
| * Download sage.el and byte compile it, or download sage.elc. | The purpose of this page is to collect tips and tricks for Sage users and developers using the text editor Emacs. |
| Line 8: | Line 8: |
| * Download python-mode.el and byte compile it, or download python-mode.elc. This is highly recommended since it is a vast improvement over editing Python code without a special mode. | == sage-shell-mode == |
| Line 10: | Line 10: |
| (NOTE: Recent versions of Emacs have their own major mode for Python called [[href="http://cvs.savannah.gnu.org/viewvc/emacs/lisp/progmodes/python.el?root=emacs&view=log python.el]]. So those with GNU Emacs 22 or 23 shouldn't need python-mode.el. The modifications to your .emacs file suggested below will be the same, except you can remove or comment out {{{(load "python-mode")}}}.) |
[[https://github.com/stakemori/sage-shell-mode|sage-shell-mode]] is the recommended mode for Sage in Emacs. This mode provides two features: |
| Line 13: | Line 12: |
| * Download pyrex-mode.el and byte compile it, or download pyrex-mode.elc. | 1. Run a Sage shell inside Emacs, fully equipped with command history, completion, dynamic help and opening of source files, etc. |
| Line 15: | Line 15: |
| * Put the .elc files all in a directory, e.g., {{{/home/was/.emacs-scripts}}}. | 2. A major mode for `.sage` files along with functionality for sending chunks of code to a running Sage shell. |
| Line 17: | Line 17: |
| * Add the following to your {{{.emacs}}} file, where you replace {{{/home/was/.emacs-scripts}}} with the directory where you put those elc files. | `sage-shell-mode` allows extensions for `auto-complete`, `helm`, `anything`, and embedding in `org-mode`. It was written from scratch by Sho Takemori. |
| Line 19: | Line 19: |
| {{{ (add-to-list 'load-path (expand-file-name "/home/was/.emacs-scripts/")) |
`sage-shell-mode` is most easily installed using the Emacs package manager MELPA. Alternatively, go to [[https://github.com/stakemori/sage-shell-mode|the GitHub page]]. |
| Line 22: | Line 21: |
| (load "pyrex-mode") (load "python-mode") (setq ipython-command "~/bin/sage") ;; depends on where your sage is. (load "sage") (require 'ipython) |
See: SageModeComparison, [[https://github.com/stakemori/sage-shell-mode]] |
| Line 28: | Line 23: |
| (fset 'py-shell-fullscreen [?\M-x ?p ?y ?- ?s ?h ?e ?l ?l return ?\C-x ?1]) (define-key esc-map "i" 'py-shell-fullscreen) |
== EIN: IPython notebook client in Emacs == |
| Line 32: | Line 25: |
| (setq auto-mode-alist (cons '("\\.pyx\\'" . pyrex-mode) auto-mode-alist)) (setq auto-mode-alist (cons '("\\.pxd\\'" . pyrex-mode) auto-mode-alist)) (setq auto-mode-alist (cons '("\\.pxi\\'" . python-mode) auto-mode-alist)) (setq auto-mode-alist (cons '("\\.sage\\'" . python-mode) auto-mode-alist)) }}} |
https://github.com/tkf/emacs-ipython-notebook |
| Line 38: | Line 27: |
| * Start emacs. Now Python code and pyrex files are colored correctly, and there are a bunch of extra commands. | This is currently non functional due to an incompatibility with the ipython shipped with Sage. Yet this sounds promising. See: |
| Line 40: | Line 30: |
| * Start emacs. Type Alt-i. A SAGE window should appear. Colors and tab completion should work. If you are in debugging mode (%pdb), then when an error occurs, an emacs window opens taking you to that point in the source code! (Note: Tab completion does not work when you run emacs with "emacs -nw".) | - https://github.com/tkf/emacs-ipython-notebook/issues/131 - http://trac.sagemath.org/ticket/16053 |
| Line 42: | Line 33: |
| == Sage-mode == | |
| Line 43: | Line 35: |
| Note: `sage-mode` works only for Sage 7.3 and earlier. | |
| Line 44: | Line 37: |
| == Hints == | This emacs mode allows for running a Sage interpreter inside emacs, and interacting with it sending in chunks of code or doctests, directly opening the appropriate source files from the help, the debugger or the tracebacks. It also provides goodies for running tests, typesetting output, etc. |
| Line 46: | Line 43: |
| If when running SAGE, the screen gets cluttered up, e.g., by the output of help, just type Ctrl-[_], i.e., Ctrl-Shift-[- key] to undo, which will remove the last chunk of output completely. |
See: SageModeComparison, [[sage-mode]], [[http://bitbucket.org/gvol/sage-mode]] == Miscellaneous == - which-function-mode: this minor mode displays in the status bar the name of the class or function being edited. This is a life saver for code with nested classes, and in particular category code. Setup: M-x customize-variable which-function-mode - I (NT) have this in my python-mode-hook: {{{ (set-variable 'indent-tabs-mode nil) (set-variable 'py-indent-offset 4) }}} This might not be so relevant with recent versions of emacs. == See also == - 2010 [[http://www.saltycrane.com/blog/2010/05/my-emacs-python-environment/|blog post]] on customizing emacs for Python |
Sage and Emacs
The purpose of this page is to collect tips and tricks for Sage users and developers using the text editor Emacs.
sage-shell-mode
sage-shell-mode is the recommended mode for Sage in Emacs. This mode provides two features:
1. Run a Sage shell inside Emacs, fully equipped with command history, completion, dynamic help and opening of source files, etc.
2. A major mode for .sage files along with functionality for sending chunks of code to a running Sage shell.
sage-shell-mode allows extensions for auto-complete, helm, anything, and embedding in org-mode. It was written from scratch by Sho Takemori.
sage-shell-mode is most easily installed using the Emacs package manager MELPA. Alternatively, go to the GitHub page.
See: SageModeComparison, https://github.com/stakemori/sage-shell-mode
EIN: IPython notebook client in Emacs
https://github.com/tkf/emacs-ipython-notebook
This is currently non functional due to an incompatibility with the ipython shipped with Sage. Yet this sounds promising. See:
- https://github.com/tkf/emacs-ipython-notebook/issues/131 - http://trac.sagemath.org/ticket/16053
Sage-mode
Note: sage-mode works only for Sage 7.3 and earlier.
This emacs mode allows for running a Sage interpreter inside emacs, and interacting with it sending in chunks of code or doctests, directly opening the appropriate source files from the help, the debugger or the tracebacks. It also provides goodies for running tests, typesetting output, etc.
See: SageModeComparison, sage-mode, http://bitbucket.org/gvol/sage-mode
Miscellaneous
- which-function-mode: this minor mode displays in the status bar the
- name of the class or function being edited. This is a life saver for code with nested classes, and in particular category code. Setup: M-x customize-variable which-function-mode
- I (NT) have this in my python-mode-hook:
(set-variable 'indent-tabs-mode nil) (set-variable 'py-indent-offset 4)
This might not be so relevant with recent versions of emacs.
See also
- 2010 blog post on customizing emacs for Python