OpenMP explorer and supporting changes

* Change PRV class to allow lazy loading of the prv data
* Some refactoring to use PRV class for all PRVTrace Metadata operations

Author: ptooley

MANIFEST.in

@@ -6,3 +6,4 @@ recursive-include pypop/cfgs *
 recursive-include pypop/cutters *
 recursive-include pypop/filters *
 global-exclude */.ipynb_checkpoints/*
+global-exclude */*.bincache

README.md

@@ -10,7 +10,7 @@ additional formats.
 
 ## Requirements
 
-  * [Extrae] (for trace creation)
+  * [Extrae] (for trace capture)
   * [Paraver/Paramedir] (for trace analysis)
   * [Dimemas] *optional* (for ideal network analysis)
   * [Numpy]
@@ -28,7 +28,7 @@ additional formats.
 
 ## Installation
 
-Install using pip:
+PyPOP itself can be installed using the `pip` package manager:
 
 ```bash
 $ pip install [--user] NAG-PyPOP
@@ -40,6 +40,9 @@ system site package directory.
 **N.B: Some linux distributions are still shipping Python2 alongside Python3. PyPOP requires
 Python3 and so you may need to install using the `pip3` command rather than the `pip` command.**
 
+Note that the [Extrae] tool is needed to collect application traces and the [Paraver/Paramedir] and
+[Dimemas] tools must be installed for trace Analysis.
+
 ## Usage
 
 Jupyter notebooks are intended to be the primary interface to PyPOP.  This guide uses several

pypop/dimemas.py

@@ -19,7 +19,7 @@
 
 from pkg_resources import resource_filename
 
-from .prv import _parse_paraver_headerline
+from .prv import PRV
 from .utils.io import zipopen
 from .extrae import remove_trace
 from . import config
@@ -46,13 +46,12 @@ def dimemas_idealise(tracefile, outpath=None):
     """
 
     # First we need the application layout info
-    with zipopen(tracefile, "rt") as fh:
-        metadata = _parse_paraver_headerline(fh.readline().strip())
+    metadata = PRV(tracefile, lazy_load=True).metadata
 
     # Populate run specfic config data
     subs = {
-        "@NUM_NODES@": metadata.application_layout.commsize,
-        "@PROCS_PER_NODE@": max(metadata.procs_per_node),
+        "@NUM_NODES@": metadata.num_processes,
+        "@PROCS_PER_NODE@": max(metadata.cores_per_node),
         "@RANKS_PER_NODE@": 1,
         "@COLLECTIVES_PATH@": IDEAL_COLL_PATH,
     }

pypop/examples/mpi/MPI Metrics Example.ipynb

@@ -0,0 +1,52 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "hide_input": true
+   },
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "from pypop.notebook_interface import MetricsWizard\n",
+    "from pypop.metrics import MPI_Metrics\n",
+    "\n",
+    "tracedir=\"./epoch_example_traces\"\n",
+    "gui = MetricsWizard(MPI_Metrics,\n",
+    "                    starting_files=[os.path.join(tracedir, x)\n",
+    "                                    for x in os.listdir(tracedir)\n",
+    "                                    if x.endswith(\".prv.gz\")])\n",
+    "display(gui)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.8.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}