/
INSTALL
85 lines (60 loc) · 2.55 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
.. -*- rest -*-
.. vim:syntax=rest
====================
Download and Install
====================
This page covers the necessary steps to install and run RegReg. Below
is a list of required dependencies, along with additional software
recommendations.
RegReg is currently *ALPHA* quality, but is rapidly improving. If you are
trying to get some work done wait until we have a stable release. For now,
the code will primarily be of interest to developers.
Dependencies
------------
Must Have
^^^^^^^^^
Python_ 2.5 or later
NumPy_ 1.2 or later
SciPy_ 0.7 or later
Numpy and Scipy are high-level, optimized scientific computing libraries.
gcc_
RegReg does contain a few C extensions for optimized
routines. Therefore, you must have a compiler to build from
source. XCode_ (OSX) and MinGW_ (Windows) both include gcc. (*Once
we have binary packages, this requirement will not be necessary.*)
cython_ 0.11.1 or later
Cython is a language that is a fusion of Python and C. It allows us
to write fast code using Python and C syntax, so that it easier to
read and maintain. You need Cython if you are building the
development source code (and that is what you have to do at the
moment, because we don't yet have a release).
Strong Recommendations
^^^^^^^^^^^^^^^^^^^^^^
iPython_
Interactive python environment.
Matplotlib_
2D python plotting library.
Installing from binary packages
-------------------------------
Currently we do not have binary packages. Until we do, the easiest
installation method is to download the source tarball and follow the
:ref:`building_source` instructions below.
.. _building_source:
Building from source code
-------------------------
Unpack the source tarball and change into the source directory. Once in the
source directory, you can build the regreg package within the code
directory using::
python setup.py build
To install, simply do::
sudo python setup.py install
.. note::
As with any Python_ installation, this will install the modules
in your system Python_ *site-packages* directory (which is why you
need *sudo*). Many of us prefer to install development packages in a
local directory so as to leave the system python alone. This is
mearly a preference, nothing will go wrong if you install using the
*sudo* method. To install in a local directory, use the **--prefix**
option. For example, if you created a ``local`` directory in your
home directory, you would install regreg like this::
python setup.py install --prefix=$HOME/local