Add Release Notes for 17.02.

Update year in LICENSE.
Update README.
Remove SOURCEME script.

CMakeLists.txt

@@ -4,8 +4,8 @@ project (STINGER)
 include (ExternalProject)
 include (CTest)
 
-set(STINGER_VERSION_MAJOR 2015)
-set(STINGER_VERSION_MINOR 10)
+set(STINGER_VERSION_MAJOR 2017)
+set(STINGER_VERSION_MINOR 02)
 
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/lib)
@@ -47,7 +47,8 @@ ENDIF()
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu9x")
 
 # Doxygen
-if(BUILD_DOCUMENTATION)
+option(BUILD_DOCUMENTATION "Use Doxygen to create the HTML based API documentation" OFF)
+if (BUILD_DOCUMENTATION)
   find_package(Doxygen)
   if (DOXYGEN_FOUND)
     configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen/Doxyfile.in

LICENSE

@@ -1,7 +1,7 @@
-Libraries in /external are the right of their respective owners.  
+Libraries in /external and /lib are the right of their respective owners.  
 
 STINGER
-Copyright (c) 2009-2015 Georgia Institute of Technology
+Copyright (c) 2009-2017 Georgia Institute of Technology
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without 

README.md

@@ -13,8 +13,6 @@ STINGER is a package designed to support streaming graph analytics by using in-m
     doc/ - Documentation
     doxygen/ - Doxygen generated documentation
     external/ - External dependencies packaged with STINGER
-    flask/ - Python Flask Relay Server for interacting with the JSON RPC server and STINGER server
-    html/ - Basic web pages that communicate with the JSON RPC server
     lib/ - The STINGER library and dependencies
         stinger_alg/ - Algorithm kernels that work on the STINGER data structure
         stinger_core/ - The Core STINGER data structure
@@ -27,18 +25,20 @@ STINGER is a package designed to support streaming graph analytics by using in-m
             streams/ - Binaries for streaming in new data
             tools/ - Auxiliary tools
         py/stinger - Python bindings to STINGER
-        standalone/ - Standalone binaries that use the STINGER core data structure
         templates/json - Common templates for stream ingest
         tests/ - Tests for the STINGER data structure and algorithms
-    SOURCEME.sh - File to be executed from out-of-source build directory to link the html/ web pages with the STINGER server
+    util/ -
+        flask/ - Python Flask Relay Server for interacting with the JSON RPC server and STINGER server
+        graph_explorer/ - Sample web pages for interacting with JSON RPC server
+        management/ - Web app for monitoring STINGER server
+        stingerctl - Control script for starting and stopping STINGER server, algorithms, and clients
 
 Building
 ========
 
 STINGER is built using [CMake](http://www.cmake.org).  From the root of STINGER, first create a build directory:
 
     mkdir build && cd build
-    . ../SOURCEME.sh
 
 Then call CMake from that build directory to automatically configure the build and to create a Makefile:
 
@@ -52,15 +52,11 @@ Note: the -j flag is a multi-threaded build.  Typically you should match the arg
 
 All binary targets will be built and placed in build/bin.  They are named according to the folder from which they were 
 built (so src/bin/server produces build/bin/stinger\_server, src/bin/clients/tools/json\_rpc\_server produces 
-build/bin/stinger\_json\_rpc\_server, etc.).  If you ran SOURCEME.sh from the build directory as instructed above, the build/bin
-directory is appended to your path.
+build/bin/stinger\_json\_rpc\_server, etc.).
 
 Executable Targets
 ==================
 
-As indicated by the directory structure, there are three primary types of executable targets: clients, server, and standalone, 
-and subtypes in the case of clients.
-
 The STINGER server maintains a STINGER graph in memory and can maintain multiple connections with client streams, algorithms, and monitors.
 
 Client streams can send edges consisting of source, destination, weight, time, and type where some fields are optional 
@@ -74,14 +70,10 @@ The server guarantees that all of an algorithm's dependencies will finish proces
 Clients algorithms are required to provide a description string that indicates what data is stored and the type of the data.  
 
 Client tools are intended to be read-only, but are notified of all running algorithms and shared data.  An example
-of this kind of client is the JSON-RPC server (src/bin/clients/tools/json\_rpc\_server).  This server provides access
+of this kind of client is the JSON-RPC server (src/clients/tools/json\_rpc\_server).  This server provides access
 to shared algorithm data via JSON-RPC calls over HTTP.  Additionally, some primitive operations are provided to support
 selecting the top vertices as scored by a particular algorithm or obtaining the shortest paths between two vertices, for example.
 
-Standalone executables are generally self-contained and use the STINGER
-libraries for the graph structure and supporting functions.  Most of the existing standalone executables demonstrate
-a single streaming or static algorithm on a synthetic R-MAT graph and edge stream.
-
 Running
 =======
 
@@ -96,8 +88,8 @@ To run an example using the server and five terminals:
     term5:build$ ./bin/stinger_rmat_edge_generator -n 100000 -x 10000
 
 This will start a stream of R-MAT edges over 100,000 vertices in batches of 10,000 edges.  A connected component labeling
-and PageRank scoring will be maintained.  The JSON-RPC server will host interactive web pages at 
-http://localhost:8088/full.html are powered by the live streaming analysis.  The total memory usage of the dynamic graph is limited to 1 GiB.
+and PageRank scoring will be maintained.  The JSON-RPC server will host an endpoint at http://localhost:8088/json-rpc
+The total memory usage of the dynamic graph is limited to 1 GiB.
 
 Server Configuration
 --------------------
@@ -228,13 +220,6 @@ This file would create edges between email addresses using the length field as t
     cat emails.csv | ./bin/stinger_csv_stream template.csv
 
 Please be aware that the CSV parser and the underlying code to parse CSV files does not currently trim whitespace, and does not treat quoted strings of any kind as quoted.
-
-Using a Standalone Client
--------------------------
-To create a toy R-MAT graph (256K vertices and 2M undirected edges) and run the insert-remove benchmark:
-
-    term1:build$ stinger_rmat_graph_generator -s 18 -e 8 -n 100000
-    term1:build$ stinger_insert_remove_benchmark -n 1 -b 100000 g.18.8.bin a.18.8.100000.bin
 
 
 [![githalytics.com alpha](https://cruel-carlota.pagodabox.com/a7d82e7aa670122314238336dbbd7c89 "githalytics.com")](http://githalytics.com/robmccoll/stinger)
@@ -248,7 +233,7 @@ Runtime Issues
 STINGER allocates and manages its own memory. When STINGER starts, it allocates one large block of memory (enough to hold its maximum size), and then manages its own memory allocation from that pool.  The server version of STINGER does this in shared memory so that multiple processes can see the graph.  Unfortunately, the error handling for memory allocations is not particularly user-friendly at the moment.  Changing the way that this works is on the issues list (see https://github.com/robmccoll/stinger/issues/8).
 
 - "Bus error" when running the server: The size of STINGER that the server is trying to allocate is too large for your memory.  First try to increase the size of your /dev/shm (See below).  If this does not work reduce the size of your STINGER and recompile.
-- "XXX: eb pool exhausted" or "STINGER has run out of internal storage space" when running the server, standalone executables, or anything else using stinger\_core: you have run out of internal edge storage.  Increase the size of STINGER and recompile.
+- "XXX: eb pool exhausted" or "STINGER has run out of internal storage space" when running the server: you have run out of internal edge storage.  Increase the size of STINGER and recompile.
 
 See the section on STINGER server configuration to adjust the sizing of STINGER
 

ReleaseNotes.md

@@ -4,6 +4,29 @@ Release Notes
 Version
 -------
 
+These notes are for STINGER version 17.02
+
+Notes
+-----
+
+- CMake fixes for TravisCI
+- Added edge direction to STINGER
+- Traversal macros refactored for reduced code
+- Broken symlinks fixed
+- Security and bug fixes
+- Removed Cray MTA/XMT support
+- New algorithm client for Streaming Connected Components
+- New HTTP API endpoint for adding edge weight
+- Fixed stingerctl script
+- New algorithms for HITS, graph diameter, independent set, shortest path, and graph partitioning
+- Changes to full/empty libraries for POWER8 support
+- New parallel algorithm for inserting a batch of edges
+- Use system Protocol Buffers library if installed
+- Upgraded distributed of Protocol Buffers to 3.1.0
+
+Version
+-------
+
 These notes are for STINGER version 15.10
 
 Notes