1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2024-10-05 18:31:12 +01:00
Go to file
Sergei Trofimov dc478d933e .gitignore: fix run_config pattern
Add missing underscore.
2018-05-25 15:27:14 +01:00
dev_scripts dev_scripts/dev8: Update to use WA3 paths 2018-05-21 10:26:28 +01:00
doc doc: update metrics and artifacts docs 2018-05-25 15:27:14 +01:00
extras docker: Add note on how to use TTY 2018-04-10 16:52:58 +01:00
scripts scripts: remove legacy WA2 scripts 2017-04-27 09:01:22 +01:00
tests tests/agenda_parser: Update agenda tests to the AgendaParser 2018-05-24 11:49:10 +01:00
wa utils/serializer: add cpu_mask to POD types 2018-05-25 15:27:14 +01:00
.gitignore .gitignore: fix run_config pattern 2018-05-25 15:27:14 +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 Added link to pre-built documentation. 2015-04-27 18:26:55 +01:00
setup.py Documentation: Update WA3 Documentation 2018-04-24 09:59:57 +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 50
workloads (mostly Android), some common instrumentation (ftrace, ARM
Streamline, hwmon).  A number of output formats are supported. 

Workload Automation 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.

Workload Automation 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, instrumentation or output processing. 


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

- Python 2.7
- 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::

        python setup.py sdist
        sudo pip install dist/wlauto-*.tar.gz

Please refer to the `installation section <./doc/source/installation.rst>`_ 
in the documentation for more details.


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

Please see the `Quickstart <./doc/source/quickstart.rst>`_ section of the 
documentation.


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

You can view pre-built HTML documentation `here <http://pythonhosted.org/wlauto/>`_.

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 differnt licenses (see LICENSE files in specfic
directories).


Feedback, Contrubutions 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.