Download and run

Since all SageManifolds code is included in SageMath 7.5, it suffices to install the latter from the SageMath download page.

NB: SageMath versions lower than 7.5 contained only limited pieces of SageManifolds and therefore required some extra installation from SageManifolds website; this is no longer the case, so we urge you to upgrade to SageMath 7.5!

Installing SageMath 7.5 from a downloaded binary archive is very easy. For instance, if your system is Ubuntu 16.04, download the archive sage-7.5.1-Ubuntu_16.04-x86_64.tar.bz2 from one the mirrors and type the following lines in a terminal:

bunzip2 sage-7.5.1-Ubuntu_16.04-x86_64.tar.bz2
tar xvf sage-7.5.1-Ubuntu_16.04-x86_64.tar
cd SageMath
./sage -n jupyter
A Jupyter home page should then open in your browser. Click on "New" and select "SageMath 7.5.1" to open a Jupyter notebook with a SageMath kernel. In the first cell, if you type
Manifold(2, 'M')
the output should be
2-dimensional differentiable manifold M

You are then ready to use SageManifolds and can jump to the tutorial or to the 2-sphere example. See also the documentation section below.

Use without installation

Instead of installing SageMath on your computer, you can run it remotely via the SageMathCloud:

  • in a Jupyter notebook: in the Kernel menu, choose Change kernel and select SageMath 7.5; besides, use 'jmol' as the 3D viewer instead of 'threejs'.
  • in a SageMath worksheet: works out of the box (since SMC has been updated to SageMath 7.5); NB: to have nice LaTeX-typeset outputs, type in the first cell: typeset_mode(True).

Another option is to use Sage Debian Live, which is a USB key with SageMath preinstalled. Make sure that the Sage Debian Live version is >= 7.5 (should be available soon).

Documentation

Reference manual

The on-line reference manual of SageManifolds 1.0 is on this page for the differential part and this page for the pure algebraic part. It can also be accessed locally in

    local/share/doc/sage/html/en/reference/manifolds/index.html
under your SageMath root directory, while the reference manual of the pure algebraic part of SageManifolds is located in
    local/share/doc/sage/html/en/reference/tensor_free_modules/index.html
Finally, SageMath whole reference manual, with SageManifolds parts inserted, is located in
    local/share/doc/sage/html/en/reference/index.html

PDF manuals

The PDF reference manuals are generated by
    ./sage -docbuild reference/manifolds pdf
    ./sage -docbuild reference/tensor_free_modules pdf

The SageManifolds reference manual is then local/share/doc/sage/pdf/en/reference/manifolds/manifolds.pdf under your SageMath root directory, while the reference manual of the pure algebraic part of SageManifolds is local/share/doc/sage/pdf/en/reference/tensor_free_modules/tensor_free_modules.pdf

SageManifolds reference manual is also available on-line (html, pdf).

Tutorial and extra documentation

A tutorial and more documentation is available here.
See also the examples.

Python source files

The Python source files of SageManifolds are located in two subdirectories of your SageMath root directory:

  • src/sage/tensor/modules/ for the pure algebraic part (tensors on free modules)
  • src/sage/manifolds/ for the topological and differential parts

See the Contribute section if you would like to modify or add some code.

Downloading example worksheets and extra stuff

In a directory different from the root of your SageMath install, type

    git clone https://github.com/sagemanifolds/SageManifolds.git

and take a look at SageManifolds/README.md

The example worksheets can also be downloaded directly from the examples page, by clicking on [ipynb] (Jupyter notebook format).