Initial OSU draft

docs/71_omb/omb.rst

@@ -4,52 +4,71 @@ OSU Microbenchmarks
 
 https://mvapich.cse.ohio-state.edu/download/mvapich/osu-micro-benchmarks-7.2.tar.gz
 
+
 Purpose
 =======
 
+The OSU Microbenchmarks (OMB) are widely used to measure and evaluate the performance of MPI operations for point-to-oiint, multi-pair, collective, and one-sided communications.
 
 Characteristics
 ===============
 
-Problems
---------
+* Official site: `OSUMB <https://mvapich.cse.ohio-state.edu/download/mvapich/osu-micro-benchmarks-7.2.tar.gz>`_
 
-Figure of Merit
----------------
+Problem
+-------
 
+The OSU benchmarks are a suite of microbenchmarks designed to measure network characteristics on HPC systems.
 
 Source code modifications
 =========================
 
 Please see :ref:`GlobalRunRules` for general guidance on allowed modifications. 
 
+
 Building
 ========
 
+On GPU enabled systems add these flags to the following configure lines: 
 
-Running
-=======
+.. code-block:: bash
 
+    --enable-cuda
+    --with-cuda-include=/path/to/cuda/include
+    --with-cuda-libpath=/path/to/cuda/lib
 
-Validation
-==========
+Build and install the benchmarks.
 
+.. code-block:: bash
 
-Example Scalability Results
-===========================
+    ./configure --prefix=$INSTALL_DIR
+    make -j 
+    make -j install
 
 
-Memory Usage
-============
+Before configuring make sure your CXX and CC environment variables are set to an 
+MPI compiler or wrapper. 
+On most systems this will look like:
 
+.. code-block:: bash
 
-Strong Scaling on El Capitan
-============================
+    export CC=mpicc CXX=mpicxx
+
+On systems with vendor provided wrappers it may look different. 
+For example, on HPE-Cray systems:
+
+.. code-block:: bash
+
+    export CC=cc CXX=CC
+
+Running
+=======
 
+For any GPU enabled system, please also include the GPU variants of the following benchmarks.
 
-Weak Scaling on El Capitan
-==========================
 
+Scaling on El Capitan
+=====================
 
 References
 ==========