mirror of
https://github.com/ARM-software/workload-automation.git
synced 2025-02-20 20:09:11 +00:00
e672ea3faf
Devlib's ACME instrument uses iio-capture under the hood, which can only capture data from one IIO device at a time. Devlib's instrument API expects to produce a single CSV file for the Instrument, with a single axis of sample timestamps. These two things cannot be correctly reconciled without changing the devlib Instrument API - get_data would need to be able to return two distinct sets of data. Instead, where required WA will instantiate the ACME instrument multiple times (once for each IIO device), producing two separate CSV files. Aggregated energy info (as opposed to timestamped samples of energy data) _can_ be meaningfully combined from multiple IIO devices, so the derived stats are summed. This requires altering the internal API of the energy_measurement module - rather than a single instrument the super-instrument now has a dictionary mapping 'device' keys (this is really an arbitrary key, but I think that 'device' is a justifiable metaphor for whatever might separate multiple instruments, plus it is the terminology used by IIO/ACME) to Instrument objects. Existing instruments simply return a dict with a single entry, with None as the key. It may in future be possible to solve this problem in devlib's ACME instrument by avoiding the use of the iio-capture tool. In that case, it should be possible to basically revert this patch and get the required funcitonality from devlib.
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.