diff --git a/README.md b/README.md index 5cfd2c037498a67ceb2dcafc506774b0c23cfc91..46ea18368c0d7bb386aca10ce39ab1e66075829f 100644 --- a/README.md +++ b/README.md @@ -20,128 +20,11 @@ support regression testing of core kernel features is provided. In addition, LISA uses the excellent IPython notebook framework and a set of notebooks are provided for live experiments on a target platform. -# Installation +# Documentation -This note assumes installation from scratch on a freshly installed -Debian system. - -## Required dependencies - - # Install common build related tools - $ sudo apt-get install build-essential autoconf automake libtool pkg-config - - # Install additional tools required for some notebooks and tests - $ sudo apt-get install trace-cmd sshpass kernelshark - - # Install optional tools required for some notebooks and tests - $ sudo apt-get install nmap net-tools tree - - # Install required python packages - $ sudo apt-get install python-matplotlib python-numpy libfreetype6-dev libpng12-dev python-nose - - # Install the Python package manager - $ sudo apt-get install python-pip python-dev - - # Install (upgrade) required Python libraries - $ sudo pip install --upgrade trappy bart-py devlib - -*NOTE:* TRAPpy and BART depend on *ipython* and *jupyter*. Some IPython -Notebooks examples are written using the notebooks JSON nbformat version 4, -which might not be supported by the IPython version installed by *apt-get*. -It is suggested to remove apt-get installed IPython and install it -using *pip*, which will provides the most updated version: - - # Remove (eventually) already installed versions - $ sudo apt-get remove ipython ipython-notebook - # Install most update version of the notebook - $ sudo pip install ipython jupyter - -## Clone the repository - -The code of the LISA 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/lisa.git - -# Target platform requirements - -The target platform to be used for experiments with LISA must satisfy -the following requirements: - -## Linux Targets - -- allow *ssh* access, preferably as root, using either a password or an SSH key -- support *sudo*, even if it's accessed as root user - -## Android Targets - -- allow *adb* access, eventually by specifying a DEVICE ID -- the local shell should define the *ANDROID_HOME* environment variable pointing - to an Android SDK installation - -## Kernel features - -Most of the tests targets a kernel with support for some new frameworks which -are currently in-development: - -- Energy-Aware Scheduler (EAS) -- SchedFreq: the CPUFreq governor -- SchedTune: the central, scheduler-driven, power-perfomance control - -Tests targeting an evaluation of these frameworks requires also a set of -tracepoint which are not available in mainline kernel. The series of patches -required to add to a recent kernel the tracepoints required by some tests are -available on this git repository and branch: - - git://www.linux-arm.org/linux-pb.git lisa/debug - -The patches required are the ones in this series: - - git log --oneline lisa/debug_base..lisa/debug - -# Quickstart tutorial - -Once cloned, source init_env to initialized the LISA Shell, which provides -a convenient set of shell commands for easy access to many LISA related -functions. - -```shell -$ source init_env -``` - -To start the IPython Notebook Server required to use this Notebook, on a -LISAShell run: - -```shell -[LISAShell lisa] \> lisa-ipython start - -Starting IPython Notebooks... -Starting IPython Notebook server... - IP Address : http://127.0.0.1:8888/ - Folder : /home/derkling/Code/lisa/ipynb - Logfile : /home/derkling/Code/lisa/ipynb/server.log - PYTHONPATH : - /home/derkling/Code/lisa/libs/bart - /home/derkling/Code/lisa/libs/trappy - /home/derkling/Code/lisa/libs/devlib - /home/derkling/Code/lisa/libs/wlgen - /home/derkling/Code/lisa/libs/utils - - -Notebook server task: [1] 24745 -``` - -The main folder served by the server is: - http://127.0.0.1:8888/ - -Once the server is started you can have a look at the provide tutorial notebooks -are accessible by following (in your browser) this link: - - http://127.0.0.1:8888/notebooks/tutorial/00_LisaInANutshell.ipynp - -This intial tutorial can be seen (but not executed) also on GitHub: - - https://github.com/ARM-software/lisa/blob/master/ipynb/tutorial/00_LisaInANutshell.ipynb +* [Wiki Home page](https://github.com/ARM-software/lisa/wiki) +* [Installation](https://github.com/ARM-software/lisa/wiki/Installation) +* [Quickstart Tutorial](https://github.com/ARM-software/lisa/wiki/Quickstart-tutorial) # License