1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2024-10-06 10:51:13 +01:00
Go to file
Sergei Trofimov 1fe899fd7c Promote pandas to a mandatory dependency.
Pandas is already widely used in WA and devlib for fast numerical table
manipulation in various instruments and output processors. Up to this
point, it has been an optional dependency.

Over the last couple of years, the package has become very wide spread,
and is available in repos for virtually every major distro. There is now
little reason not to require it as a mandatory dependency.
2018-01-25 10:50:02 +00:00
dev_scripts Fix pylint for wlauto -> wa 2017-12-07 15:37:49 +00:00
doc doc: update revent documentation 2017-09-27 10:34:48 +01:00
extras extras/pylintrc: Disable no-else-return warning 2017-12-07 15:37:49 +00:00
scripts scripts: remove legacy WA2 scripts 2017-04-27 09:01:22 +01:00
tests test/exec_control: Updated to test new @once functionality 2018-01-15 15:42:26 +00:00
wa framework/execution: add context to job signals 2018-01-25 10:50:02 +00:00
.gitignore .gitignore: Updated for new uiautomation build system 2017-06-12 14:57:54 +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 Promote pandas to a mandatory dependency. 2018-01-25 10:50:02 +00: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.