Merge pull request ARM-software#219 from ionela-voinescu/notebook_res…

…tructure Notebook restructure: Examples
valschneider · Dec 13, 2016 · 92f159e · 92f159e
2 parents ceafdb7 + aae360a
commit 92f159e
Show file tree

Hide file tree

Showing 27 changed files with 9,193 additions and 8,148 deletions.
diff --git a/ipynb/android/Android_Workloads.ipynb b/ipynb/android/Android_Workloads.ipynb
diff --git a/ipynb/android/benchmarks/Android_PCMark.ipynb b/ipynb/android/benchmarks/Android_PCMark.ipynb
diff --git a/ipynb/android/workloads/Android_Recents_Fling.ipynb b/ipynb/android/workloads/Android_Recents_Fling.ipynb
diff --git a/ipynb/android/workloads/Android_YouTube.ipynb b/ipynb/android/workloads/Android_YouTube.ipynb
diff --git a/ipynb/devlib/examples/cgroups.ipynb b/ipynb/devlib/examples/cgroups.ipynb
diff --git a/ipynb/examples/android/benchmarks/Android_Jankbench.ipynb b/ipynb/examples/android/benchmarks/Android_Jankbench.ipynb
diff --git a/ipynb/examples/android/benchmarks/Android_PCMark.ipynb b/ipynb/examples/android/benchmarks/Android_PCMark.ipynb
diff --git a/ipynb/examples/android/workloads/Android_Recents_Fling.ipynb b/ipynb/examples/android/workloads/Android_Recents_Fling.ipynb
diff --git a/ipynb/examples/android/workloads/Android_Workloads.ipynb b/ipynb/examples/android/workloads/Android_Workloads.ipynb
diff --git a/ipynb/examples/android/workloads/Android_YouTube.ipynb b/ipynb/examples/android/workloads/Android_YouTube.ipynb
diff --git a/ipynb/examples/devlib/cgroups_example.ipynb b/ipynb/examples/devlib/cgroups_example.ipynb
diff --git a/ipynb/examples/energy_meter/EnergyMeter_ACME.ipynb b/ipynb/examples/energy_meter/EnergyMeter_ACME.ipynb
@@ -4,33 +4,42 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "<font size=\"8\">Energy Meter Examples</font>\n",
-    "<br>\n",
-    "<font size=\"5\">BayLibre's ACME Cape and IIOCapture</font>\n",
-    "<br>\n",
-    "<hr>"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Import Required Modules"
+    "# Energy Meter Examples\n",
+    "\n",
+    "## BayLibre's ACME Cape and IIOCapture\n",
+    "\n",
+    "More information can be found at https://github.com/ARM-software/lisa/wiki/Energy-Meters-Requirements#iiocapture---baylibre-acme-cape."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 1,
    "metadata": {
-    "collapsed": true
+    "collapsed": false
    },
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "2016-12-08 12:39:45,242 INFO    : root         : Using LISA logging configuration:\n",
+      "2016-12-08 12:39:45,243 INFO    : root         :   /home/vagrant/lisa/logging.conf\n"
+     ]
+    }
+   ],
    "source": [
     "import logging\n",
     "from conf import LisaLogging\n",
     "LisaLogging.setup()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Import required modules"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 2,
@@ -56,7 +65,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Target Configuration"
+    "## Target Configuration\n",
+    "The target configuration is used to describe and configure your test environment.\n",
+    "You can find more details in **examples/utils/testenv_example.ipynb**."
    ]
   },
   {
@@ -155,7 +166,13 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Workload Execution and Power Consumptions Samping"
+    "## Workload Execution and Power Consumptions Samping\n",
+    "\n",
+    "Detailed information on RTApp can be found in **examples/wlgen/rtapp_example.ipynb**.\n",
+    "\n",
+    "Each **EnergyMeter** derived class has two main methods: **reset** and **report**.\n",
+    " - The **reset** method will reset the energy meter and start sampling from channels specified in the target configuration. <br>\n",
+    " - The **report** method will stop capture and will retrieve the energy consumption data. This returns an EnergyReport composed of the measured channels energy and the report file. Each of the samples can also be obtained, as you can see below."
    ]
   },
   {
@@ -273,7 +290,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Power Measurements Data"
+    "## Power Measurements Data"
    ]
   },
   {
@@ -469,7 +486,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython2",
-   "version": "2.7.9"
+   "version": "2.7.6"
   },
   "toc": {
    "toc_cell": false,

diff --git a/ipynb/examples/energy_meter/EnergyMeter_AEP.ipynb b/ipynb/examples/energy_meter/EnergyMeter_AEP.ipynb
@@ -4,42 +4,42 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "<font size=\"8\">Energy Meter Examples</font>\n",
-    "<br>\n",
-    "<font size=\"5\">ARM Energy Probe</font>\n",
-    "<br>\n",
-    "<hr>"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "This notebook shows how to use the `AEP` energy meters.\n",
+    "# Energy Meter Examples\n",
     "\n",
-    "*NOTE*: `caiman` is required to collect data from the probe. Instructions on how to install it can be found here https://github.com/ARM-software/lisa/wiki/Energy-Meters-Requirements#arm-energy-probe-aep"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Import Required Modules"
+    "## ARM Energy Probe\n",
+    "\n",
+    "*NOTE*: `caiman` is required to collect data from the probe. Instructions on how to install it can be found here https://github.com/ARM-software/lisa/wiki/Energy-Meters-Requirements#arm-energy-probe-aep."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 1,
    "metadata": {
-    "collapsed": true
+    "collapsed": false
    },
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "2016-12-08 12:40:07,000 INFO    : root         : Using LISA logging configuration:\n",
+      "2016-12-08 12:40:07,000 INFO    : root         :   /home/vagrant/lisa/logging.conf\n"
+     ]
+    }
+   ],
    "source": [
     "import logging\n",
     "from conf import LisaLogging\n",
     "LisaLogging.setup()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Import required modules"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 2,
@@ -65,7 +65,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Target Configuration"
+    "## Target Configuration\n",
+    "The target configuration is used to describe and configure your test environment.\n",
+    "You can find more details in **examples/utils/testenv_example.ipynb**."
    ]
   },
   {
@@ -163,7 +165,13 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Workload Execution and Power Consumptions Samping"
+    "## Workload Execution and Power Consumptions Samping\n",
+    "\n",
+    "Detailed information on RTApp can be found in **examples/wlgen/rtapp_example.ipynb**.\n",
+    "\n",
+    "Each **EnergyMeter** derived class has two main methods: **reset** and **report**.\n",
+    " - The **reset** method will reset the energy meter and start sampling from channels specified in the target configuration. <br>\n",
+    " - The **report** method will stop capture and will retrieve the energy consumption data. This returns an EnergyReport composed of the measured channels energy and the report file. Each of the samples can also be obtained, as you can see below."
    ]
   },
   {
@@ -275,7 +283,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Power Measurements Data"
+    "## Power Measurements Data"
    ]
   },
   {

diff --git a/ipynb/examples/energy_meter/EnergyMeter_HWMON.ipynb b/ipynb/examples/energy_meter/EnergyMeter_HWMON.ipynb
@@ -4,33 +4,42 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "<font size=\"8\">Energy Meter Examples</font>\n",
-    "<br>\n",
-    "<font size=\"5\">Linux Kernel HWMon</font>\n",
-    "<br>\n",
-    "<hr>"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Import Required Modules"
+    "# Energy Meter Examples\n",
+    "\n",
+    "## Linux Kernel HWMon\n",
+    "\n",
+    "More details can be found at https://github.com/ARM-software/lisa/wiki/Energy-Meters-Requirements#linux-hwmon."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 1,
    "metadata": {
-    "collapsed": true
+    "collapsed": false
    },
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "2016-12-08 12:40:25,090 INFO    : root         : Using LISA logging configuration:\n",
+      "2016-12-08 12:40:25,091 INFO    : root         :   /home/vagrant/lisa/logging.conf\n"
+     ]
+    }
+   ],
    "source": [
     "import logging\n",
     "from conf import LisaLogging\n",
     "LisaLogging.setup()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Import required modules"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 2,
@@ -56,7 +65,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Target Configuration"
+    "## Target Configuration\n",
+    "The target configuration is used to describe and configure your test environment.\n",
+    "You can find more details in **examples/utils/testenv_example.ipynb**."
    ]
   },
   {
@@ -152,7 +163,13 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Workload Execution and Power Consumptions Samping"
+    "## Workload Execution and Power Consumptions Samping\n",
+    "\n",
+    "Detailed information on RTApp can be found in **examples/wlgen/rtapp_example.ipynb**.\n",
+    "\n",
+    "Each **EnergyMeter** derived class has two main methods: **reset** and **report**.\n",
+    " - The **reset** method will reset the energy meter and start sampling from channels specified in the target configuration. <br>\n",
+    " - The **report** method will stop capture and will retrieve the energy consumption data. This returns an EnergyReport composed of the measured channels energy and the report file. Each of the samples can also be obtained, as you can see below."
    ]
   },
   {
@@ -266,7 +283,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Power Measurements Data"
+    "## Power Measurements Data"
    ]
   },
   {