README.md

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