Differences between revisions 161 and 162
Revision 161 as of 2015-02-24 22:04:15
Size: 8139
Editor: ?TobiasHansen
Comment: sagenb using deprecated stuff is resolved according to this entry, remove link to sagemath git for onld sage package
Revision 162 as of 2015-02-24 23:22:48
Size: 10447
Editor: ?TobiasHansen
Comment: Add instructions for sagemath repo
Deletions are marked like this. Additions are marked like this.
Line 4: Line 4:

== Building Sage with Debian packages ==

We have a git repository ([[http://anonscm.debian.org/gitweb/?p=debian-science/packages/sagemath.git;a=summary|sagemath]], also see [[http://anonscm.debian.org/cgit/debian-science/packages/sagemath.git/tree/debian/README.Debian|README]]) to document the steps we currently do to experiment with building Sage against Debian packages. Important elements are the build dependencies of Sage, patches for Sage and a script called "pruner" that uses automake to determine if the necessary packages are installed.

It is recommended to do these steps one by one:

||{{{sudo mk-build-deps --install debian/control}}}|| Install build dependencies that are in unstable (requires Debian unstable). ||
||{{{quilt push -a}}} || Apply patches to Sage. ||
||{{{debian/rules prune}}} || Run the pruner script. ||
||{{{debian/rules build}}} || Build sage (includes pruning but not patching). ||

The output of the pruner tells you in the end which dependencies were not found on the machine. These will be downloaded and built in the build step, before Sage itself is built. In the moment the pruner should output something like the following, and it is for now recommended to use these four packages from Sage.
{{{
libgap will not come from debian!
cddlib will not come from debian!
singular will not come from debian!
jmol will not come from debian!
95 system packages will be used
}}}

The following commands clean everything up properly. (The sage folder has an extensive .gitignore so git won't show many untracked files.)
{{{
debian/rules clean
quilt pop -a
cd sage && git clean -dfx
}}}

Finally, there are still depencies that cannot yet be satisfied with packages from unstable. This changes frequently. For now the following packages should be installed from git:
 * [[http://anonscm.debian.org/gitweb/?p=debian-science/packages/rubiks.git;a=summary|rubiks]]
 * [[http://anonscm.debian.org/gitweb/?p=debian-science/packages/sagenb.git;a=summary|sagenb]]

Further packages that currently need manual work are maxima (see [[https://lists.debian.org/debian-science/2015/02/msg00024.html|this mail]]) and depending on the Sage version packages where the version in Debian unstable is too small have to be updated (cython, gap for Sage 6.6).

Some people within DebianScience would like to package again Sage for Debian. An old version of Sage got packaged long time ago by Tim Abbott, but, because of lack of maintainance, it became totally unusable and was removed from Debian. The status pages (master branch, develop branch) give an overview about package versions in Sage and Debian. If you want to help out, pick one of the open tasks or issues below and get going. Or contact us via the mailing list or in #debian-science on irc.oftc.net.

Steps to get an up-to-date Sage standard suite in Debian

Building Sage with Debian packages

We have a git repository (sagemath, also see README) to document the steps we currently do to experiment with building Sage against Debian packages. Important elements are the build dependencies of Sage, patches for Sage and a script called "pruner" that uses automake to determine if the necessary packages are installed.

It is recommended to do these steps one by one:

sudo mk-build-deps --install debian/control

Install build dependencies that are in unstable (requires Debian unstable).

quilt push -a

Apply patches to Sage.

debian/rules prune

Run the pruner script.

debian/rules build

Build sage (includes pruning but not patching).

The output of the pruner tells you in the end which dependencies were not found on the machine. These will be downloaded and built in the build step, before Sage itself is built. In the moment the pruner should output something like the following, and it is for now recommended to use these four packages from Sage.

libgap will not come from debian!
cddlib will not come from debian!
singular will not come from debian!
jmol will not come from debian!
95 system packages will be used 

The following commands clean everything up properly. (The sage folder has an extensive .gitignore so git won't show many untracked files.)

debian/rules clean
quilt pop -a
cd sage && git clean -dfx

Finally, there are still depencies that cannot yet be satisfied with packages from unstable. This changes frequently. For now the following packages should be installed from git:

Further packages that currently need manual work are maxima (see this mail) and depending on the Sage version packages where the version in Debian unstable is too small have to be updated (cython, gap for Sage 6.6).

New build system for Sage (the distribution)

this is slightly out of date, also, Sage (the community) is not interested in using packages that another distribution provides.

The Sage library is getting an autotools build system in the course of a Google Summer of Code project. With the new build system, it can be built against system libraries. There are tarballs with the code at http://tool.em.cs.uni-frankfurt.de/~felix/sage/. (There is also a git repository but the tarballs are recommended). Note that this is work in progress and problems are expected, but we are happy about testers. The transition of this work into Sage is coordinated via a bunch of Sage tickets. We have a Debian package sagelib that currently builds metapackages that help installing the build dependencies of Sage. To test building Sage against Debian packages, one should consult the control file. The dependencies of the metapackage sagelib-builddeps-git still need special treatment and can't be just installed from Debian.

The following Debian packages should be installed from the git repositories:

  • sagenb

  • singular (branch master-3-1-5, build with DEB_BUILD_OPTIONS=nodoc)

For the remaining packages where the Debian package is missing or is missing features required by Sage, it is currently most convenient to use the versions from Sage. This is done by configuring with

../configure \
--disable-all \
--enable-{boehm_gc,cython,ecl,flintqs,genus2reduction,maxima,pari,pexpect,pynac,rubiks,sagelib,sagetex,tachyon} \
--with-gmp

New build system for Sage (the library)

There is some work in progress trying to make sagelib work on top of any software distribution. we use autotools to sort out dependencies, run time paths and provide standard build/installation routines. unlike the first approach, this is heading towards a fork and will likely not play well with the current upstream development process. Experimental tarballs are available at http://tool.em.cs.uni-frankfurt.de/~felix/sagelib/, there is no public git repo yet.

Open tasks

Package

Bug / Link

Assigned

Comments

Packages that need a new maintainer and an upload to Debian:

jmol

There is a request for help, see 719330

pexpect 2.0

(Debian pkg: python-pexpect): Debian ships version 2.4, but Sage requires version 2.0 (though one of the necessary patches is already in 2.4). Plotting in the notebook is likely to break with newer versions that are in Debian; and >2.0 is reported to be slow. There is a new upstream version so Sage might update, see this sage bug.

singular

PTS

singular 3.1.6 is packaged in debian-science's git and Sage >= 6.2 has also 3.1.6; an ITP has been filled to package singular 4.0.1, see 764475.

Sage components that need a new maintainer and an upload to Debian:

sagenb

the dependencies should be in Debian now (691509, 703541, 703531, 703533, 703534, 703535 and 703536)

sagetex

Softwares that need to be packaged:

4ti2

Singular 4 depends on 4ti2; a package is in the NEW queue, see 769997

normaliz

Singular 4 depends on normaliz; an ITP has been filled to package normaliz 2.12.2, see 776019

surf-alggeo

Singular 4 depends on surf; an ITP has been filled to package surf-alggeo 1.0.6, see 777132

Packages that are (hopefully) not needed:

cephes

The Cephes Mathematical Library is only needed for systems where the libc doesn't provide appropriate mathematical functions (cygwin and FreeBSD) and so is not required for Debian.

iconv

is part of the libc

libgap

Will most likely be replaced by a wrapper for GAP.

mpir

708391

mpir is supposed to be ABI-compatible with gmp. A lot of math packages use gmp and we hope we can have a purely gmp based Sage in Debian. Combining the two will most likely lead to conflicts, using mpir we would need an extra mpir version of many packages.

Other known or suspected issues

  • ECL has a strange bug in debian (see 777473).

  • sage expects to use both ecl and maxima, together, but maxima in debian is using gcl and has no support for ecl ; Snark has fixes for that, but some things (like the above ECL problem) need to clear out before they can be pushed in debian.
  • pari in sage's latest has a patch and uses a header file which aren't in the debian package, so one currently needs to modify a few things by hand to get going (see 777237)

  • cddlib in sage is a fork so the current debian package won't replace it even if the versions match (see this sage bug)

Information bits that are no issues

  • Sage upstream would like to get rid of flintqs since some recent versions of flint ship with a quadratic sieve (see this ticket, but it hasn't been done yet). This mail of William Hart tells more about the state of the quadratic sieve code in both flint and flint2. flintqs was uploaded to Debian for the meantime (but blocked in unstable).

Old sagemath package

The old, buggy sagemath Debian package source code is available at http://snapshot.debian.org/package/sagemath/3.0.5dfsg-5.1/