- updated CREDITS.txt and RELEASE.txt for Snap.py 6.0

roks · roks · commit 6f8959ef6d93 · 2020-12-24T15:17:13.000-08:00
- made minor edits in the documentation
diff --git a/CREDITS.txt b/CREDITS.txt
@@ -9,17 +9,25 @@ of Python. Most of the SNAP functionality is available via Snap.py in Python.
 
 The following people contributed to the development of Snap.py (in
 alphabetical order):
+Ruth-Ann Armstrong
 Roger Chen
+Benoît Coste
 Carlos Hernandez
+Jihun Hong
 Farzaan Kaiyom
+Viswesh Krishna
+Daiki Kumazawa
 Jure Leskovec
 Stephen Macke
 Ben Pastel
 Karthik Ramachandran
 Sheila Ramaswamy
+Avery Rogers
 Nicholas Shelly
 Rok Sosic
 Ming Han Teh
+Cameron Tew
+Albert Zheng
 
 Special thanks go to the students in the 2013 class of CS224W at Stanford
 University, who helped with the initial version of the manuals and the beta
diff --git a/RELEASE.txt b/RELEASE.txt
@@ -1,5 +1,5 @@
-Snap.py 5.0 Release Notes
-August 2019
+Snap.py 6.0 Release Notes
+December 2020
 
 Snap.py is a Python interface for SNAP (Stanford Network Analysis Platform).
 SNAP is a general purpose, high performance system for analysis and
@@ -9,7 +9,40 @@ to massive networks with hundreds of millions of nodes, and billions of edges.
 Snap.py provides performance benefits of SNAP, combined with flexibility
 of Python. Most of the SNAP functionality is available via Snap.py in Python.
 
-This file contains a high-level description of changes in Snap.py releases.
+Snap.py 6.0 is a major release with a large number of new features, most
+notably a significantly improved way to call Snap.py functions in Python, a
+NetworkX compatibility layer, standard Python functions to handle SNAP vector
+and hash types, new functions for egonets and graph union, and a completely
+revised package building infrastructure. These enhancements are backward
+compatible, so existing Snap.py based programs should continue to work.
+
+A high-level description of changes in Snap.py releases is provided below.
+
+Release 6.0.0, Dec 28, 2020
+
+- implemented pylayer, a significantly improved way to call SNAP C++ functions
+  - standalone functions are available as class methods
+  - built-in Python classes (lists, dictionaries) can be provided as parameters
+  - results are available as return values rather than as reference parameters
+  - support for optional parameters has been enhanced
+- implemented SnapX, a NetworkX compatible graph manipulation layer, as a
+  module within Snap.py
+- implemented standard Python interface functions for SNAP vector and hash
+  types to be compatible with Python lists and dictionaries
+- implemented new functions to calculate egonets, GetEgonet, GetEgonetHop,
+  GetInEgonetHop, GetOutEgonetHop, GetInEgonetSub
+- implemented new functions to perform graph union, GetGraphUnion,
+  GetGraphUnionAttr
+- added Dockerfile to containerize a release
+- replaced setup.py with a completely new implementation
+- added scripts for building wheel packages on macOS, Linux and Windows
+- performed a large number of updates in Makefiles
+- performed a major rewrite and extensions of the Snap.py documentation
+- expanded functionality tests
+- added a program to test the speed of various methods for writing and
+  reading a graph
+- fixed formatting problems in creating the documentation with Sphinx
+- added hellotest, a simple module to test the building of Python C/C++
 
 Release 5.0.0, Aug 30, 2019
 
diff --git a/doc/source/reference/CntInDegNodes-swig.rst b/doc/source/reference/CntInDegNodes-swig.rst
@@ -1,5 +1,5 @@
 CntInDegNodes (SWIG)
-''''''''''''''''''''''''''
+''''''''''''''''''''
 
 .. function:: CntInDegNodes(Graph, NodeInDeg)
    :noindex:
diff --git a/doc/source/reference/CntInDegNodes.rst b/doc/source/reference/CntInDegNodes.rst
@@ -1,5 +1,5 @@
 CntInDegNodes
-'''''''''''''''''''
+'''''''''''''
 
 .. function:: CntInDegNodes(NodeInDeg)
 
diff --git a/doc/source/reference/CntOutDegNodes-swig.rst b/doc/source/reference/CntOutDegNodes-swig.rst
@@ -1,5 +1,5 @@
 CntOutDegNodes (SWIG)
-''''''''''''''''''''''''''
+'''''''''''''''''''''
 
 .. function:: CntOutDegNodes(Graph, NodeOutDeg)
    :noindex:
diff --git a/doc/source/reference/CntOutDegNodes.rst b/doc/source/reference/CntOutDegNodes.rst
@@ -1,5 +1,5 @@
 CntOutDegNodes
-'''''''''''''''''''
+''''''''''''''
 
 .. function:: CntOutDegNodes(NodeOutDeg)
 
diff --git a/doc/source/reference/DrawGViz-swig.rst b/doc/source/reference/DrawGViz-swig.rst
@@ -1,5 +1,5 @@
 DrawGViz (SWIG)
-''''''''''''''''''
+'''''''''''''''
 
 .. function:: DrawGViz(Graph, Layout, PltFNm, Desc=TStr(), NodeLabels=False, NIdColorH=TIntStrH())
    :noindex:
diff --git a/doc/source/reference/DrawGViz1-swig.rst b/doc/source/reference/DrawGViz1-swig.rst
@@ -1,5 +1,5 @@
 DrawGViz (SWIG)
-''''''''''''''''''
+'''''''''''''''
 
 .. function:: DrawGViz(Graph, Layout, PltFNm, Desc, NodeLabelH)
    :noindex:
diff --git a/doc/source/reference/GenGrid-swig.rst b/doc/source/reference/GenGrid-swig.rst
@@ -1,5 +1,5 @@
 GenGrid (SWIG)
-''''''''''''''''''
+''''''''''''''
 
 .. function:: GenGrid(GraphType, Rows, Cols, IsDir=True)
    :noindex:
diff --git a/doc/source/reference/GenGrid.rst b/doc/source/reference/GenGrid.rst
@@ -1,5 +1,5 @@
 GenGrid
-'''''''''''
+'''''''
 
 .. function:: GenGrid(GraphType, Rows, Cols, IsDir=True)
 
diff --git a/doc/source/reference/GenRewire-swig.rst b/doc/source/reference/GenRewire-swig.rst
@@ -1,5 +1,5 @@
 GenRewire (SWIG)
-''''''''''''''''''
+''''''''''''''''
 
 .. function:: GenRewire (Graph, NSwitch, Rnd=TRnd)
    :noindex:
diff --git a/doc/source/reference/GenRewire.rst b/doc/source/reference/GenRewire.rst
@@ -1,5 +1,5 @@
 GenRewire
-'''''''''''
+'''''''''
 
 .. function:: GenRewire (Graph, NSwitch, Rnd=TRnd)
 
diff --git a/doc/source/reference/GenStar-swig.rst b/doc/source/reference/GenStar-swig.rst
@@ -1,5 +1,5 @@
 GenStar (SWIG)
-''''''''''''''''''
+''''''''''''''
 
 .. function:: GenStar (GraphType, Nodes, IsDir=True)
    :noindex:
diff --git a/doc/source/reference/GenStar.rst b/doc/source/reference/GenStar.rst
@@ -1,5 +1,5 @@
 GenStar
-'''''''''''
+'''''''
 
 .. function:: GenStar (GraphType, Nodes, IsDir=True)
 
diff --git a/doc/source/reference/GenTree-swig.rst b/doc/source/reference/GenTree-swig.rst
@@ -1,5 +1,5 @@
 GenTree (SWIG)
-''''''''''''''''
+''''''''''''''
 
 .. function:: GenTree(GraphType, Fanout, Levels, IsDir=True, ChildPointsToParent=True)
    :noindex:
diff --git a/doc/source/reference/GenTree.rst b/doc/source/reference/GenTree.rst
@@ -1,5 +1,5 @@
 GenTree
-'''''''''
+'''''''
 
 .. function:: GenTree(GraphType, Fanout, Levels, IsDir=True, ChildPointsToParent=True)
 
diff --git a/doc/source/reference/Get1CnCom-swig.rst b/doc/source/reference/Get1CnCom-swig.rst
@@ -1,5 +1,5 @@
 Get1CnCom (SWIG)
-''''''''''''''''''
+''''''''''''''''
 
 .. function:: Get1CnCom(Graph, Cn1ComV)
    :noindex:
diff --git a/doc/source/reference/Get1CnCom.rst b/doc/source/reference/Get1CnCom.rst
@@ -1,5 +1,5 @@
 Get1CnCom
-'''''''''''
+'''''''''
 
 .. function:: Get1CnCom()
 
diff --git a/doc/source/reference/GetAnf-swig.rst b/doc/source/reference/GetAnf-swig.rst
@@ -1,5 +1,5 @@
 GetAnf (SWIG)
-''''''''''''''''''
+'''''''''''''
 
 .. function:: GetAnf(Graph, SrcNId, DistNbrsV, MxDist, IsDir, NApprox=32)
    :noindex:
diff --git a/doc/source/reference/GetAnfNode.rst b/doc/source/reference/GetAnfNode.rst
@@ -1,5 +1,5 @@
 GetAnfNode
-'''''''''''
+''''''''''
 
 .. function:: GetAnfNode(SrcNId, MxDist, IsDir, NApprox=32)
 
diff --git a/doc/source/reference/GetBfsEffDiamAll.rst b/doc/source/reference/GetBfsEffDiamAll.rst
@@ -1,5 +1,5 @@
 GetBfsEffDiamAll
-````````````````
+''''''''''''''''
 
 .. function:: GetBfsEffDiamAll(NTestNode, IsDir)
 
diff --git a/doc/source/reference/GetBfsTree-swig.rst b/doc/source/reference/GetBfsTree-swig.rst
@@ -1,5 +1,5 @@
 GetBfsTree (SWIG)
-''''''''''''''''''
+'''''''''''''''''
 
 .. function:: GetBfsTree(Graph, StartNId, FollowOut, FollowIn)
    :noindex:
diff --git a/doc/source/reference/GetBfsTree.rst b/doc/source/reference/GetBfsTree.rst
@@ -1,5 +1,5 @@
 GetBfsTree
-'''''''''''
+''''''''''
 
 .. function:: GetBfsTree(StartNId, FollowOut, FollowIn)
 
diff --git a/doc/source/reference/GetClustCf1-swig.rst b/doc/source/reference/GetClustCf1-swig.rst
@@ -1,5 +1,5 @@
 GetClustCf (SWIG)
-''''''''''''''''''
+'''''''''''''''''
 
 .. function:: GetClustCf(Graph, DegToCCfV, SampleNodes=-1)
    :noindex:
diff --git a/doc/source/reference/GetCmnNbrs-swig.rst b/doc/source/reference/GetCmnNbrs-swig.rst
@@ -1,5 +1,5 @@
 GetCmnNbrs (SWIG)
-''''''''''''''''''
+'''''''''''''''''
 
 .. function:: GetCmnNbrs(Graph, NId1, NId2)
    :noindex:
diff --git a/doc/source/reference/GetCmnNbrs.rst b/doc/source/reference/GetCmnNbrs.rst
@@ -1,5 +1,5 @@
 GetCmnNbrs
-'''''''''''
+''''''''''
 
 .. function:: GetCmnNbrs(NId1, NId2, NbrList = False)
 
diff --git a/doc/source/reference/GetDegCnt-swig.rst b/doc/source/reference/GetDegCnt-swig.rst
@@ -1,5 +1,5 @@
 GetDegCnt (SWIG)
-''''''''''''''''''''''
+''''''''''''''''
 
 .. function:: GetDegCnt(Graph, DegToCntV)
    :noindex:
diff --git a/doc/source/reference/GetDegCnt.rst b/doc/source/reference/GetDegCnt.rst
@@ -1,5 +1,5 @@
 GetDegCnt
-'''''''''''''''
+'''''''''
 
 .. function:: GetDegCnt()
 
diff --git a/doc/source/reference/GetEigVec-swig.rst b/doc/source/reference/GetEigVec-swig.rst
@@ -1,5 +1,5 @@
 GetEigVec (SWIG)
-''''''''''''''''''
+''''''''''''''''
 
 .. function:: GetEigVec(Graph, EigVec)
    :noindex:
diff --git a/doc/source/reference/GetEigVec1-swig.rst b/doc/source/reference/GetEigVec1-swig.rst
@@ -1,5 +1,5 @@
 GetEigVec (SWIG)
-''''''''''''''''''
+''''''''''''''''
 
 .. function:: GetEigVec(Graph, EigVecs, EigVal, EigVecV)
    :noindex:
diff --git a/doc/source/reference/GetEigVecs.rst b/doc/source/reference/GetEigVecs.rst
@@ -1,5 +1,5 @@
 GetEigVecs
-'''''''''''
+''''''''''
 
 .. function:: GetEigVecs(EigVecs)
 
diff --git a/doc/source/reference/GetHits-swig.rst b/doc/source/reference/GetHits-swig.rst
@@ -1,5 +1,5 @@
 GetHits (SWIG)
-''''''''''''''''''''''
+''''''''''''''
 
 .. function:: GetHits (Graph, NIdHubH, NIdAuthH, MaxIter = 20)
    :noindex:
diff --git a/doc/source/reference/GetHits.rst b/doc/source/reference/GetHits.rst
@@ -1,5 +1,5 @@
 GetHits
-'''''''''''''''
+'''''''
 
 .. function:: GetHits (MaxIter = 20)
 
diff --git a/doc/source/reference/GetKCore-swig.rst b/doc/source/reference/GetKCore-swig.rst
@@ -1,5 +1,5 @@
 GetKCore (SWIG)
-''''''''''''''''''''''
+'''''''''''''''
 
 .. function:: GetKCore(Graph, K)
    :noindex:
diff --git a/doc/source/reference/GetKCore.rst b/doc/source/reference/GetKCore.rst
@@ -1,5 +1,5 @@
 GetKCore
-'''''''''''''''
+''''''''
 
 .. function:: GetKCore(K)
 
diff --git a/doc/source/reference/GetKCoreNodes-swig.rst b/doc/source/reference/GetKCoreNodes-swig.rst
@@ -1,5 +1,5 @@
 GetKCoreNodes (SWIG)
-''''''''''''''''''''''
+''''''''''''''''''''
 
 .. function:: GetKCoreNodes(Graph, CoreIdSzV)
    :noindex:
diff --git a/doc/source/reference/GetKCoreNodes.rst b/doc/source/reference/GetKCoreNodes.rst
@@ -1,5 +1,5 @@
 GetKCoreNodes
-'''''''''''''''
+'''''''''''''
 
 .. function:: GetKCoreNodes()
 
diff --git a/doc/source/reference/GetLen2Paths1-swig.rst b/doc/source/reference/GetLen2Paths1-swig.rst
@@ -1,5 +1,5 @@
 GetLen2Paths (SWIG)
-'''''''''''''''''''''
+'''''''''''''''''''
 
 .. function:: GetLen2Paths (Graph, NId1, NId2, NbrV)
    :noindex:
diff --git a/doc/source/reference/GetMxBiCon-swig.rst b/doc/source/reference/GetMxBiCon-swig.rst
@@ -1,5 +1,5 @@
 GetMxBiCon (SWIG)
-''''''''''''''''''
+'''''''''''''''''
 
 .. function:: GetMxBiCon(Graph)
    :noindex:
diff --git a/doc/source/reference/GetMxBiCon.rst b/doc/source/reference/GetMxBiCon.rst
@@ -1,5 +1,5 @@
 GetMxBiCon
-'''''''''''
+''''''''''
 
 .. function:: GetMxBiCon()
 
diff --git a/doc/source/reference/GetMxWcc-swig.rst b/doc/source/reference/GetMxWcc-swig.rst
@@ -1,5 +1,5 @@
 GetMxWcc (SWIG)
-''''''''''''''''''
+'''''''''''''''
 
 .. function:: GetMxWcc(Graph)
    :noindex:
diff --git a/doc/source/reference/GetMxWcc.rst b/doc/source/reference/GetMxWcc.rst
@@ -1,5 +1,5 @@
 GetMxWcc
-'''''''''''
+''''''''
 
 .. function:: GetMxWcc()
 
diff --git a/doc/source/reference/GetNodeEcc-swig.rst b/doc/source/reference/GetNodeEcc-swig.rst
@@ -1,5 +1,5 @@
 GetNodeEcc (SWIG)
-''''''''''''''''''
+'''''''''''''''''
 
 .. function:: GetNodeEcc(Graph, NId, IsDir=False)
    :noindex:
diff --git a/doc/source/reference/GetNodeEcc.rst b/doc/source/reference/GetNodeEcc.rst
@@ -1,5 +1,5 @@
 GetNodeEcc
-'''''''''''
+''''''''''
 
 .. function:: GetNodeEcc(NId, IsDir=False)
 
diff --git a/doc/source/reference/GetNodeInDegV-swig.rst b/doc/source/reference/GetNodeInDegV-swig.rst
@@ -1,5 +1,5 @@
 GetNodeInDegV (SWIG)
-''''''''''''''''''''''
+''''''''''''''''''''
 
 .. function:: GetNodeInDegV(Graph, NIdInDegV)
    :noindex:
diff --git a/doc/source/reference/GetNodeInDegV.rst b/doc/source/reference/GetNodeInDegV.rst
@@ -1,5 +1,5 @@
 GetNodeInDegV
-'''''''''''''''
+'''''''''''''
 
 .. function:: GetNodeInDegV()
 
diff --git a/doc/source/reference/GetNodeOutDegV-swig.rst b/doc/source/reference/GetNodeOutDegV-swig.rst
@@ -1,5 +1,5 @@
 GetNodeOutDegV (SWIG)
-'''''''''''''''''''''''
+'''''''''''''''''''''
 
 .. function:: GetNodeOutDegV(Graph, NIdOutDegV)
    :noindex:
diff --git a/doc/source/reference/GetNodeOutDegV.rst b/doc/source/reference/GetNodeOutDegV.rst
@@ -1,5 +1,5 @@
 GetNodeOutDegV
-''''''''''''''''
+''''''''''''''
 
 .. function:: GetNodeOutDegV()
 
diff --git a/doc/source/reference/GetNodeTriads1-swig.rst b/doc/source/reference/GetNodeTriads1-swig.rst
diff --git a/doc/source/reference/GetSngVals-swig.rst b/doc/source/reference/GetSngVals-swig.rst
diff --git a/doc/source/reference/GetSngVals.rst b/doc/source/reference/GetSngVals.rst
diff --git a/doc/source/reference/GetSngVec1-swig.rst b/doc/source/reference/GetSngVec1-swig.rst
diff --git a/doc/source/reference/GetSngVecs.rst b/doc/source/reference/GetSngVecs.rst
diff --git a/doc/source/reference/GetTreeRootNId-swig.rst b/doc/source/reference/GetTreeRootNId-swig.rst
diff --git a/doc/source/reference/GetTreeRootNId.rst b/doc/source/reference/GetTreeRootNId.rst
diff --git a/doc/source/reference/GetTreeSig1-swig.rst b/doc/source/reference/GetTreeSig1-swig.rst
diff --git a/doc/source/reference/GetTreeSig1.rst b/doc/source/reference/GetTreeSig1.rst
diff --git a/doc/source/reference/GetTriads1-swig.rst b/doc/source/reference/GetTriads1-swig.rst
diff --git a/doc/source/reference/LoadConnList.rst b/doc/source/reference/LoadConnList.rst
diff --git a/doc/source/reference/PrintInfo-swig.rst b/doc/source/reference/PrintInfo-swig.rst
diff --git a/doc/source/reference/PrintInfo.rst b/doc/source/reference/PrintInfo.rst
diff --git a/doc/source/reference/SaveGViz.rst b/doc/source/reference/SaveGViz.rst
diff --git a/doc/source/reference/SaveGViz1-swig.rst b/doc/source/reference/SaveGViz1-swig.rst
diff --git a/doc/source/reference/SavePajek-swig.rst b/doc/source/reference/SavePajek-swig.rst
diff --git a/doc/source/reference/SavePajek1-swig.rst b/doc/source/reference/SavePajek1-swig.rst
diff --git a/doc/source/reference/attr.rst b/doc/source/reference/attr.rst
diff --git a/doc/source/reference/table-swig.rst b/doc/source/reference/table-swig.rst
diff --git a/doc/source/reference/table.rst b/doc/source/reference/table.rst
diff --git a/swig/snap.i b/swig/snap.i
