Skip to content

Commit

Permalink
Trac #14753: Revert ATLAS package
Browse files Browse the repository at this point in the history
  • Loading branch information
jdemeyer committed Jun 17, 2013
1 parent 5f3ba64 commit fa26d97
Showing 1 changed file with 19 additions and 47 deletions.
66 changes: 19 additions & 47 deletions src/doc/en/installation/source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -990,20 +990,16 @@ Environment variables dealing with specific Sage packages:
systems with CPU throttling or if you want to distribute the binaries.
Available architectures are

``POWER3``, ``POWER4``, ``POWER5``, ``PPCG4``, ``PPCG5``,
``POWER6``, ``POWER7``, ``IBMz9``, ``IBMz10``, ``IBMz196``,
``x86x87``, ``x86SSE1``, ``x86SSE2``, ``x86SSE3``, ``P5``,
``POWER3``, ``POWER4``, ``POWER5``, ``PPCG4``, ``PPCG5``, ``P5``,
``P5MMX``, ``PPRO``, ``PII``, ``PIII``, ``PM``, ``CoreSolo``,
``CoreDuo``, ``Core2Solo``, ``Core2``, ``Corei1``, ``Corei2``,
``Atom``, ``P4``, ``P4E``, ``Efficeon``, ``K7``, ``HAMMER``,
``AMD64K10h``, ``AMDDOZER``, ``UNKNOWNx86``, ``IA64Itan``,
``IA64Itan2``, ``USI``, ``USII``, ``USIII``, ``USIV``, ``UST2``,
``UnknownUS``, ``MIPSR1xK``, ``MIPSICE9``, ``ARMv7``.
``CoreDuo``, ``Core2Solo``, ``Core2``, ``Corei7``, ``P4``,
``P4E``, ``Efficeon``, ``K7``, ``HAMMER``, ``AMD64K10h``,
``IA64Itan``, ``IA64Itan2``, ``USI``, ``USII``, ``USIII``,
``USIV``, ``UnknownUS``, ``MIPSR1xK``, ``MIPSICE9``

and instruction set extensions are

``VSX``, ``AltiVec``, ``AVXMAC``, ``AVXFMA4``, ``AVX``, ``SSE3``,
``SSE2``, ``SSE1``, ``3DNow``, ``NEON``.
``AltiVec``, ``SSE3``, ``SSE2``, ``SSE1``, ``3DNow``.

In addition, you can also set

Expand All @@ -1015,7 +1011,7 @@ Environment variables dealing with specific Sage packages:

For example,

``SAGE_ATLAS_ARCH=Corei2,AVX,SSE3,SSE2,SSE1``
``SAGE_ATLAS_ARCH=Corei7,SSE3,SSE2,SSE1``

would be appropriate for a Core i7 CPU.

Expand All @@ -1024,8 +1020,8 @@ Environment variables dealing with specific Sage packages:
own version of ATLAS, set this variable to be the directory containing your
ATLAS installation.
It should contain the files :file:`libatlas`, :file:`liblapack`,
:file:`libcblas`, :file:`libptcblas`, :file:`libf77blas`, and
:file:`libptf77blas`, with extensions ``.a``, ``.so``, or ``.dylib``.
:file:`libcblas`, and :file:`libf77blas` with extensions ``.a``, ``.so``, or
``.dylib``.
For backward compatibility, the libraries may also be in the subdirectory
:file:`SAGE_ATLAS_LIB/lib/`.

Expand Down Expand Up @@ -1265,42 +1261,18 @@ Some common problems
ATLAS
~~~~~

Usually Sage will build ATLAS with architectural defaults that are not tuned
to your particular CPU.
In particular, if your CPU has powersaving enabled then no accurate timings
can be made to tune the ATLAS build for your hardware.
If BLAS performance is critical for you, you must recompile ATLAS after
installing Sage either with architecture settings that match your hardware,
or run through ATLAS' automatic tuning process where timings of different
implementations are compared and the best choice used to build a custom ATLAS
library.
To do so, you have to
Sometimes the ATLAS spkg can fail to build.
Some things to check for:

- Leave the computer idle while you are reinstalling ATLAS.
Most of ATLAS will intentionally only compile/run on a single core.
Accurate timings of cache edges require that the CPU is otherwise idle.

- Make sure that CPU powersaving mode (that is, anything but the
``performance`` CPU scaling governor in Linux) is turned off when building
ATLAS.
This requires administrator privileges.

- If your architecture is listed in :envvar:`SAGE_ATLAS_ARCH`, you should set
it as it can help ATLAS in narrowing down the timing search.

To help you disable CPU power saving, Sage includes an ``atlas-config`` script
that will turn off CPU powersave and rebuild ATLAS.
The script will call ``sudo`` to gain the necessary rights, which may prompt
you for your password. For example::

atlas-config

will run through the full automated tuning, and::

SAGE_ATLAS_ARCH=Corei2,AVX,SSE3,SSE2,SSE1 atlas-config

would be appropriate if you have a Core i3/5/7 processor with AVX support.
- Make sure that CPU throttling mode (i.e. power-saving mode) is turned off
when building ATLAS.

- The ATLAS build can also fail if the system load is too high, and in
particular this has been known to happen when building with
``MAKE='make -jNUM'`` with ``NUM`` large.
If this happens, just try running ``make`` again.
If ``make`` fails after five or six attempts, report your problem to the
sage-devel mailing list at http://groups.google.com/group/sage-devel.


**This page was last updated in June 2013 (Sage 5.10).**

0 comments on commit fa26d97

Please sign in to comment.