## Download and run

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

Installing SageMath 9.4 from a downloaded binary archive is very easy.
For instance, if your system is macOS, visit this page; if it is
Ubuntu 20.04, download the archive
`sage-9.4-Ubuntu_20.04-x86_64.tar.bz2`

from one the
mirrors, save it in your home directory and type the
following lines in a terminal:

sudo apt-get install python-is-python3 tar jxvf sage-9.4-Ubuntu_20.04-x86_64.tar.bz2 cd SageMath ./sage -n jupyterA Jupyter home page should then open in your browser. Click on "New" and select "SageMath 9.4" 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 tools and can jump to the tutorial or to the 2-sphere example. See also the documentation section below.

## Use a Docker image

If you are familiar with Docker, an alternative to a traditional install is to pull the SageMath Docker image.## 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 9.4*(or higher) - in a
**SageMath worksheet:**to have nice LaTeX-typeset outputs, type`typeset_mode(True)`

in the first cell.

For short pieces of code, you may use SageMathCell. Here is some example.

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, under your SageMath root directory, in the file

local/share/doc/sage/html/en/reference/manifolds/index.htmlwhile 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's whole reference manual 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 the SageManifolds project 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).