Ticket #10508: trac_10508_update_atlas_docs.rebased.patch

File trac_10508_update_atlas_docs.rebased.patch, 4.5 KB (added by jpflori, 8 years ago)
  • doc/en/installation/source.rst

    # HG changeset patch
    # User Jean-Pierre Flori <jean-pierre.flori@ssi.gouv.fr>
    # Date 1367848249 -3600
    # Node ID bf2ce48989e67501125c0d8a2d51beca43d2ea09
    # Parent  b25479d0a27ab01d59063b4a3406b030e0411717
    Update the installation guide for ATLAS 3.10.0
    diff --git a/doc/en/installation/source.rst b/doc/en/installation/source.rst
    a b  
    983983  systems with CPU throttling or if you want to distribute the binaries.
    984984  Available architectures are
    986     ``POWER3``, ``POWER4``, ``POWER5``, ``PPCG4``, ``PPCG5``, ``P5``,
     986    ``POWER3``, ``POWER4``, ``POWER5``, ``PPCG4``, ``PPCG5``,
     987    ``POWER6``, ``POWER7``, ``IBMz9``, ``IBMz10``, ``IBMz196``,
     988    ``x86x87``, ``x86SSE1``, ``x86SSE2``, ``x86SSE3``, ``P5``,
    987989    ``P5MMX``, ``PPRO``, ``PII``, ``PIII``, ``PM``, ``CoreSolo``,
    988     ``CoreDuo``, ``Core2Solo``, ``Core2``, ``Corei7``, ``P4``,
    989     ``P4E``, ``Efficeon``, ``K7``, ``HAMMER``, ``AMD64K10h``,
    990     ``IA64Itan``, ``IA64Itan2``, ``USI``, ``USII``, ``USIII``,
    991     ``USIV``, ``UnknownUS``, ``MIPSR1xK``, ``MIPSICE9``
     990    ``CoreDuo``, ``Core2Solo``, ``Core2``, ``Corei1``, ``Corei2``,
     991    ``Atom``, ``P4``, ``P4E``, ``Efficeon``, ``K7``, ``HAMMER``,
     992    ``AMD64K10h``, ``AMDDOZER``, ``UNKNOWNx86``, ``IA64Itan``,
     993    ``IA64Itan2``, ``USI``, ``USII``, ``USIII``, ``USIV``, ``UST2``,
     994    ``UnknownUS``, ``MIPSR1xK``, ``MIPSICE9``, ``ARMv7``.
    993996  and instruction set extensions are
    995     ``AltiVec``, ``SSE3``, ``SSE2``, ``SSE1``, ``3DNow``.
     998    ``VSX``, ``AltiVec``, ``AVXMAC``, ``AVXFMA4``, ``AVX``, ``SSE3``,
     999    ``SSE2``, ``SSE1``, ``3DNow``, ``NEON``.
    9971001  In addition, you can also set
    10051009  For example,
    1007     ``SAGE_ATLAS_ARCH=Corei7,SSE3,SSE2,SSE1``
     1011    ``SAGE_ATLAS_ARCH=Corei2,AVX,SSE3,SSE2,SSE1``
    10091013  would be appropriate for a Core i7 CPU.
    10131017  own version of ATLAS, set this variable to be the directory containing your
    10141018  ATLAS installation.
    10151019  It should contain the files :file:`libatlas`, :file:`liblapack`,
    1016   :file:`libcblas`, and :file:`libf77blas` with extensions ``.a``, ``.so``, or
    1017   ``.dylib``.
     1020  :file:`libcblas`, :file:`libptcblas`, :file:`libf77blas`, and
     1021  :file:`libptf77blas`, with extensions ``.a``, ``.so``, or ``.dylib``.
    10181022  For backward compatibility, the libraries may also be in the subdirectory
    10191023  :file:`SAGE_ATLAS_LIB/lib/`.
    1257 Sometimes the ATLAS spkg can fail to build.
    1258 Some things to check for:
     1261Usually Sage will build ATLAS with architectural defaults that are not tuned
     1262to your particular CPU.
     1263In particular, if your CPU has powersaving enabled then no accurate timings
     1264can be made to tune the ATLAS build for your hardware.
     1265If BLAS performance is critical for you, you must recompile ATLAS after
     1266installing Sage either with architecture settings that match your hardware,
     1267or run through ATLAS' automatic tuning process where timings of different
     1268implementations are compared and the best choice used to build a custom ATLAS
     1270To do so, you have to
    1260 - Make sure that CPU throttling mode (i.e. power-saving mode) is turned off
    1261   when building ATLAS.
     1272- Leave the computer idle while you are reinstalling ATLAS.
     1273  Most of ATLAS will intentionally only compile/run on a single core.
     1274  Accurate timings of cache edges require that the CPU is otherwise idle.
    1263 - The ATLAS build can also fail if the system load is too high, and in
    1264   particular this has been known to happen when building with
    1265   ``MAKE='make -jNUM'`` with ``NUM`` large.
    1266   If this happens, just try running ``make`` again.
    1267   If ``make`` fails after five or six attempts, report your problem to the
    1268   sage-devel mailing list at http://groups.google.com/group/sage-devel.
     1276- Make sure that CPU powersaving mode (that is, anything but the
     1277  ``performance`` CPU scaling governor in Linux) is turned off when building
     1278  ATLAS.
     1279  This requires administrator privileges.
     1281- If your architecture is listed in :envvar:`SAGE_ATLAS_ARCH`, you should set
     1282  it as it can help ATLAS in narrowing down the timing search.
     1284To help you disable CPU power saving, Sage includes an ``atlas-config`` script
     1285that will turn off CPU powersave and rebuild ATLAS.
     1286The script will call ``sudo`` to gain the necessary rights, which may prompt
     1287you for your password. For example::
     1289    atlas-config
     1291will run through the full automated tuning, and::
     1293    SAGE_ATLAS_ARCH=Corei2,AVX,SSE3,SSE2,SSE1 atlas-config
     1295would be appropriate if you have a Core i3/5/7 processor with AVX support.