FAQ: General#

Why does this project exist?#

The stated mission of Sage is to be viable free open source alternative to Magma, Maple, Mathematica, and Matlab. Sage’s predecessors, known as HECKE and Manin, came about because William Stein needed to write them as part of his research in number theory. Started by William in 2005 during his time at Harvard University, Sage combines best-of-breed free open source mathematics software, packaging and unifying them through a common interface. Since then Sage has become something used not just by researchers in number theory, but throughout the mathematical sciences.

Sage builds upon and extends functionalities of many underlying packages. Even from early on, when Sage was primarily used for number theory, this included Givaro, GMP, NTL, Pari/GP, and many others too numerous to list here. Students, teachers, professors, researchers throughout the world use Sage because they require a comprehensive free open source mathematics package that offers symbolic and numerical computation. Most of the time, people are happy with what Sage has to offer.

As is common throughout the free open source software (FOSS) world, many people often identify cases where Sage lacks certain mathematics functionalities that they require. And so they delve into the underlying source code that comprises Sage in order to extend it for their purposes, or expose functionalities of underlying packages shipped with Sage in order to use their favourite mathematics software packages from within Sage. The Sage-Combinat team is comprised of researchers in algebraic combinatorics. The team’s stated mission is to improve Sage as an extensible toolbox for computer exploration in algebraic combinatorics, and foster code sharing between researchers in this area.

For detailed information about why Sage exists, see William’s personal mathematics software biography.

What does “Sage” mean and how do you pronounce it?#

In the first few years of Sage’s existence, the project was called “SAGE”. This acronym stood for “Software for Algebra and Geometry Experimentation”. Starting around 2007 and early 2008, the name “Sage” was widely adopted. Think of “Sage” as a name for a free open source mathematics software project, just as “Python” is a name for a free open source general purpose programming language. Whenever possible, please use the name “Sage” instead of “SAGE” to avoid confusing the Sage project with a computer project called SAGE. You pronounce “Sage” similar to how you would pronounce “sage” which refers to a wise person, or “sage” which refers to a plant. Some people pronounce “Sage” as “sarge”, similar to how you would pronounce Debian Sarge.

However you pronounce “Sage”, please do not confuse the Sage project with an accounting software by the same name.

Who is behind this project?#

Sage is a volunteer based project. Its success is due to the voluntary effort of a large international team of students, teachers, professors, researchers, software engineers, and people working in diverse areas of mathematics, science, engineering, software development, and all levels of education. The development of Sage has benefited from the financial support of numerous institutions, and the previous and ongoing work of many authors of included components.

A list of (some) direct contributors can be found on the Sage Development Map and the history of changes can be found in the changelogs. Refer to the acknowledgment page of the Sage website for an up-to-date list of financial and infrastructure supporters, mirror network hosting providers, and indirect contributors.

Why is Sage free/open source?#

A standard rule in the mathematics community is that everything is laid open for inspection. The Sage project believes that not doing the same for mathematics software is at best a gesture of impoliteness and rudeness, and at worst a violation against standard scientific practices. An underlying philosophical principle of Sage is to apply the system of open exchange and peer review that characterizes scientific communication to the development of mathematics software. Neither the Sage project nor the Sage Development Team make any claims to being the original proponents of this principle.

The development model of Sage is largely inspired by the free software movement as spearheaded by the Free Software Foundation, and by the open source movement. One source of inspiration from within the mathematics community is Joachim Neubüser as expressed in the paper

J. Neubüser. An invitation to computational group theory. In C. M. Campbell, T. C. Hurley, E. F. Robertson, S. J. Tobin, and J. J. Ward, editors, Groups ‘93 Galway/St. Andrews, Volume 2, volume 212 of London Mathematical Society Lecture Note Series, pages 457–475. Cambridge University Press, 1995.

and in particular the following quotation from his paper:

You can read Sylow's Theorem and its proof in Huppert's book in
the library without even buying the book and then you can use
Sylow's Theorem for the rest of your life free of charge,
but...for many computer algebra systems license fees have to be
paid regularly for the total time of their use. In order to
protect what you pay for, you do not get the source, but only an
executable, i.e. a black box. You can press buttons and you get
answers in the same way as you get the bright pictures from your
television set but you cannot control how they were made in either
case.

With this situation two of the most basic rules of conduct in
mathematics are violated: In mathematics information is passed on
free of charge and everything is laid open for checking. Not
applying these rules to computer algebra systems that are made for
mathematical research...means moving in a most undesirable
direction. Most important: Can we expect somebody to believe a
result of a program that he is not allowed to see? Moreover: Do we
really want to charge colleagues in Moldava several years of their
salary for a computer algebra system?

Similar sentiments were also expressed by Andrei Okounkov as can be found in

V. Muñoz and U. Persson. Interviews with three Fields medalists. Notices of the American Mathematical Society, 54(3):405–410, 2007.

in particular the following quotation:

Computers are no more a threat to mathematicians than food
processors are a threat to cooks. As mathematics gets more and
more complex while the pace of our lives accelerates, we must
delegate as much as we can to machines. And I mean both numeric
and symbolic work. Some people can manage without dishwashers, but
I think proofs come out a lot cleaner when routine work is
automated.

This brings up many issues. I am not an expert, but I think we
need a symbolic standard to make computer manipulations easier to
document and verify. And with all due respect to the free market,
perhaps we should not be dependent on commercial software here. An
open-source project could, perhaps, find better answers to the
obvious problems such as availability, bugs, backward
compatibility, platform independence, standard libraries, etc. One
can learn from the success of TeX and more specialized software
like Macaulay2. I do hope that funding agencies are looking into
this.

Why did you write Sage from scratch, instead of using other existing software and/or libraries?#

Sage was not written from scratch. Most of its underlying mathematics functionalities are made possible through FOSS projects such as

BLAS — Basic Linear Algebra Subprograms.
ECL — Embeddable Common-Lisp system
FLINT — C library for doing number theory.
GAP — a system for computational discrete algebra, with particular emphasis on computational group theory.
GMP — GNU Multiple Precision Arithmetic Library.
Maxima — system for symbolic and numerical computation.
mpmath — a pure-Python library for multiprecision floating-point arithmetic.
NumPy and SciPy — numerical linear algebra and other numerical computing capabilities for Python.
OpenBLAS — an optimized BLAS library.
Pari/GP — a computer algebra system for fast computations in number theory.
Pynac — a modified version of GiNaC that replaces the dependency on CLN by Python.
R — a language and environment for statistical computing and graphics.
And many more too numerous to list here.

An up-to-date list can be found in the section External Packages in the Sage Reference Manual.

The principal programming languages of Sage are Python and Cython. Python is the primary programming and interfacing language, while Cython is the primary language for optimizing critical functionalities and interfacing with C libraries and C extensions for Python. Sage integrates over 90 FOSS packages into a common interface. On top of these packages is the Sage library, which consists of over 700,000 lines of new Python and Cython code. See openhub.net for source code analysis of the latest stable Sage release.

How do I get help?#

For support about usage of Sage, there are two options:

The question-and-answer website ask.sagemath.org
The email list sage-support

For support about development of Sage, there is an email list sage-devel

See http://www.sagemath.org/help.html for a listing of other resources.

Wouldn’t it be way better if Sage did not ship as a gigantic bundle?#

The SageMath distribution continues to vendor versions of required software packages (“SPKGs”) that work well together.

However, in order to reduce compilation times and the size of the Sage installation, a development effort ongoing since the 8.x release series has made it possible to use many system packages provided by the OS distribution (or by the Homebrew or conda-forge distributions) instead of building SageMath’s own copies.

This so-called “spkg-configure” mechanism runs at the beginning of a build from source, during the ./configure phase.

To ensure that SageMath builds and runs correctly on a wide variety of systems, we use automated testing. See the chapter Portability testing in the Developer’s Guide for details.

With so many bugs in Sage and hundreds of open tickets, why don’t you produce a stabilization release?#

Any software package contains bug. With something as complex as Sage, neither the Sage community nor the Sage Development Team make any claims that Sage is free of bugs, and perhaps never will. To do so would be an act of dishonesty.

A Sage release cycle lasts for a few months, with several betas appearing at 1-2 week intervals, followed by several release candidates (as of 2022). Under this schedule and with the limited capacity of the Sage developer community, the project cannot make stabilization releases. However, important bug fix tickets are merged with high priority and will be available in the development release. Thanks to rigorous integration testing by our dedicated Release Manager, development releases (betas and release candidates) are generally safe and reliable to use.

If you want to help out with release management, as a starting point please subscribe to the sage-release mailing list.

How can I download the Sage documentation to read it offline?#

To download the Sage standard documentation in HTML or PDF formats, visit the Help and Support page on the Sage website. Each release of Sage comes with the full documentation that makes up the Sage standard documentation. If you have downloaded a binary Sage release, the HTML version of the corresponding documentation comes pre-built and can be found under the directory SAGE_ROOT/local/share/doc/sage/html/. During the compilation of Sage from source, the HTML version of the documentation is also built in the process. To build the HTML version of the documentation, issue the following command from SAGE_ROOT:

$ ./sage --docbuild --no-pdf-links all html

Building the PDF version requires that your system has a working LaTeX installation. To build the PDF version of the documentation, issue the following command from SAGE_ROOT:

$ ./sage --docbuild all pdf

For more command line options, refer to the output of any of the following commands:

$ ./sage --help
$ ./sage --advanced

I want to cite Sage in a publication, how do I do it?#

Here is a BibTeX entry for Sage:

@manual{sagemath,
    label        = {Sag95},
    author       = {{The Sage Developers}},
    title        = {{S}age{M}ath, the {S}age {M}athematics {S}oftware {S}ystem},
    url          = {https://www.sagemath.org},
    version      = {9.5},
    year         = {2022},
    note         = {DOI 10.5281/zenodo.6259615},
}

Adjust version/year as needed. You might also like to use DOI for Sage, as the note entry in the above record, or directly as DOI record.

If you happen to use the Sage interface to PARI, GAP or Singular, you should definitely reference them as well. Likewise, if you use code that is implemented using PARI, GAP, or Singular, reference the corresponding system (you can often tell from the documentation if PARI, GAP, or Singular is used in the implementation of a function).

See citing PARI.

@preamble("\usepackage{url}")
@manual{PARI2,
  organization = "{The PARI~Group}",
  title        = "{PARI/GP version \texttt{2.11.2}}",
  year         = 2019,
  address      = "Univ. Bordeaux",
  note         = "available from \url{http://pari.math.u-bordeaux.fr/}"
}

See citing GAP.

@preamble("\usepackage{url}")
@manual{GAP4,
    key          = "GAP",
    organization = "The GAP~Group",
    title        = "{GAP -- Groups, Algorithms, and Programming,
                    Version 4.11.1}",
    year         = 2021,
    note         = "\url{https://www.gap-system.org}",
}

See citing Singular.

@misc {DGPS,
   title = {{\sc Singular} {4-3-0} --- {A} computer algebra system for polynomial computations},
   author = {Decker, Wolfram and Greuel, Gert-Martin and Pfister, Gerhard and Sch\"onemann, Hans},
   year = {2022},
   howpublished = {\url{http://www.singular.uni-kl.de}},
}

What are DOI records for Sage?#

DOI records for Sage are maintained via Zenodo, e.g. see record for Sage 9.5. The corresponding doi:10.5281/zenodo.6259615.

There is also DOI for the latest version, doi:10.5281/zenodo.593563.