## Download and run

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

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

Installing SageMath 8.8 from a downloaded binary archive is very easy.
For instance, if your system is Ubuntu 18.04, download the archive
`sage-8.8-Ubuntu_18.04-x86_64.tar.bz2`

from one the
mirrors and type the
following lines in a terminal:

bunzip2 sage-8.8-Ubuntu_18.04-x86_64.tar.bz2 tar xvf sage-8.8-Ubuntu_18.04-x86_64.tar cd SageMath ./sage -n jupyterA Jupyter home page should then open in your browser. Click on "New" and select "SageMath 8.8" 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 CoCalc (ex *SageMathCloud*):

- in a
**Jupyter notebook:**in the*Kernel*menu, choose*Change kernel*and select*SageMath 8.8*(or higher) - in a
**SageMath worksheet:**to have nice LaTeX-typeset outputs, type`typeset_mode(True)`

in the first cell.

Another option is to use Sage Debian Live, which is a USB key with SageMath preinstalled.

## Documentation

### Reference manual

The on-line reference manual is here for the differential part and here for the pure algebraic part. It can also be accessed locally in

local/share/doc/sage/html/en/reference/manifolds/index.htmlunder 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.htmlFinally, 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 notebooks 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 notebooks can also be downloaded directly from the examples page, by clicking on [ipynb] (Jupyter notebook format).