Hello,
This README.txt describes build instructions for Sage. If you downloaded
a binary, you do not need to do anything; just execute
./sage
from the command line. If you downloaded the sources, please read
below on how to build Sage and work around common issues.
---------------------------------------------------------------------------
Sage: Open Source Mathematical Software
"Creating a Viable Open Source Alternative to
Magma, Maple, Mathematica, and Matlab"
Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010
William Stein and the Sage Development Team
Distributed under the terms of the GNU General Public License (GPL)
http://www.sagemath.org
If you have questions, do not hesitate to email the sage-support list
http://groups.google.com/group/sage-support
AUTHORS: Over 200 people have contributed code to Sage. Please see
one of the websites above for a list. In many cases, documentation
for modules and functions list the authors.
---------------------------------------------------------------------------
QUICK INSTRUCTIONS TO BUILD FROM SOURCE
---------------------------------------
The following steps briefly outline the process of building Sage from
source. See below for more detailed instructions.
1. Make sure you have the dependencies and 2.5 GB of free disk space.
Linux (install these using your package manager):
GCC, g++, make, m4, perl, ranlib, and tar.
OS X: XCode. WARNING: If "gcc -v" outputs 4.0.0, you *must*
upgrade XCode (free from Apple), since that version of GCC is
very broken.
Microsoft Windows: Not supported yet.
NOTE: On some operating systems, it might be necessary to install
gas/as, gld/ld, gnm/nm. On most platforms, these are automatically
installed when you install the programs listed above. Only OS X
>= 10.4.x and certain Linux distributions are 100% supported. See
below for a complete list.
2. Extract the tarball:
tar -xvf sage-*.tar
3. cd into the Sage directory and type make:
cd sage-*
make
That's it! Everything is automatic and non-interactive.
SELINUX
--------
On Linux, if you get this error message:
" restore segment prot after reloc: Permission denied "
the problem is probably related to SELinux. See the following URL for
further information:
http://www.ittvis.com/services/techtip.asp?ttid=3092
OFFICIALLY SUPPORTED PLATFORMS
------------------------------
Building of Sage from source is regularly tested on (minimal installs
of) the following platforms:
PROCESSOR OPERATING SYSTEM
x86 32-bit Linux -- Debian, Ubuntu, CentOS (=Red Hat),
Fedora, openSUSE, Mandriva, Arch
x86_64 64-bit Linux -- Debian, Ubuntu, CentOS (=Red Hat),
Fedora, openSUSE, Mandriva, Arch
IA-64 Itanium 2 64-bit Linux -- Red Hat, SUSE
x86 Apple Mac OS X 10.4.x, 10.5.x, 10.6.x
PPC Apple Mac OS X 10.4.x, 10.5.x, 10.6.x
SPARC Solaris 10 03/05 or later
(Sage currently builds as a 32-bit application on SPARC)
Use Sage on Microsoft Windows via VMware. Active work to port Sage to
Cygwin (Windows) is in progress.
NOT OFFICIALLY SUPPORTED, BUT NEARLY WORKS
------------------------------------------
PROCESSOR OPERATING SYSTEM
x86_64 Solaris 10 (64-bit)
x86_64 OpenSolaris (64-bit)
SPARC Solaris 10 (64-bit)
NOT SUPPORTED
-------------
* AIX
* FreeBSD
* Gentoo Linux -- though Sage will probably work fine
* HP-UX
* Microsoft Windows (via Cygwin) -- active port in progress
* Microsoft Windows (via Visual Studio C++)
* OpenSolaris
There is some effort to port Sage to FreeBSD and HP-UX. We like all of
the above operating systems, but just haven't had the time to make
Sage work well on them. Help wanted! Please send an email to
http://groups.google.com/group/sage-devel
if you are interested in helping port Sage to any of the above
platforms.
FORTRAN
-------
To build Sage on any platform except OS X, you must use a system-wide
gfortran compiler. Sometimes you need to explicitly tell the Sage
build process about the Fortran compiler and library location. Do this
by typing
export SAGE_FORTRAN=/exact/path/to/gfortran
export SAGE_FORTRAN_LIB=/path/to/fortran/libs/libgfortran.so
Note that the SAGE_FORTRAN environment variable is supposed to impact
*only* the Fortran Sage package, otherwise known as the Fortran
spkg. Apart from that, this variable is *not* designed to do anything
at all to other spkg's that use Fortran. For example, the Lapack spkg
uses Fortran, but the compilation process of Lapack should ignore the
SAGE_FORTRAN environment variable. The SAGE_FORTRAN environment
variable does not mean "build any spkg that uses Fortran using this
Fortran". It means "when installing the Fortran spkg, setup the
sage_fortran script to run the Fortran specified by the SAGE_FORTRAN
variable".
IMPLEMENTATION
--------------
Sage has significant components written in the following languages:
C/C++, Python, Cython, Lisp, and Fortran. Lisp (ECL) and Python are
built as part of Sage and a GNU Fortran (gfortran) binary is included
(OS X only), so you do not need them in order to build Sage.
MORE DETAILED INSTRUCTIONS TO BUILD FROM SOURCE
-----------------------------------------------
1. Make sure you have about 2.5 GB of free disk space.
2. Linux: Install GCC, g++, m4, ranlib, and make. The build should
work fine on openSUSE, Fedora, Ubuntu, etc. If it doesn't, we want
to know!
OS X: Make sure you have XCode version >= 2.4, i.e. "gcc -v" should
output build >= 5363. If you don't, go to
http://developer.apple.com/
sign up, and download the free XCode package. Only
OS X >= 10.4 is supported.
Windows: Download and install VirtualBox, install Linux into it, etc.
3. Extract the Sage source tarball and cd into a directory with no
spaces in it. If you have a machine with 4 processors, say, type
the following to configure the build script to perform a parallel
compilation of Sage using 4 jobs:
export MAKE="make -j4"
To start the build, type
make
If you want to run the test suite for each individual spkg as it is
installed, type
export SAGE_CHECK="yes"
before starting the Sage build. This will run each test suite and
will raise an error if any failures occur.
4. Wait about 1 hour to 14 days, depending on your computer (it took
about 2 weeks to build Sage on the Google G1 Android cell phone).
5. Type ./sage to try it out.
6. OPTIONAL: Start Sage and run the command
install_scripts("/usr/local/bin/") # change /usr/local/bin/
Type "install_scripts?" in Sage for more details about what this
command does.
7. OPTIONAL: Type "make test" to test all examples in the
documentation (over 93,000 lines of input!) -- this takes from 30
minutes to several hours. Don't get too disturbed if there are 2 to
3 failures, but always feel free to email the section of test.log
that contains errors to this mailing list:
http://groups.google.com/group/sage-support
If there are numerous failures, there was a serious problem with
your build.
8. OPTIONAL: Documentation -- If you want to (try to) build the
documentation, run "sage -docbuild help" for instructions. The HTML
version of the documentation is built during the compilation
process of Sage and resides in the directory
SAGE_ROOT/devel/sage/doc/output/html
LaTeX is required to build the PDF version of the documentation.
9. OPTIONAL: GAP -- It is highly recommended that you install the
optional GAP database by typing
./sage -optional
then installing (with ./sage -i) the package whose name begins with
database_gap. This will download the package from
sage.math.washington.edu and install it. While you're at it, you
might install other databases of interest to you.
10. OPTIONAL: It is recommended that you have both LaTeX and the
ImageMagick tools (e.g. the "convert" command) installed since
some plotting functionality benefits from it.
SUPPORTED COMPILERS
-------------------
* Sage needs a version of GCC that is at least version 4.0.1
that is configured with support for at least the C, C++
and Fortran languages, although as noted above, a Fortran
compiler is not needed on OS X.
* The versions of the C compiler (gcc), C++ compiler (g++)
and Fortran compiler (gfortran), must all be identical.
* Sage has never been built without using the GCC compiler.
RELOCATION
----------
You *should* be able to move the sage-x.y.z directory anywhere you
want. If you copy the sage script or make a symbolic link to it, you
should modify the script to reflect this (as instructed at the top of
the script). It is best if the path to Sage does not have any spaces in
it.
For a system-wide installation, as root you can move the sage-x.y.z
directory to a system-wide directory. Afterwards, you need to start
up Sage as root at least once prior to using the system-wide Sage
as a normal user. See the Installation Guide for further
information on performing a system-wide installation.
If you find anything that doesn't work correctly after you moved the
directory, please email http://groups.google.com/group/sage-support
REDISTRIBUTION
--------------
Your local Sage install is almost exactly the same as any "developer"
install. You can make changes to documentation, source, etc., and very
easily package up the complete results for redistribution just like we do.
1. You can make your own source tarball (sage-x.y.z.tar) of Sage by
typing "sage -sdist x.y.z", where the version is whatever you want.
The result is placed in SAGE_ROOT/dist.
2. You can make a binary distribution with the packages you have
installed by typing "sage -bdist x.y.z". The result is placed in
the SAGE_ROOT/dist directory.
3. Fat Binaries: To make a binary that will run on the widest range of
target machines, set the SAGE_FAT_BINARY environment variable to
"yes" before building Sage:
export SAGE_FAT_BINARY="yes"
make
./sage -bdist x.y.z-fat
CHANGES TO INCLUDED SOFTWARE
----------------------------
All software included with Sage is copyright by the respective authors
and released under an open source license that is "GPL version 3 or
later"q compatible. See the file COPYING.txt for more details.
Each spkg in SAGE_ROOT/spkg/standard/ is a bzip'd tarball. You can
extract it with
tar -jxvf name-*.spkg
Inside the spkg, there is a file SPKG.txt that details all changes
made to the given package for inclusion with Sage. The inclusion of
such a file detailing changes is specifically required by some of the
packages included with Sage (e.g. for GAP).