aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichele Di Giorgio <michele.digiorgio@arm.com>2016-03-31 11:23:45 +0100
committerMichele Di Giorgio <michele.digiorgio@arm.com>2016-03-31 11:28:42 +0100
commit9c88775ceb5505318c88a94f91e3d8e033b908f7 (patch)
tree8d8fb47d2cb56dc3a78173820c394d127089a2fe
parent8eb2939f8b5113cf4efe783543e5fc57bd38e032 (diff)
downloadbart-9c88775ceb5505318c88a94f91e3d8e033b908f7.tar.gz
README.md: improve structure of README file
-rw-r--r--README.md98
1 files changed, 66 insertions, 32 deletions
diff --git a/README.md b/README.md
index 8ad5f92..13d16b2 100644
--- a/README.md
+++ b/README.md
@@ -1,77 +1,111 @@
-# Introduction
+BART [![Build Status](https://travis-ci.org/ARM-software/bart.svg?branch=master)](https://travis-ci.org/ARM-software/bart)
+====
-The Behavioural Analysis and Regression Toolkit is based on [TRAPpy](https://github.com/ARM-software/trappy). The primary goal is to assert behaviours using the FTrace output from the kernel
+The Behavioural Analysis and Regression Toolkit is based on
+[TRAPpy](https://github.com/ARM-software/trappy). The primary goal is to assert
+behaviours using the FTrace output from the kernel.
## Target Audience
-The framework is designed to cater to a wide range of audience. Aiding developers as well as automating
-the testing of "difficult to test" behaviours.
-### Kernel Developers
+The framework is designed to cater to a wide range of audience. Aiding
+developers as well as automating the testing of "difficult to test" behaviours.
+
+#### Kernel Developers
Making sure that the code that you are writing is doing the right thing.
-### Performance Engineers
+#### Performance Engineers
+
+Plotting/Asserting performance behaviours between different revisions of the
+kernel.
-Plotting/Asserting performance behaviours between different revisions of the kernel
+#### Quality Assurance/Release Engineers
-### Quality Assurance/Release Engineers
-Verifying behaviours when different components/patches are integrated
+Verifying behaviours when different components/patches are integrated.
# Installation
-Clone the [BART]( https://github.com/ARM-software/bart) and [TRAPpy]( https://github.com/ARM-software/trappy) repos
+## Required dependencies
- git clone git@github.com:ARM-software/bart.git
- git clone git@github.com:ARM-software/trappy.git
+#### Install additional tools required for some tests and functionalities
-Add the directories to your PYTHONPATH
+ $ 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]
+ $ sudo pip install --upgrade trappy
- export PYTHONPATH=$BASE_DIR/bart:$BASE_DIR/trappy:$PYTHONPATH
+`ipython[all]` will install [IPython
+Notebook](http://ipython.org/notebook.html), a web based interactive
+python programming interface. It is required if you plan to use interactive
+plotting in BART.
-Install dependencies
+#### Install BART
+
+ $ sudo pip install --upgrade bart-py
+
+# For developers
+
+Instead of installing TRAPpy and BART using `pip` you should the repositories:
+
+ $ git clone git@github.com:ARM-software/bart.git
+ $ git clone git@github.com:ARM-software/trappy.git
+
+Add the directories to your PYTHONPATH
- apt-get install ipython-notebook python-pandas
+ $ export PYTHONPATH=$BASE_DIR/bart:$BASE_DIR/trappy:$PYTHONPATH
-[IPython](http://ipython.org/notebook.html) notebook is a web based interactive python programming interface.
-It is required if you plan to use interactive plotting in BART.
# Trace Analysis Language
-BART also provides a generic Trace Analysis Language, which allows the user to construct complex relation statements on trace data and assert their expected behaviours. The usage of the Analyzer module can be seen for the thermal behaviours [here](https://github.com/ARM-software/bart/blob/master/notebooks/thermal/Thermal.ipynb)
+BART also provides a generic Trace Analysis Language, which allows the user to
+construct complex relation statements on trace data and assert their expected
+behaviours. The usage of the Analyzer module can be seen for the thermal
+behaviours
+[here](https://github.com/ARM-software/bart/blob/master/notebooks/thermal/Thermal.ipynb)
# Scheduler Assertions
Enables assertion and the calculation of the following parameters:
-### Runtime
+#### Runtime
The total time that the task spent on a CPU executing.
-### Switch
+#### Switch
-Assert that a task switched between CPUs/Clusters in a given window of time
+Assert that a task switched between CPUs/Clusters in a given window of time.
-### Duty Cycle
+#### Duty Cycle
The ratio of the execution time to the total time.
-### Period
+#### Period
-The average difference between two switch-in or two switch-out events of a task
+The average difference between two switch-in or two switch-out events of a
+task.
-### First CPU
+#### First CPU
The first CPU that a task ran on.
-### Residency
+#### Residency
-Calculate and assert the total residency of a task on a CPU or cluster
+Calculate and assert the total residency of a task on a CPU or cluster.
-### Examples
+#### Examples
-The Scheduler assertions also use TRAPpy's EventPlot to provide a kernelshark like timeline
-for the tasks under consideration. (in IPython notebooks).
+The Scheduler assertions also use TRAPpy's EventPlot to provide a `kernelshark`
+like timeline for the tasks under consideration. (in IPython notebooks).
-A notebook explaining the usage of the framework for asserting the deadline scheduler behaviours can be seen [here](https://rawgit.com/sinkap/0abbcc4918eb228b8887/raw/a1b4d6e0079f4ea0368d595d335bc340616501ff/SchedDeadline.html)
+A notebook explaining the usage of the framework for asserting the deadline
+scheduler behaviours can be seen
+[here](https://rawgit.com/sinkap/0abbcc4918eb228b8887/raw/a1b4d6e0079f4ea0368d595d335bc340616501ff/SchedDeadline.html).