Statistics
| Branch: | Revision:

iof-tools / networkxMiCe / networkx-master / README.rst @ 5cef0f13

History | View | Annotate | Download (2.01 KB)

1
NetworkX
2
========
3

    
4
.. image:: https://travis-ci.org/networkx/networkx.svg?branch=master
5
   :target: https://travis-ci.org/networkx/networkx
6

    
7
.. image:: https://ci.appveyor.com/api/projects/status/github/networkx/networkx?branch=master&svg=true
8
   :target: https://ci.appveyor.com/project/dschult/networkx-pqott
9

    
10
.. image:: https://codecov.io/gh/networkx/networkx/branch/master/graph/badge.svg
11
  :target: https://codecov.io/gh/networkx/networkx
12

    
13
NetworkX is a Python package for the creation, manipulation,
14
and study of the structure, dynamics, and functions
15
of complex networks.
16

    
17
- **Website (including documentation):** http://networkx.github.io
18
- **Mailing list:** https://groups.google.com/forum/#!forum/networkx-discuss
19
- **Source:** https://github.com/networkx/networkx
20
- **Bug reports:** https://github.com/networkx/networkx/issues
21

    
22
Install
23
-------
24

    
25
Install the latest version of NetworkX::
26

    
27
    $ pip install networkx
28

    
29
Install with all optional dependencies::
30

    
31
    $ pip install networkx[all]
32

    
33
For additional details, please see `INSTALL.rst`.
34

    
35
Simple example
36
--------------
37

    
38
Find the shortest path between two nodes in an undirected graph:
39

    
40
.. code:: python
41

    
42
    >>> import networkx as nx
43
    >>> G = nx.Graph()
44
    >>> G.add_edge('A', 'B', weight=4)
45
    >>> G.add_edge('B', 'D', weight=2)
46
    >>> G.add_edge('A', 'C', weight=3)
47
    >>> G.add_edge('C', 'D', weight=4)
48
    >>> nx.shortest_path(G, 'A', 'D', weight='weight')
49
    ['A', 'B', 'D']
50

    
51
Bugs
52
----
53

    
54
Please report any bugs that you find `here <https://github.com/networkx/networkx/issues>`_.
55
Or, even better, fork the repository on `GitHub <https://github.com/networkx/networkx>`_
56
and create a pull request (PR). We welcome all changes, big or small, and we
57
will help you make the PR if you are new to `git` (just ask on the issue and/or
58
see `CONTRIBUTING.rst`).
59

    
60
License
61
-------
62

    
63
Released under the 3-Clause BSD license (see `LICENSE.txt`)::
64

    
65
   Copyright (C) 2004-2019 NetworkX Developers
66
   Aric Hagberg <hagberg@lanl.gov>
67
   Dan Schult <dschult@colgate.edu>
68
   Pieter Swart <swart@lanl.gov>