← Back to branch summary

~ubuntu-branches/ubuntu/trusty/python-networkx/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/Install.txt

  • Committer: Bazaar Package Importer
  • Author(s): Cyril Brulebois
  • Date: 2009-02-28 13:36:24 UTC
  • mfrom: (1.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090228133624-9l5rwi1ftlzc7b0l
http://bugs.debian.org/517065
* Upload to unstable now that lenny is released (yay).
* Fix FTBFS with python-support 0.90.3: no longer rely on its internal
  behaviour, and xnow set tests/test.py executable right after “setup.py
  install” (Closes: #517065).
* Drop executable bits from bz2 files.
* Update Vcs-* fields: move from DPMT's svn to collab-maint's git.
* Remote DPMT from Uploaders, following Piotr Ożarowski's request.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/Install.txt
1
 
Requirements
2
 
-------------
3
 
 
4
 
To use NetworkX you need Python version 2.3 or later http://www.python.org/
5
 
 
6
 
See below for tips on installing Python.
7
 
 
8
 
 
9
 
Installing Pre-built NetworkX packages
10
 
--------------------------------------
11
 
 
12
 
The following pre-built NetworkX packages are available:
13
 
 
14
 
Windows
15
 
~~~~~~~
16
 
Download and run the latest version of the Windows installer (.exe extension).
17
 
 
18
 
OSX 10.5
19
 
~~~~~~~~
20
 
Download and install the latest mpkg. 
21
 
 
22
 
Linux
23
 
~~~~~
24
 
Debian packages are available at http://packages.debian.org/unstable/graphics/python-networkx
25
 
 
26
 
 
27
 
Python Eggs for All Platforms 
28
 
-----------------------------
29
 
 
30
 
Python eggs are prepackaged distributions that can be automatically 
31
 
installed using EasyInstall http://peak.telecommunity.com/DevCenter/EasyInstall
32
 
 
33
 
Run
34
 
 
35
 
::
36
 
 
37
 
   easy_install networkx
38
 
 
39
 
and an attempt will be made to find and install an appropriate version
40
 
that matches your operating system and Python version. 
41
 
 
42
 
Installing from Source
43
 
----------------------
44
 
 
45
 
You can install from source by downloading a source archive file
46
 
(tar.gz or zip) or by checking out the files from the Subversion repository.
47
 
NetworkX is a pure Python package (you don't need a compiler to build
48
 
or install it).
49
 
 
50
 
Source Archive File
51
 
~~~~~~~~~~~~~~~~~~~
52
 
  - Download the source (tar.gz or zip file).
53
 
  - Unpack and change directory to networkx-x.xx where x.xx is the version number
54
 
  - Run "python setup.py install" to build and install 
55
 
  - (optional) cd networkx/tests and run "python setup_egg.py test" to execute the tests
56
 
 
57
 
SVN Repository
58
 
~~~~~~~~~~~~~~
59
 
Make sure you have Subversion installed (SVN)
60
 
 
61
 
  - Check out the networkx trunk: svn co https://networkx.lanl.gov/svn/networkx/trunk networkx
62
 
  - Run "python setup.py install" to build and install 
63
 
  - (optional) run "python setup_egg.py test" to execute the tests
64
 
 
65
 
 
66
 
Optional packages 
67
 
-----------------
68
 
 
69
 
NetworkX will work without the following optional packages.
70
 
But to enable all functionality you will need the following:
71
 
 
72
 
 - To enable drawing networks with matplotlib you need
73
 
 
74
 
      - numpy            http://numpy.scipy.org/
75
 
      - Matplotlib       http://matplotlib.sourceforge.net/
76
 
 
77
 
 - To enable graphviz layout and drawing features you need
78
 
 
79
 
      - pygraphviz       http://networkx.lanl.gov/pygraphviz/
80
 
      - Graphviz         http://graphviz.org/
81
 
 
82
 
 
83
 
Installing Optional Packages
84
 
----------------------------
85
 
 
86
 
For Windows and OSX (non-fink, non-MacPorts) the easiest way to
87
 
get Matplotlib/Numpy/Scipy installed is to follow the directions for
88
 
installing pre-built Scipy binary packages at http://scipy.org/Download
89
 
 
90
 
For Linux systems try installing binary packages through your package
91
 
management system.
92
 
 
93
 
Matplotlib
94
 
~~~~~~~~~~
95
 
 
96
 
NetworkX uses Matplotlib for drawing graphs.  
97
 
For installation see the instructions at 
98
 
 
99
 
 - http://matplotlib.sourceforge.net/installing.html
100
 
 
101
 
Matplotlib uses numpy for numerical array computing (see above comment
102
 
on how to install Matplotlib/Numpy/Scipy all together). 
103
 
 
104
 
Additional useful packages
105
 
~~~~~~~~~~~~~~~~~~~~~~~~~~
106
 
These are extra packages you may consider to use with NetworkX
107
 
 
108
 
      - IPython, interactive Python shell, http://ipython.scipy.org/
109
 
      - SciPy, scientific computing package, http://scipy.org/
110
 
      - sAsync, persistent storage with SQL, http://foss.eepatents.com/sAsync  
111
 
      - PyYAML, structured output format, http://pyyaml.org/
112
 
 
113
 
 
114
 
Installing Python
115
 
-----------------
116
 
 
117
 
If you don't have Python installed on your system:
118
 
 
119
 
Windows
120
 
~~~~~~~
121
 
The easiest way to get Python and most optional packages is to install
122
 
the Enthought Python distribution: http://code.enthought.com/enthon/
123
 
 
124
 
Other options are
125
 
 
126
 
 - Download from the official Python site at
127
 
   http://www.python.org/download/
128
 
 
129
 
 - ActiveState also distributes a binary version 
130
 
   http://activestate.com/Products/ActivePython/?mp=1
131
 
 
132
 
OSX
133
 
~~~
134
 
OSX 10.5 ships with Python version 2.5.  If you
135
 
have an older version we encourage you to download
136
 
a newer release. Pre-built Python packages are available from 
137
 
 
138
 
 - Pythonmac  http://www.pythonmac.org/packages/ 
139
 
 
140
 
Other options are:
141
 
 
142
 
 - ActiveState http://activestate.com/Products/ActivePython/?mp=1
143
 
 
144
 
 - Download from the official Python site at
145
 
   http://www.python.org/download/
146
 
 
147
 
If you are using Fink or MacPorts, Python is available through both
148
 
of those package systems.