HOTI Workshop Tutorials and Doc Updates

.travis.yml

@@ -20,7 +20,7 @@ install:
     popd
   # Install CODES
   - |
-    git clone https://xgitlab.cels.anl.gov/codes/codes.git ${TRAVIS_BUILD_DIR}/ci-build-deps/CODES
+    git clone https://github.com/codes-org/codes.git ${TRAVIS_BUILD_DIR}/ci-build-deps/CODES
     pushd ${TRAVIS_BUILD_DIR}/ci-build-deps/CODES
     ./prepare.sh
     mkdir build

docs/code-examples/scorep_user_calls.c

@@ -6,20 +6,28 @@ int main(int argc, char **argv, char **envp)
   SCOREP_RECORDING_OFF(); //turn recording off for initialization/regions not of interest
   ...
   SCOREP_RECORDING_ON();
+
   //use verbatim to facilitate looping over the traces in simulation when simulating multiple jobs
   SCOREP_USER_REGION_BY_NAME_BEGIN("TRACER_Loop", SCOREP_USER_REGION_TYPE_COMMON); 
   // at least add this BEGIN timer call - called from only one rank
   // you can add more calls later with region names TRACER_WallTime_<any string of your choice>
+
   if(myRank == 0)
-    SCOREP_USER_REGION_BY_NAME_BEGIN("TRACER_WallTime_MainLoop", SCOREP_USER_REGION_TYPE_COMMON);
+    SCOREP_USER_REGION_BY_NAME_BEGIN("TRACER_WallTime_Loop", SCOREP_USER_REGION_TYPE_COMMON);
+
   // Application main work LOOP
   for ( int itscf = 0; itscf < nitscf_; itscf++ )
   {
+    // time call to mark start of loop iteration
+    SCOREP_USER_REGION_BY_NAME_BEGIN("TRACER_WallTime_Loop_Iter", SCOREP_USER_REGION_TYPE_COMMON);
     ...
+    SCOREP_USER_REGION_BY_NAME_END("TRACER_WallTime_Loop_Iter");
   }
+
   // time call to mark END of work - called from only one rank
   if(myRank == 0)
-    SCOREP_USER_REGION_BY_NAME_END("TRACER_WallTime_MainLoop");
+    SCOREP_USER_REGION_BY_NAME_END("TRACER_WallTime_Loop");
+
   // use verbatim - mark end of trace loop
   SCOREP_USER_REGION_BY_NAME_END("TRACER_Loop"); 
   SCOREP_RECORDING_OFF();//turn off recording again

docs/index.rst

@@ -13,10 +13,11 @@ Computing applications on interconnection networks.
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: Contents
 
    install
    userguide
+   workflow
    tutorial
    autogen/doxygen
 

docs/install.rst

@@ -6,7 +6,7 @@ TraceR can be downloaded from `GitHub <https://github.com/LLNL/TraceR>`_.
 Dependencies
 ------------
 
-TraceR depends on `CODES <https://xgitlab.cels.anl.gov/codes/codes>`_ and `ROSS <https://github.com/ROSS-org/ROSS>`_.
+TraceR depends on `CODES <https://github.com/codes-org/codes>`_ and `ROSS <https://github.com/ROSS-org/ROSS>`_.
 
 Build
 -----
@@ -42,5 +42,5 @@ TraceR supports two different trace formats as input. For each format, you need
 2. AMPI-based BigSim format: To use BigSim traces as input to TraceR, you need to download and build `Charm++ <https://github.com/UIUC-PPL/charm>`_.
 
 The instructions to build Charm++ are in the `Charm++ manual
-<http://charm.cs.illinois.edu/manuals/html/charm++/A.html>`_. You should use
+<https://charm.readthedocs.io/en/latest/charm++/manual.html#installing-charm>`_. You should use
 the "charm++" target and pass "bigemulator" as a build option.

docs/tutorial.rst

@@ -1,2 +1,35 @@
+.. _tutorial:
+
 Tutorial
 ========
+
+.. rubric:: Slides
+
+.. figure:: tutorial/hoti25-slide-preview.png
+   :target: http://www.hoti.org/tutorials/HOTI25_Tutorial_2c.pdf
+   :height: 72px
+   :align: left
+   :alt: Slide preview
+
+`Download Slides <http://www.hoti.org/tutorials/HOTI25_Tutorial_2c.pdf>`_.
+
+**Full citation:** Nikhil Jain and Misbah Mubarak.
+CODES-TRACER Tutorial: Enabling HPC Design Space
+Exploration via Discrete-Event Simulation.
+Tutorial presented at 25th Annual Symposium on High Performance
+Interconnects (HOTI). Aug 28, 2017, Santa Clara, CA, USA.
+
+.. rubric:: Guides
+
+These guides will give some of the basics needed to use TraceR.
+
+    1. :ref:`tutorial-network-models`
+    2. :ref:`tutorial-simulation-basics`
+    3. :ref:`tutorial-workflow`
+
+Full contents:
+
+.. toctree::
+   tutorial/network_models
+   tutorial/simulation_basics
+   tutorial/workflow