From e7681536d3031599f9cb0f966307c2a8d42b3813 Mon Sep 17 00:00:00 2001 From: Robel Daniel Date: Fri, 13 Dec 2019 01:26:36 -0500 Subject: [PATCH] Added Installation Intructions/Debugging + Minor Typo Fix --- doc/source/reference/GetShortPath.rst | 6 +++--- doc/source/tutorial/tutorial.rst | 21 +++++++++++++++++++++ 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/doc/source/reference/GetShortPath.rst b/doc/source/reference/GetShortPath.rst index 28f4dc1d..45ee92be 100644 --- a/doc/source/reference/GetShortPath.rst +++ b/doc/source/reference/GetShortPath.rst @@ -31,14 +31,14 @@ The following example shows how to find shortest path for nodes in import snap Graph = snap.GenRndGnm(snap.PNGraph, 100, 1000) - Length = GetShortPath(Graph, 1, 100) + Length = snap.GetShortPath(Graph, 1, 100) print("Shortest Path from node 1 to node 100 is %d edges" % Length) UGraph = snap.GenRndGnm(snap.PUNGraph, 100, 1000) - Length = GetShortPath(UGraph, 1, 100) + Length = snap.GetShortPath(UGraph, 1, 100) print("Shortest Path from node 1 to node 100 is %d edges" % Length) Network = snap.GenRndGnm(snap.PNEANet, 100, 1000) - Length = GetShortPath(Network, 1, 100) + Length = snap.GetShortPath(Network, 1, 100) print("Shortest Path from node 1 to node 100 is %d edges" % Length) diff --git a/doc/source/tutorial/tutorial.rst b/doc/source/tutorial/tutorial.rst index 7a3f626e..1b0380d2 100644 --- a/doc/source/tutorial/tutorial.rst +++ b/doc/source/tutorial/tutorial.rst @@ -1,3 +1,24 @@ +Installation +```````````` +Detailed installation instructions can be found at: https://snap.stanford.edu/snappy/. + +To install using pip, use the following command (with sudo privileges and pip3, in brackets, +included as necessary depending on OS and Python version): + +>>> [sudo] pip[3] install snap-stanford + +To install using either the Anaconda or Miniconda package managers, use the following +command: + +>>> conda install -c snap-stanford snap-stanford + +Alternate installation methods and commands for supported operating systems can be found at: +https://docs.google.com/spreadsheets/d/1m-5gHUmGzh8XfLUCAY3eYvdcBA98TUMMusVZkwmpdaI/. Note that +on macOS 10.13, the setup.py installation script from https://snap.stanford.edu/snappy/ must +be used over pip. If using setup.py to install Snap.py, do not test the installation in the same +directory as the install. + + Introduction ````````````