Skip to content

Added Installation Intructions/Debugging + Minor Typo Fix #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robeld wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added Installation Intructions/Debugging + Minor Typo Fix #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/source/reference/GetShortPath.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

21 changes: 21 additions & 0 deletions doc/source/tutorial/tutorial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
````````````

Expand Down