Difference between revisions of "SageMath"

From ArchWiki
Jump to navigation Jump to search
(Add note about the flask notebook deprecation)
(→‎Documentation: Delete build instructions, docs are provided in the sagemath-doc package)
Line 63: Line 63:
Cantor can be installed with the {{Pkg|cantor}} package or as part of the {{Grp|kde-applications}} or {{Grp|kdeedu}} groups, available in the [[official repositories]].
Cantor can be installed with the {{Pkg|cantor}} package or as part of the {{Grp|kde-applications}} or {{Grp|kdeedu}} groups, available in the [[official repositories]].
=== Documentation ===
For local documentation, one can compile it into multiple formats such as HTML or PDF. To build the whole SageMath reference, execute the following command (as root):
# sage --docbuild reference html
This builds the HTML documentation for the whole ''reference'' tree (may take longer than an hour). An option is to build a smaller part of the documentation tree, but you would need to know what it is you want.  Until then, you might consider just browsing  the [http://doc.sagemath.org/ online reference].
For a list of documents see {{ic|sage --docbuild --documents}} and for a list of supported formats see {{ic|sage --docbuild --formats}}.
== Optional additions ==
== Optional additions ==

Revision as of 19:46, 10 August 2016

SageMath (formerly Sage) is a program for numerical and symbolic mathematical computation that uses Python as its main language. It is meant to provide an alternative for commercial programs such as Maple, Matlab, and Mathematica.

SageMath provides support for the following:


  • sagemath contains the command-line version;
  • sagemath-doc for HTML documentation and inline help from the command line.
  • sage-notebook includes the browser-based notebook interface.
Note: Most if not all of the standard sage packages are available as optional dependencies of the sagemath package, therefore they have to be installed additionally as normal Arch packages in order to take advantage of their features. Note that there is no need to install them with sage -i, in fact mixing system and user packages is discouraged.


SageMath mainly uses Python as a scripting language with a few modifications to make it better suited for mathematical computations.

SageMath command-line

SageMath can be started from the command-line:

$ sage

For information on the SageMath command-line see this page.

The command-line is based on the IPython shell so you can use all its tricks with SageMath. For an extensive tutorial on IPython see the community maintained IPython Cookbook.

Note, however, that it is not very comfortable for some uses such as plotting. When you try to plot something, for example:

sage: plot(sin,(x,0,10))

SageMath opens a browser window with the Sage Notebook.

Sage Notebook

Note: The SageMath Flask notebook is currently in maintenance mode and will be deprecated in favour of the Jupyter notebook. The Jupyter notebook is recommended for all new worksheets. You can use the sage-notebook-exporter application to convert your Flask notebooks to Jupyter

A better suited interface for advanced usage in SageMath is the Notebook. To start the Notebook server from the command-line, execute:

$ sage -n

The notebook will be accessible in the browser from http://localhost:8080 and will require you to login.

However, if you only run the server for personal use, and not across the internet, the login will be an annoyance. You can instead start the Notebook without requiring login, and have it automatically pop up in a browser, with the following command:

$ sage -c "notebook(automatic_login=True)"

For a more comprehensive tutorial on the Sage Notebook see the Sage documentation. For more information on the notebook() command see this page.

Jupyter Notebook

SageMath also provides a kernel for the Jupyter notebook. To use it, install ipython2-notebook and mathjax, launch the notebook with the command

$ jupyter notebook

and choose "SageMath" in the drop-down "New..." menu. The SageMath Jupyter notebook supports LaTeX output via the %display latex command and 3D plots if jmol is installed.


Cantor is an application included in the KDE Edu Project. It acts as a front-end for various mathematical applications such as Maxima, SageMath, Octave, Scilab, etc. See the Cantor page on the Sage wiki for more information on how to use it with SageMath.

Cantor can be installed with the cantor package or as part of the kde-applications or kdeedu groups, available in the official repositories.

Optional additions


If you have installed TeX Live on your system, you may be interested in using SageTeX, a package that makes the inclusion of SageMath code in LaTeX files possible. TeX Live is made aware of SageTeX automatically so you can start using it straight away.

As a simple example, here is how you include a Sage 2D plot in your TEX document (assuming you use pdflatex):

  • include the sagetex package in the preamble of your document with the usual
  • create a sagesilent environment in which you insert your code:
dob(x) = sqrt(x^2 - 1) / (x * arctan(sqrt(x^2 - 1)))
dpr(x) = sqrt(x^2 - 1) / (x * log( x + sqrt(x^2 - 1)))
p1 = plot(dob,(x, 1, 10), color='blue')
p2 = plot(dpr,(x, 1, 10), color='red')
ptot = p1 + p2
  • create the plot, e.g. inside a float environment:
  • compile your document with the following procedure:
$ pdflatex <doc.tex>
$ sage <doc.sage>
$ pdflatex <doc.tex>
  • you can have a look at your output document.

The full documentation of SageTeX is available on CTAN.


TeX Live does not recognize SageTex

If your TeX Live installation does not find the SageTex package, you can try the following procedure (as root or use a local folder):

  • Copy the files to the texmf directory:
# cp /opt/sage/local/share/texmf/tex/* /usr/share/texmf/tex/
  • Refresh TeX Live:
# texhash /usr/share/texmf/
texhash: Updating /usr/share/texmf/.//ls-R... 
texhash: Done.

See also