1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2024-10-06 02:41:11 +01:00
Go to file
Marc Bonnici 891ef60f4d configuration: Add support for section groups
Now allows for specifying a `group` value for each section which will
cross product the sections within that group with the sections in each
other group. Additionally classifiers will automatically be added to
each job spec with the relevant group information.
2018-09-24 10:17:26 +01:00
dev_scripts dev_scripts/pylint: fix default path 2018-07-18 11:20:48 +01:00
doc configuration: Add support for section groups 2018-09-24 10:17:26 +01:00
extras extras/Dockerfile: Update to use latest releases 2018-07-06 14:42:14 +01:00
scripts scripts: remove legacy WA2 scripts 2017-04-27 09:01:22 +01:00
tests tests: add unit test for includes 2018-07-23 16:47:10 +01:00
wa configuration: Add support for section groups 2018-09-24 10:17:26 +01:00
.gitignore gitignore: fix path to instrument_method_map.rst 2018-06-28 14:04:21 +01:00
.travis.yml Travis: Update to exercise wa commands 2018-07-26 12:07:17 +01:00
LICENSE Initial commit of open source Workload Automation. 2015-03-10 13:09:31 +00:00
MANIFEST.in Initial commit of open source Workload Automation. 2015-03-10 13:09:31 +00:00
README.rst README: Update with WA3 Information 2018-07-06 15:22:12 +01:00
setup.py setup: Update devlib dependency version number 2018-09-21 15:06:30 +01:00

Workload Automation
+++++++++++++++++++

Workload Automation (WA) is a framework for executing workloads and collecting
measurements on Android and Linux devices. WA includes automation for nearly 40
workloads and supports some common instrumentation (ftrace, hwmon) along with a
number of output formats.

WA is designed primarily as a developer tool/framework to facilitate data driven
development by providing a method of collecting measurements from a device in a
repeatable way.

WA is highly extensible. Most of the concrete functionality is implemented via
plug-ins, and it is easy to write new plug-ins to support new device types,
workloads, instruments or output processing.


Requirements
============

- Python 2.7 or Python 3
- Linux (should work on other Unixes, but untested)
- Latest Android SDK (ANDROID_HOME must be set) for Android devices, or
- SSH for Linux devices


Installation
============

To install::

        git clone git@github.com:ARM-software/workload-automation.git workload-automation
        sudo -H pip install ./workload-automation

Please refer to the `installation section <http://workload-automation.readthedocs.io/en/latest/user_information.html#install>`_
in the documentation for more details.


Basic Usage
===========

Please see the `Quickstart <http://workload-automation.readthedocs.io/en/latest/user_information.html#user-guide>`_
section of the documentation.


Documentation
=============

You can view pre-built HTML documentation `here <http://workload-automation.readthedocs.io/en/latest/>`_.

Documentation in reStructuredText format may be found under ``doc/source``. To
compile it into cross-linked HTML, make sure you have `Sphinx
<http://sphinx-doc.org/install.html>`_ installed, and then ::

        cd doc
        make html


License
=======

Workload Automation is distributed under `Apache v2.0 License
<http://www.apache.org/licenses/LICENSE-2.0>`_. Workload automation includes
binaries distributed under different licenses (see LICENSE files in specific
directories).


Feedback, Contributions and Support
===================================

- Please use the GitHub Issue Tracker associated with this repository for
  feedback.
- ARM licensees may contact ARM directly via their partner managers.
- We welcome code contributions via GitHub Pull requests. Please see
  "Contributing Code" section of the documentation for details.