README

  Copyright(C) 2019, Institute for Defense Analyses
  4850 Mark Center Drive, Alexandria, VA; 703-845-2500
  This material may be reproduced by or for the US Government
  pursuant to the copyright license under the clauses at DFARS
  252.227-7013 and 252.227-7014.
 

  All rights reserved.
  
  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the copyright holder nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.
 
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  COPYRIGHT HOLDER NOR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  OF THE POSSIBILITY OF SUCH DAMAGE.


*******************************************************************************

BUILDING INSTRUCTIONS
    See the INSTALL file for a description of the components and instructions
    for building this package.

TESTING
    After installation, try ./runall.sh -c (#cores/node)

    This script will test all the "apps" on 1, 4, and 16 nodes and
    provide some timing information.  Don't take the timing data too
    seriously, as these are rather small runs.

DOCUMENTATION
    Run 'doxygen' in this directory and then point your browser at ./html/index.html
    Here is the beginning of the front page of the bale documentation. Please see
    the documentation for more!

    The bale effort is, first and foremost, a vehicle for discussion.
    Central to bale is a directory of "apps" that exhibit interesting
    communication patterns and programming demands. They allow us to
    test and exchange ideas with others. We hope the bale discussion
    can lead to improved programmer productivity (including existing
    and/or new programming models) and performance.

    - Part of bale is to keep revisiting the question of ``How would
    we like to write this code?''.
 
    - We think all of us want to write programs that are simple,
    elegant, and look like the algorithms they are implementing. In
    bale, we call this (obviously subjective) ideal the AGI model
    (``As God Intended''). For each app, we have included our current
    best effort at an AGI implementation -- this usually makes heavy
    use of single word gets and puts.
 
    - We want something worthy of being called AGI, but with an
    acceptable fraction of the ``gold standard'' (highest possible
    performing) implementation. bale purposely does not define
    "acceptable" or "performance". We want to shrink the gap and
    explore the continuim between high productivity and high
    performance. bale is not meant to be a benchmark.
 
    bale is released under the 3-clause BSD license to try to
    encourage others to join this discussion.


*******************************************************************************

#CHANGE HISTORY:
# bale 2.1.0 released August 2019
# - update conveyors to version 0.5.0
# bale 2.0.0 released December 2018
# Initial Release v 1.0.0 May 2018