6
.. topic:: Section summary
8
This section detais the various ways of installing and compiling
11
If you already have Mayavi up and running, you can skip this section.
6
13
Up-to-date install instructions for the latest version of mayavi are
7
14
always available from links at the Mayavi2_ wiki page. The following
8
15
will give you a good idea of the general installation procedure and a
9
16
start on where to look for more information.
11
19
.. _Mayavi2: https://svn.enthought.com/enthought/wiki/MayaVi
13
21
Installing ready-made distributions
39
47
available for RHEL3 and 4.
50
Requirements for hand installs
51
--------------------------------
53
If you are not using full, ready-made, scientific Python distribution,
54
you need to satistify Mayavi's requirements (for a step-by-step guide on
55
installing all these under windows, see :ref:`below <step-by-step-window-installation>`.
45
57
Mayavi requires at the very minimum the following packages:
49
61
* setuptools_ (for installation and egg builds)
50
62
* Traits_ >= 3.0 (`Traits`, `TraitsGUI` and `TraitsBackendWX` or
63
`TraitsBackendQt`, `EnthoughtBase`, `AppTools`)
64
**Note** Depending on your installation
65
procedure, you might not need to instal manually these
53
68
The following requirements are really optional but strongly recommended,
54
69
especially if you are new to mayavi:
56
* Envisage_ == 3.x (`EnvisageCore` and `EnvisagePlugins`)
73
* Envisage_ == 3.x (`EnvisageCore` and `EnvisagePlugins`)
74
**Note** These last requirements can be automatically installed,
60
77
One can install the requirements in several ways.
96
113
.. _Pythonxy: http://www.pythonxy.com
97
114
.. _configobj: http://pypi.python.org/pypi/ConfigObj/
100
-----------------------
116
Doing it yourself: Python packages: Eggs
117
-----------------------------------------
102
119
First make sure you have the prerequisites for Mayavi installed, i.e.
103
120
the following packages:
130
147
2. The second is to build the eggs from the source tarballs. This is
131
148
also fairly easy to do if you have a proper build environment.
133
To install eggs, first make sure the requirements are installed, and
134
then build and install the eggs like so::
150
To install eggs, first make sure the essential requirements are
151
installed, and then build and install the eggs like so::
136
153
$ easy_install "Mayavi[app]"
138
155
This one command will download, build and install all the required
139
ETS related modules that mayavi needs for the latest ETS release.
156
ETS related modules that mayavi needs for the latest ETS release, this
157
means that the `Traits` dependencies and the `Envisage` dependencies will
158
be installed automatically.
140
159
If you run into trouble please check the `Enthought Install`_ pages.
142
161
One common sources of problems during an install, is the presence of
154
173
the prebuilt binary eggs for various platforms along with any
176
.. _step-by-step-window-installation:
178
Step-by-step instructions to install with eggs under Windows
179
...............................................................
181
If you do not whish to install a ready-made distribution under Windows,
182
these instructions (provided by Guillaume Duclaux) will guide you through
183
the necessary steps to configure a Windows environment in which Mayavi
186
1. Install Python 2.5. Add 'C:\Python25;` to the PATH environment
189
2. Install Mingw32, from the Download section of http://www.mingw.org/ ,
190
use the MinGW5.1.4 installer. Add 'C:\MinGW\bin;' to the PATH
191
environment variables.
193
3. Create a 'c:\documents and settings\USERNAME\pydistutils.cfg' file(where
194
USERNAME is the login) with the following contents::
199
4. Create the new environment variable HOME and set it to the value:
200
'c:\docume~1\USERNAME;' (where USERNAME is the login name)
202
5. Install Setuptools (0.6c9 binary) from its webpage, and
203
'C:\Python25\Scripts;' to the PATH environment variables
205
6. Install VTK 5.2 (using Dr Charl P. Botha Windows binary
206
http://cpbotha.net/2008/09/23/python-25-enabled-vtk-52-windows-binaries/
209
* Unzip the folder content in 'C:\\Program Files\\VTK5.2_cpbotha'
210
* add 'C:\\Program Files\\VTK5.2_cpbotha\\bin;' to the PATH environment
212
* create a new environment variable PYTHONPATH and set it to the
213
value 'C:\\Program Files\\VTK5.2_cpbotha\\lib\\site-packages;'
214
* If you are running an old version of windows (older than XP)
215
download msvcr80.dll and msvcp80.dll from the www.dll-files.com
216
website and copy them into C:\\winnt\\system32.
218
7. Install Numpy (1.2.1 binary from http://numpy.scipy.org/ )
220
8. Installing wxPython (2.8 binary from http://www.wxpython.org/ )
224
easy_install Sphinx EnvisageCore EnvisagePlugins configobj
226
10. Finally, run in cmd.exe::
228
easy_install Mayavi[app]
159
231
.. _Eggs: http://peak.telecommunity.com/DevCenter/PythonEggs
added
removed
docs/source/mayavi/installation.rst
