README

   1 Phoronix Test Suite 5.0.1
   2 http://www.phoronix-test-suite.com/
   3 #####################################
   4
   5 The Phoronix Test Suite is the most comprehensive testing and benchmarking
   6 platform available for Linux, Solaris, Mac OS X, and BSD operating systems. The
   7 Phoronix Test Suite allows for carrying out tests in a fully automated manner
   8 from test installation to execution and reporting. All tests are meant to be
   9 easily reproducible, easy-to-use, and support fully automated execution. The
  10 Phoronix Test Suite is open-source under the GNU GPLv3 license and is developed
  11 by Phoronix Media in cooperation with partners.
  12
  13 The Phoronix Test Suite itself is an open-source framework for conducting
  14 automated tests along with reporting of test results, detection of installed
  15 system software/hardware, and other features. Modules for the Phoronix Test
  16 Suite also allow for integration with git-bisect and other revision control
  17 systems for per-commit regression testing, system sensor monitoring, and other
  18 extras.
  19
  20 This framework is designed to be an extensible architecture so that new test
  21 profiles and suites can be easily added to represent performance benchmarks,
  22 unit tests, and other quantitative and qualitative (e.g. image quality
  23 comparison) measurements. Available through OpenBenchmarking.org, a
  24 collaborative storage platform developed in conjunction with the Phoronix Test
  25 Suite, are more than 200 individual test profiles and more than 60 test suites
  26 available by default from the Phoronix Test Suite. Independent users are also
  27 able to upload their test results, profiles, and suites to OpenBenchmarking.org.
  28 A test profile is a single test that can be executed by the Phoronix Test Suite
  29 -- with a series of options possible within every test -- and a test suite is a
  30 seamless collection of test profiles and/or additional test suites. A test
  31 profile consists of a set of bash/shell scripts and XML files while a test suite
  32 is a single XML file.
  33
  34 OpenBenchmarking.org <http://www.openbenchmarking.org/> also allows for
  35 conducting side-by-side result comparisons, a central location for storing and
  36 sharing test results, and collaborating over test data. Phoromatic
  37 <http://www.phoromatic.com/> is a complementary platform to OpenBenchmarking.org
  38 and the Phoronix Test Suite for interfacing with Phoronix Test Suite client(s)
  39 to automatically execute test runs on a timed, per-commit, or other
  40 trigger-driven basis. Phoromatic is designed for enterprise and allows for the
  41 easy management of multiple networked systems running Phoronix Test Suite
  42 clients via a single web-based interface.
  43
  44 Professional support and custom engineering for the Phoronix Test Suite,
  45 Phoromatic, and OpenBenchmarking.org is available by contacting
  46 <http://www.phoronix-test-suite.com/>.
  47
  48 Full details on the Phoronix Test Suite setup and usage is available from the
  49 included HTML/PDF documentation within the phoronix-test-suite package and from
  50 the Phoronix Test Suite web-site.
  51
  52 INSTALLATION & SETUP:
  53 #####################
  54
  55 The Phoronix Test Suite is supported on Linux, *BSD, Solaris, Mac OS X, and
  56 Windows systems. However, the most full-featured and well supported operating
  57 system for conducting the tests is Linux with some non-basic functionality not
  58 being available under all platforms. The Phoronix Test Suite software/framework
  59 is compatible with all major CPU architectures (e.g. i686, x86_64, ARM,
  60 PowerPC), but not all of the test profiles/suites are compatible with all
  61 architectures.
  62
  63 The Phoronix Test Suite can be installed for system-wide usage or run locally
  64 without installation from the extracted tar.gz/zip package. The only hard
  65 dependency on the Phoronix Test Suite is having command-line support for PHP
  66 (PHP 5.2+) installed. A complete PHP stack (e.g. with web-server) is NOT needed,
  67 but merely the PHP command-line support, which is widely available from
  68 operating system package managers under the name php, php5-cli, or php5.
  69
  70 USAGE:
  71 ######
  72
  73 The process to download, install/setup, execute, and report the results of a
  74 benchmark can be as simple as a command such as *phoronix-test-suite benchmark
  75 smallpt* to run a simple CPU test profile. If wishing to simply install a test,
  76 it's a matter of running *phoronix-test-suite install <test or suite name>* and
  77 to run it's *phoronix-test-suite run <test or suite name>*. There's also a batch
  78 mode for non-interactive benchmarking by first running *phoronix-test-suite
  79 batch-setup* and then using the *batch-run* sub-command rather than *run*.
  80
  81 Viewing installed system hardware and software is available via
  82 *phoronix-test-suite system-info* or *phoronix-test-suite detailed-system-info*
  83 for greater verbosity.
  84
  85 Facilitating a result comparison from OpenBenchmarking.org can be done by
  86 running, for example, *phoronix-test-suite benchmark 1204293-BY-PHORONIX357* if
  87 wishing to compare the results of the
  88 *http://openbenchmarking.org/result/1204293-BY-PHORONIX357* result file.
  89
  90 Additional information is available from the Phoronix Test Suite web-site
  91 <http://www.phoronix-test-suite.com/> and the material bundled within the
  92 phoronix-test-suite/documentation/ directory. A man page is also bundled with
  93 the phoronix-test-suite software.
  94