release-request-a2143a0f-bf92-4fa8-ad68-7346e7505126-for-git_oc-dr1-release-4067638 snap-temp-L84900000070511178

Change-Id: I67a42c64a464d654c5fd5572e239e014a354e5f1
tree: 6236084b64e2fac1395c14e1cd31f07631bdd17c
  1. .dir-locals.el
  2. .gitignore
  3. .travis.yml
  4. LICENSE
  5. README.md
  6. doc/
  7. hooks/
  8. scripts/
  9. setup.cfg
  10. setup.py
  11. tests/
  12. trappy/
README.md

TRAPpy Build Status Version

TRAPpy (Trace Analysis and Plotting in Python) is a visualization tool to help analyze data generated on a device. It parses ftrace-like logs and creates in-memory data structures to be used for plotting and data analysis.

Installation

The following instructions are for Ubuntu 14.04 LTS but they should also work with Debian jessie. Older versions of Ubuntu or Debian (e.g. Ubuntu 12.04 or Debian wheezy) will likely require to install more packages from pip as the ones present in Ubuntu 12.04 or Debian wheezy will probably be too old.

Required dependencies

Install additional tools required for some tests and functionalities
$ sudo apt install trace-cmd kernelshark
Install the Python package manager
$ sudo apt install python-pip python-dev
Install required python packages
$ sudo apt install libfreetype6-dev libpng12-dev python-nose
$ sudo pip install numpy matplotlib pandas ipython[all]
Install TRAPpy
$ sudo pip install --upgrade trappy

Quickstart

Now launch the ipython notebook server:

$ ipython notebook

This should pop up a browser. If it doesn't, open a web browser and go to http://localhost:8888/tree/

In the doc/ folder there's a 00 - Quick start which describes how to run TRAPpy. Other notebooks in that directory describe other functions of TRAPpy.

Documentation

API reference can be found in https://pythonhosted.org/TRAPpy/

For developers

Clone the repository

The code of the TRAPpy toolkit with all the supported tests and Notebooks can be cloned from the official GitHub repository with this command:

$ git clone https://github.com/ARM-software/trappy.git

Testing your installation

An easy way to test your installation is to use the nosetests command from TRAPpy's home directory:

$ nosetests

If the installation is correct all tests will succeed.