PROJECT SUMMARY

Sage-on-Gentoo provides split ebuilds (http://www.gentoo.org) for the computer algebra system SAGE (http://www.sagemath.org).

CONTACT

If you have problems with sage-on-gentoo or have suggestions talk to us on #gentoo-science

https://www.gentoo.org/get-involved/irc-channels/

or write a mail to the "gentoo-science" mailing list

https://www.gentoo.org/get-involved/mailing-lists/all-lists.html

An archive listing past mails may be found at

http://archives.gentoo.org/gentoo-science/

QUICK INSTALLATION GUIDE

Installation of the overlay

Eselect-repository install

The easiest way to enable the overlay is to::

emerge --noreplace eselect-repository && eselect repository enable sage-on-gentoo && emerge --sync

and emerge the package as usual.

Manual Install

As per the current Portage specifications (https://dev.gentoo.org/~zmedico/portage/doc/man/portage.5.html), ebuild repositories (a.k.a. overlays) can be managed via file collections under /etc/portage/repos.conf/, via the new plug-in sync system (https://wiki.gentoo.org/wiki/Project:Portage/Sync).

To enable the overlay without the need for additional software, you first need to have git installed::

emerge --ask --verbose dev-vcs/git

Then you need to add the sage-on-gentoo repository configuration by downloading the sage-on-gentoo.conf file::

wget https://raw.githubusercontent.com/cschwan/sage-on-gentoo/master/metadata/sage-on-gentoo.conf \
    -O /etc/portage/repos.conf/sage-on-gentoo

Manual Uninstall

To uninstall the overlay, simply run::

rm /etc/portage/repos.conf/sage-on-gentoo
rm /var/db/repos/sage-on-gentoo -rf

Synchronising the overlay

The overlay is synced each time you run emerge --sync or the equivalent eix-sync if you are using it. Off course it synchronises the whole tree which could be undesirable if you have already synced recently. To synchronise only the overlay use::

emaint sync -r sage-on-gentoo

USING the overlay to install sage(math)

UNMASK EBUILDS

Before being able to install you may need to unmask the required ebuilds. If you are using Gentoo/unstable or Funtoo (i.e. you have a line like ACCEPT_KEYWORDS=~arch in your /etc/portage/make.conf) you can skip this step::

 sage-on-gentoo/package.keywords/sage
 sage-on-gentoo/package.keywords/sage.prefix (for prefix users only)

To use these files permanently, place symbolic link to the one of those files into your /etc/portage/package.accept_keywords/ directory (prefix users should adjust with their prefix)::

 ln -s /var/db/repos/sage-on-gentoo/package.keywords/sage \
       /etc/portage/package.accept_keywords/sage

Otherwise, simply copy it into the directory for a one-time fix.

The sage.prefix files contains keywords for ebuilds lacking any prefix keywords.

ADD USE-FLAGS FOR EBUILDS

Since Sage's ebuild requires its dependencies to be built with several USE-flags we provide a standard package.use file as well::

 ln -s /var/db/repos/sage-on-gentoo/package.use/sage \
       /etc/portage/package.use/sage

The following section is currently not fully applicable from sage 9.5 onward. I currently do not provide binary documentation but I am hoping to restore this service at some point in time. You should also consider linking in the same way the file 99sage-doc-bin. This file sets sane default options for installing html documentation from a binary tarball. Building the sage documentation from scratch is memory hungry and you shouldn't consider doing it with less than 6GB of free memory on your system. This is only available for stable realease of sage (sage-X.Y). User of the development version of sage (sage-9999 ebuild) need to build their own documentation from scratch if they need it.

NOTE: if you want sage to display plots while working from a terminal, you should make sure that matplotlib is installed with at least one graphical backend such as gtk3 or qt5.

INSTALL SAGE

Type::

 emerge -va sage

to install sage; please note that this will pull in a lot of dependencies. If you can not proceed with this step (because of circular dependencies, missing USE-flags, and so on) please report this behavior.

Starting with sage 9.5 which is split into several ebuilds, a set has been added for convenience. To make the set available to portage::

 mkdir -p /etc/portage/sets
 ln -s /var/db/repos/sage-on-gentoo/sets/sagemath \
       /etc/portage/sets/sagemath

More informations on sets can be found at https://wiki.gentoo.org/wiki//etc/portage/sets While emerge -va sage will still emerge the necessary ebuilds, using the set make sure all the relevant ebuilds are always rebuilt or removed in sync. To use the set to install sage type::

 emerge -va @sagemath

To unistall the main ebuilds of sage type::

 emerge -C @sagemath

SAGE ON GENTOO PREFIX

A Prefix enables you to install Gentoo on different OS (e.g Linux, FreeBSD, MacOS, Solaris and even Windows). Thus, you may be able to run Sage on Gentoo e.g. on a Debian Linux. For a complete introduction into Gentoo Prefix and how to set it up visit

http://www.gentoo.org/proj/en/gentoo-alt/prefix/

After having a working Prefix you may setup sage-on-gentoo in a Prefix by following the quick installation guide.

Currently, we support every Linux running with amd64 instruction sets, in particular the following architectures:

• ~amd64-linux