README.md
1 TRAPpy [![Build Status](https://travis-ci.org/ARM-software/trappy.svg?branch=master)](https://travis-ci.org/ARM-software/trappy) [![Version](https://img.shields.io/pypi/v/trappy.svg)](https://pypi.python.org/pypi/trappy)
2 ======
3
4 TRAPpy (Trace Analysis and Plotting in Python) is a visualization tool to help
5 analyze data generated on a device. It parses ftrace-like logs and creates
6 in-memory data structures to be used for plotting and data analysis.
7
8 # Installation
9
10 The following instructions are for Ubuntu 14.04 LTS but they should
11 also work with Debian jessie. Older versions of Ubuntu or Debian
12 (e.g. Ubuntu 12.04 or Debian wheezy) will likely require to install
13 more packages from pip as the ones present in Ubuntu 12.04 or Debian
14 wheezy will probably be too old.
15
16 ## Required dependencies
17
18 ##### Install additional tools required for some tests and functionalities
19
20 $ sudo apt install trace-cmd kernelshark
21
22 ##### Install the Python package manager
23
24 $ sudo apt install python-pip python-dev
25
26 ##### Install required python packages
27
28 $ sudo apt install libfreetype6-dev libpng12-dev python-nose
29 $ sudo pip install numpy matplotlib pandas ipython[all]
30
31 ##### Install TRAPpy
32
33 $ sudo pip install --upgrade trappy
34
35 # Quickstart
36
37 Now launch the ipython notebook server:
38
39 $ ipython notebook
40
41 This should pop up a browser. If it doesn't, open a web browser and go
42 to http://localhost:8888/tree/
43
44 In the `doc/` folder there's a `00 - Quick start` which describes how to
45 run TRAPpy. Other notebooks in that directory describe other functions
46 of TRAPpy.
47
48 # Documentation
49
50 API reference can be found in https://pythonhosted.org/TRAPpy/
51
52 # For developers
53
54 ## Clone the repository
55
56 The code of the TRAPpy toolkit with all the supported tests and
57 Notebooks can be cloned from the official GitHub repository with this
58 command:
59
60 $ git clone https://github.com/ARM-software/trappy.git
61
62 ## Testing your installation
63
64 An easy way to test your installation is to use the `nosetests` command from
65 TRAPpy's home directory:
66
67 $ nosetests
68
69 If the installation is correct all tests will succeed.
70