Statistics
| Branch: | Revision:

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

History | View | Annotate | Download (3.01 KB)

1
..  -*- coding: utf-8 -*-
2

    
3
.. _contents:
4

    
5
Overview of NetworkX_
6
=====================
7

    
8
.. _NetworkX: https://networkx.github.io/
9

    
10
NetworkX is a Python package for the creation, manipulation, and study
11
of the structure, dynamics, and functions of complex networks.
12

    
13
NetworkX provides:
14

    
15
-  tools for the study of the structure and
16
   dynamics of social, biological, and infrastructure networks;
17
-  a standard programming interface and graph implementation that is suitable
18
   for many applications;
19
-  a rapid development environment for collaborative, multidisciplinary
20
   projects;
21
-  an interface to existing numerical algorithms and code written in C,
22
   C++, and FORTRAN; and
23
-  the ability to painlessly work with large nonstandard data sets.
24

    
25
With NetworkX you can load and store networks in standard and nonstandard data
26
formats, generate many types of random and classic networks, analyze network
27
structure, build network models, design new network algorithms, draw networks,
28
and much more.
29

    
30
Audience
31
--------
32

    
33
The audience for NetworkX includes mathematicians, physicists, biologists,
34
computer scientists, and social scientists. Good reviews of the science of
35
complex networks are presented in Albert and Barabási [BA02]_, Newman
36
[Newman03]_, and Dorogovtsev and Mendes [DM03]_. See also the classic texts
37
[Bollobas01]_, [Diestel97]_ and [West01]_ for graph theoretic results and
38
terminology. For basic graph algorithms, we recommend the texts of Sedgewick
39
(e.g., [Sedgewick01]_ and [Sedgewick02]_) and the survey of Brandes and
40
Erlebach [BE05]_.
41

    
42
Python
43
------
44

    
45
Python is a powerful programming language that allows simple and flexible
46
representations of networks as well as clear and concise expressions of network
47
algorithms.  Python has a vibrant and growing ecosystem of packages that
48
NetworkX uses to provide more features such as numerical linear algebra and
49
drawing.  In order to make the most out of NetworkX you will want to know how
50
to write basic programs in Python.  Among the many guides to Python, we
51
recommend the `Python documentation <https://docs.python.org/3/>`_ and the text
52
by Alex Martelli [Martelli03]_.
53

    
54
Free software
55
-------------
56

    
57
NetworkX is free software; you can redistribute it and/or modify it under the
58
terms of the :doc:`3-clause BSD License </license>`.  We welcome contributions.
59
Join us on `GitHub <https://github.com/networkx/networkx>`_.
60

    
61
History
62
-------
63

    
64
NetworkX was born in May 2002. The original version was designed and written by
65
Aric Hagberg, Dan Schult, and Pieter Swart in 2002 and 2003.  The first public
66
release was in April 2005.
67
Many people have contributed to the success of NetworkX. Some of the
68
contributors are listed in the :doc:`credits. <credits>`
69

    
70
Documentation
71
-------------
72

    
73
.. only:: html
74

    
75
    :Release: |version|
76
    :Date: |today|
77

    
78
.. toctree::
79
   :maxdepth: 1
80

    
81
   install
82
   tutorial
83
   reference/index
84
   developer/index
85
   news
86
   license
87
   credits
88
   citing
89
   bibliography
90
   auto_examples/index
91

    
92
Indices and tables
93
------------------
94

    
95
* :ref:`genindex`
96
* :ref:`modindex`
97
* :ref:`search`
98
* :ref:`glossary`