From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from pigeon.gentoo.org ([208.92.234.80] helo=lists.gentoo.org) by finch.gentoo.org with esmtp (Exim 4.60) (envelope-from <gentoo-commits+bounces-372299-garchives=archives.gentoo.org@lists.gentoo.org>) id 1QsZuz-0000B1-My for garchives@archives.gentoo.org; Sun, 14 Aug 2011 12:35:53 +0000 Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 28AE121C1C5; Sun, 14 Aug 2011 12:35:46 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) by pigeon.gentoo.org (Postfix) with ESMTP id DB36821C08A for <gentoo-commits@lists.gentoo.org>; Sun, 14 Aug 2011 12:35:45 +0000 (UTC) Received: from pelican.gentoo.org (unknown [66.219.59.40]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 19D181B4049 for <gentoo-commits@lists.gentoo.org>; Sun, 14 Aug 2011 12:35:45 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) by pelican.gentoo.org (Postfix) with ESMTP id 48E9F80044 for <gentoo-commits@lists.gentoo.org>; Sun, 14 Aug 2011 12:35:44 +0000 (UTC) From: "Andrea Arteaga" <andyspiros@gmail.com> To: gentoo-commits@lists.gentoo.org Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Andrea Arteaga" <andyspiros@gmail.com> Message-ID: <73dd549f0c4f0b51efca7e9a496c8ac23a8f2d85.spiros@gentoo> Subject: [gentoo-commits] proj/auto-numerical-bench:master commit in: doc/ X-VCS-Repository: proj/auto-numerical-bench X-VCS-Files: doc/numbench.1 X-VCS-Directories: doc/ X-VCS-Committer: spiros X-VCS-Committer-Name: Andrea Arteaga X-VCS-Revision: 73dd549f0c4f0b51efca7e9a496c8ac23a8f2d85 Date: Sun, 14 Aug 2011 12:35:44 +0000 (UTC) Precedence: bulk List-Post: <mailto:gentoo-commits@lists.gentoo.org> List-Help: <mailto:gentoo-commits+help@lists.gentoo.org> List-Unsubscribe: <mailto:gentoo-commits+unsubscribe@lists.gentoo.org> List-Subscribe: <mailto:gentoo-commits+subscribe@lists.gentoo.org> List-Id: Gentoo Linux mail <gentoo-commits.gentoo.org> X-BeenThere: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: quoted-printable X-Archives-Salt: X-Archives-Hash: fbe3394305d116cde782aad3a683ae73 commit: 73dd549f0c4f0b51efca7e9a496c8ac23a8f2d85 Author: Andrea Arteaga <andyspiros <AT> gmail <DOT> com> AuthorDate: Sun Aug 14 12:35:24 2011 +0000 Commit: Andrea Arteaga <andyspiros <AT> gmail <DOT> com> CommitDate: Sun Aug 14 12:35:24 2011 +0000 URL: http://git.overlays.gentoo.org/gitweb/?p=3Dproj/auto-numerica= l-bench.git;a=3Dcommit;h=3D73dd549f Added manpage --- doc/numbench.1 | 119 ++++++++++++++++++++++++++++++++++++++++++++++++++= ++++++ 1 files changed, 119 insertions(+), 0 deletions(-) diff --git a/doc/numbench.1 b/doc/numbench.1 new file mode 100644 index 0000000..f3aa0a6 --- /dev/null +++ b/doc/numbench.1 @@ -0,0 +1,119 @@ +.TH NUMBENCH "1" "August 2011" "Gentoo" "User Commands" +.SH NAME +numbench \- Benchmarking tool for Gentoo +.SH SYNOPSIS +.B numbench +module conffile [\fIoptions\fR] + +.B numbench +module [\fI-h|--help\fR] + +.SH DESCRIPTION +.PP +numbench is a tool for compiling and benchmarking numerical +libraries. It is useful to find out the implementations of common +libraries that run faster on the machine and are more accurate. +The script makes use of the portage features in order to download, +compile, install and test the packages. + +.SS Modules +.IX Subsection "Modules" +.PP +The following modules are available: + +.RS +.B blas +\- Test BLAS implementations + +.B cblas +\- Test CBLAS implementations + +.B lapack +\- Test LAPACK implementations + +.B scalapack +\- Test the ScaLAPACK libary + +.B blas_accuracy +\- Test BLAS implementations for accuracy + +.B lapack_accuracy +\- Test LAPACK implementations for accuracy + +.B fftw +\- Test the FFTW libary + +.B metis +\- Test the METIS tools +.RE + +.PP +More information about each module is available through the command: +.B numbench module --help + +.SS Configuration file +.IX Subsection "Configuration file" + +.PP +In order to run a test, a configuration file has to be provided. +Each line of this file defines a package that is to be tested. +It is possible to test different versions of the same package, or +even to test many times the same package with different compile-time +environment; for each different version or environment, a different +line has to be written. + +.PP +Each line begins with an identification token of the test. This +identification can contain any characters, but it is recommended +that it only contains alphanumeric digits, the period . , the minus +sign - and the underscore _ . +After the identification word, the package has to be provided. The +package specification should be fully provided, in the usual +category/package-version[-revision] format. For instance +sci-libs/lapack-reference-3.3.1-r1. However, the script will try to +choose the best package in case of lacking information. +After the package, the environment has to be specified. In order +to do that, the user has to use the KEY=3DVALUE format. If the value +contains a whitespace, the single or double quoting marks have to be +used. The following are two valid configuration lines that define +the tests for the sci-libs/atlas package with different compilers +and CFLAGS: + +.RS +atlas-gcc sci-libs/atlas-3.9.46 CC=3Dgcc CFLAGS=3D-O2 + +atlas-gcc-4.6.1 sci-libs/atlas-3.9.46 CC=3Dgcc-4.6.1 CFLAGS=3D"-O3 -marc= h=3Dnative" +.RE + +.PP +Variables that affect the emerge process, such as USE, can be used +and are effective. +More configuration options are available. As each package can +install many implementations of the same library (for instance, the +sci-libs/atlas package installs the serial version and the +parallelized version with threads or openmp, depending on the USE +flags), each implementation is tested; but if you do not want to +test a specific implementation, you can mask it by adding to the +configuration line the string '-implementation' (without quoting +marks); then the script will skip the implementation. The following +is an example where the 32-bit implementations of the acml are +skipped: + +.RS +acml sci-libs/acml-4.4.0 -acml32-gfortran -acml32-gfortran-openmp +.RE + +.PP +The last configuration option that can be used is for libraries that +internally use other libraries. For example, most LAPACK +implementations lie on BLAS and/or CBLAS implementations. It is +possible to make the tested LAPACK implementation use a specific +BLAS implementation through the 'blas:implementation' (without +quotation marks) format. For instance, the following line +defines a test where the atlas LAPACK implementation uses the +openblas library as BLAS and CBLAS (openblas has to be installed for +this to work): + +.RS +atlas sci-libs/atlas-3.9.46 blas:openblas +.RE