General refactoring and updates (Bad)

LICENSE.md

@@ -1,7 +1,11 @@
 ************** Copyright © 2019, UChicago Argonne, LLC ***************
+
 All Rights Reserved
+
 Software Name: CO-Design of Exascale Storage and Network Architectures (CODES)
+
 By: Argonne National Laboratory, Rensselaer Polytechnic Institute, Lawrence Livermore National Laboratory, and Illinois Institute of Technology
+
 OPEN SOURCE LICENSE
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Makefile.am

@@ -22,7 +22,7 @@ pkgconfig_DATA = maint/codes.pc
 $(pkgconfig_DATA): config.status
 
 EXTRA_DIST += \
-  prepare.sh COPYRIGHT configure.ac uc-codes.cfg reformat.sh \
+  prepare.sh LICENSE.md configure.ac uc-codes.cfg reformat.sh \
   misc/README misc/ptrn_loggp-2.4.6.patch CONTRIBUTORS.md \
   README.md
 

README.md

@@ -1,12 +1,9 @@
 # CODES Discrete-event Simulation Framework
 
-https://github.com/codes-org/codes/wiki
+### New? Check out the Wiki for Installation, Tutorials, and Documentation: https://github.com/codes-org/codes/wiki
 
 Discrete event driven simulation of HPC system architectures and subsystems has emerged as a productive and cost-effective means to evaluating potential HPC designs, along with capabilities for executing simulations of extreme scale systems. The goal of the CODES project is to use highly parallel simulation to explore the design of exascale storage/network architectures and distributed data-intensive science facilities. 
 
 Our simulations build upon the Rensselaer Optimistic Simulation System (ROSS), a discrete event simulation framework that allows simulations to be run in parallel, decreasing the simulation run time of massive simulations to hours. We are using ROSS to explore topics including large-scale storage systems, I/O workloads, HPC network fabrics, distributed science systems, and data-intensive computation environments.
 
 The CODES project is a collaboration between the Mathematics and Computer Science department at Argonne National Laboratory and Rensselaer Polytechnic Institute. We collaborate with researchers at University of California at Davis to come up with novel methods for analysis and visualizations of large-scale event driven simulations. We also collaborate with Lawrence Livermore National Laboratory for modeling HPC interconnect systems.
-
-Documentation can be found in the wiki: 
-https://github.com/codes-org/codes/wiki

configure.ac

@@ -2,13 +2,9 @@
 # Process this file with autoconf to produce a configure script.
 
 AC_PREREQ([2.67])
-AC_INIT([codes], [1.1.0], [http://trac.mcs.anl.gov/projects/codes/newticket],[],[http://www.mcs.anl.gov/projects/codes/])
+AC_INIT([codes], [1.1.1], [http://trac.mcs.anl.gov/projects/codes/newticket],[],[http://www.mcs.anl.gov/projects/codes/])
 LT_INIT
 
-
-#WRAP SOME OPTION AROUND THIS - IT'S NOT REQUIRED FOR 99% OF CODES
-AX_BOOST_BASE([1.66])
-
 AC_CANONICAL_TARGET
 AC_CANONICAL_SYSTEM
 AC_CANONICAL_HOST
@@ -20,8 +16,8 @@ m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])])
 AC_CONFIG_SRCDIR([doc/BUILD_STEPS])
 AC_CONFIG_HEADERS([codes_config.h])
 
-AX_PROG_BISON([],[AC_MSG_WARN([Could not find bison])])
-AX_PROG_FLEX([],[AC_MSG_WARN([Could not find flex])])
+AX_PROG_BISON([],[AC_MSG_ERROR([could not find required package bison])])
+AX_PROG_FLEX([],[AC_MSG_ERROR([could not find required package flex])])
 AC_SUBST([BISON])
 AC_SUBST([FLEX])
 
@@ -124,6 +120,7 @@ AC_ARG_WITH([online],[AS_HELP_STRING([--with-online@<:@=DIR@:>@],
                       [use_online=yes],[use_online=no])
 if test "x${use_online}" != "xno" ; then
     AM_CONDITIONAL(USE_ONLINE, true)
+    AX_BOOST_BASE([1.66])
     AX_CXX_COMPILE_STDCXX(11, noext, mandatory)
     PKG_CHECK_MODULES_STATIC([ARGOBOTS], [argobots], [],
                       [AC_MSG_ERROR([Could not find working argobots installation via pkg-config])])
@@ -232,5 +229,6 @@ AC_OUTPUT([maint/codes.pc])
 AC_OUTPUT([src/network-workloads/conf/dragonfly-custom/modelnet-test-dragonfly-1728-nodes.conf])
 AC_OUTPUT([src/network-workloads/conf/dragonfly-plus/modelnet-test-dragonfly-plus.conf])
 AC_OUTPUT([src/network-workloads/conf/dragonfly-dally/modelnet-test-dragonfly-dally.conf])
+AC_OUTPUT([doc/example/tutorial-ping-pong.conf])
 
 

doc/Makefile.subdir

@@ -2,8 +2,11 @@ noinst_PROGRAMS += \
  doc/example/example \
  doc/example_heterogeneous/example
 
+bin_PROGRAMS += doc/example/tutorial-synthetic-ping-pong
+
 doc_example_example_SOURCES = doc/example/example.c
 doc_example_heterogeneous_example_SOURCES = doc/example_heterogeneous/example.c
+doc_example_tutorial_synthetic_ping_pong_SOURCES = doc/example/tutorial-synthetic-ping-pong.c
 
 EXTRA_DIST += \
  doc/BUILD_STEPS \
@@ -15,6 +18,7 @@ EXTRA_DIST += \
  doc/codes-best-practices.tex \
  doc/Makefile \
  doc/example/example.conf \
+ doc/example/tutorial-ping-pong.conf \
  doc/example_heterogeneous/example.conf \
  doc/example_heterogeneous/example_torus.conf \
  doc/example_heterogeneous/README \

doc/example/tutorial-ping-pong.conf

@@ -0,0 +1,53 @@
+LPGROUPS
+{
+   MODELNET_GRP
+   {
+      repetitions="36";
+# name of this lp changes according to the model
+      nw-lp="2";
+# these lp names will be the same for dragonfly-custom model
+      modelnet_dragonfly_dally="2";
+      modelnet_dragonfly_dally_router="1";
+   }
+}
+PARAMS
+{
+# packet size in the network
+   packet_size="4096";
+   modelnet_order=( "dragonfly_dally","dragonfly_dally_router" );
+   # scheduler options
+   modelnet_scheduler="fcfs";
+# chunk size in the network (when chunk size = packet size, packets will not be
+# divided into chunks)
+   chunk_size="4096";
+# modelnet_scheduler="round-robin";
+# number of routers in group
+   num_routers="4";
+# number of groups in the network
+   num_groups="9";
+# buffer size in bytes for local virtual channels
+   local_vc_size="16384";
+#buffer size in bytes for global virtual channels
+   global_vc_size="16384";
+#buffer size in bytes for compute node virtual channels
+   cn_vc_size="32768";
+#bandwidth in GiB/s for local channels
+   local_bandwidth="2.0";
+# bandwidth in GiB/s for global channels
+   global_bandwidth="2.0";
+# bandwidth in GiB/s for compute node-router channels
+   cn_bandwidth="2.0";
+# ROSS message size
+   message_size="736";
+# number of compute nodes connected to router, dictated by dragonfly config
+# file
+   num_cns_per_router="2";
+# number of global channels per router
+   num_global_channels="2";
+# network config file for intra-group connections
+   intra-group-connections="../src/network-workloads/conf/dragonfly-dally/dfdally-72-intra";
+# network config file for inter-group connections
+   inter-group-connections="../src/network-workloads/conf/dragonfly-dally/dfdally-72-inter";
+# routing protocol to be used
+   routing="prog-adaptive";
+}

doc/example/tutorial-ping-pong.conf.in

@@ -0,0 +1,53 @@
+LPGROUPS
+{
+   MODELNET_GRP
+   {
+      repetitions="36";
+# name of this lp changes according to the model
+      nw-lp="2";
+# these lp names will be the same for dragonfly-custom model
+      modelnet_dragonfly_dally="2";
+      modelnet_dragonfly_dally_router="1";
+   }
+}
+PARAMS
+{
+# packet size in the network
+   packet_size="4096";
+   modelnet_order=( "dragonfly_dally","dragonfly_dally_router" );
+   # scheduler options
+   modelnet_scheduler="fcfs";
+# chunk size in the network (when chunk size = packet size, packets will not be
+# divided into chunks)
+   chunk_size="4096";
+# modelnet_scheduler="round-robin";
+# number of routers in group
+   num_routers="4";
+# number of groups in the network
+   num_groups="9";
+# buffer size in bytes for local virtual channels
+   local_vc_size="16384";
+#buffer size in bytes for global virtual channels
+   global_vc_size="16384";
+#buffer size in bytes for compute node virtual channels
+   cn_vc_size="32768";
+#bandwidth in GiB/s for local channels
+   local_bandwidth="2.0";
+# bandwidth in GiB/s for global channels
+   global_bandwidth="2.0";
+# bandwidth in GiB/s for compute node-router channels
+   cn_bandwidth="2.0";
+# ROSS message size
+   message_size="736";
+# number of compute nodes connected to router, dictated by dragonfly config
+# file
+   num_cns_per_router="2";
+# number of global channels per router
+   num_global_channels="2";
+# network config file for intra-group connections
+   intra-group-connections="@abs_srcdir@/../../src/network-workloads/conf/dragonfly-dally/dfdally-72-intra";
+# network config file for inter-group connections
+   inter-group-connections="@abs_srcdir@/../../src/network-workloads/conf/dragonfly-dally/dfdally-72-inter";
+# routing protocol to be used
+   routing="prog-adaptive";
+}