sagemath/sagemath-dev repository overview

⁠Supported tags

• latest — the stable master branch
• x.x — all stable releases of Sage are tagged with their version number.
• x.x.{beta,rc}x - betas and release candidates of Sage as tagged in our git repository⁠; since docker images have been built and uploaded manually for a while, not all betas are here.
• develop — the current development version of Sage which gets merged into the master branch when a new version of Sage is released ; This points to the latest beta or release candidate.
• -py3 - until Sage 9.1, we provided Python 2 builds (with no suffix) and Python 3 builds (with the -py3 suffix). From Sage 9.2.beta0 on, all images we provide are based on Python 3 and the -py3 suffix survives only for historical reasons: with or without it, you get Python 3.

⁠What is SageMath

SageMath is a free open-source mathematics software system licensed under the GPL. It builds on top of many existing open-source packages: NumPy, SciPy, matplotlib, Sympy, Maxima, GAP, FLINT, R and many more. Access their combined power through a common, Python-based language or directly via interfaces or wrappers.

Mission: Creating a viable free open source alternative to Magma, Maple, Mathematica and Matlab.

⁠Hint for Windows users

Currently, SageMath does not provide executables that natively run under Windows (more information on that can be found here⁠). However, a way to use SageMath locally (and offline) under Windows is to use the Docker images available from here via the Windows Subsystem for Linux⁠ (WSL). A guide to the procedure is the SageMath Docker and AppImage Guide⁠.

⁠What's in this image

There are several flavours of this image.

• sagemath/sagemath⁠ contains everything necessary to run Sage on the command line. Run it with:

  docker run -it sagemath/sagemath:latest
  

  Copy
  You can start a graphical Jupyter Notebook⁠ at http://localhost:8888⁠ instead. To use the notebook, follow the instructions printed when you run:

  docker run -p8888:8888 sagemath/sagemath:latest sage-jupyter
  

  Copy
• sagemath/sagemath-dev⁠ contains all the build artifacts to rebuild Sage quickly. This version is probably only relevant for Sage developers. Run this image with:

  docker run -it sagemath/sagemath-dev:develop
  

  Copy
  This triggers a rebuild and drops you in a shell afterwards. Note that the git repository has been emptied to save space. If you want to use git, fetch from your git repository with git fetch origin and go to the commit that was used to create this image with

  git reset $(cat docker/.commit)
  

  Copy

⁠How to build your own SageMath images

This can be done using the Dockerfile⁠ located in the docker sub-folder of the root directory in the Sage repository. Run

docker build -f docker/Dockerfile --build-arg ARTIFACT_BASE=sagemath/sagemath-dev:develop --target TARGET .

in the root folder with TARGET one of sagemath or sagemath-dev.

⁠How these images get updated

Currently, these images are generated by a GitHub workflow⁠ every release. This is based on the above mentioned Dockerfile.

⁠Report bugs and issues

Please tell us of any bugs or omissions at our Issue Tracker⁠ or contact us through the sage-support⁠ or the sage-devel⁠ mailing lists.

⁠License

The whole Sage software distribution is licensed under the General Public License, version 3. More details can be found in our COPYING.txt⁠