Skip to content

Commit

Permalink
Merge 4302bdf into 2054fd4
Browse files Browse the repository at this point in the history
  • Loading branch information
markkness committed May 23, 2014
2 parents 2054fd4 + 4302bdf commit 268dd60
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 45 deletions.
61 changes: 20 additions & 41 deletions docs/source/mayavi/installation.rst
Expand Up @@ -12,24 +12,22 @@ Installation

..
Up-to-date install instructions for the latest version of Mayavi are
always available from links at the Mayavi2_ wiki page. The following
always available from links at the Mayavi_ wiki page. The following
will give you a good idea of the general installation procedure and a
start on where to look for more information.
.. _Mayavi2: https://svn.enthought.com/enthought/wiki/MayaVi
Installing ready-made distributions
------------------------------------

:Windows:
Under Window the best way to install Mayavi is to install a full
Python distribution, such as EPD_ or Pythonxy_. Note that for
Pythonxy, you need to check in 'ETS' in the installer, when
selecting components. If you want to reduce the disk used by the
Under Windows the best way to install Mayavi is to install a full
Python distribution, such as `Enthought Canopy`_, Pythonxy_, or Anaconda_.
Note that for Pythonxy, you need to check in 'ETS' in the installer, when
selecting components. If you want to reduce the disk space used by
Pythonxy, you can uncheck other components.

:MacOSX:
The full Python distribution EPD_ (that includes Mayavi) is also
The full Python distribution `Enthought Canopy`_ (that includes Mayavi) is also
available for MacOSX. Unless you really enjoy the intricacies of
compilation; this is the best solution to install Mayavi.

Expand All @@ -41,7 +39,7 @@ Installing ready-made distributions
http://people.debian.org/~varun/ .

:RedHat EL3 and EL4:
The full Python distribution EPD_ (that includes Mayavi) is also
The full Python distribution `Enthought Canopy`_ (that includes Mayavi) is also
available for RHEL3 and 4.


Expand Down Expand Up @@ -77,46 +75,34 @@ One can install the requirements in several ways.

* Windows and MacOSX: even if you want to build from source, a good
way to install the requirements is to install one of the
distributions indicated above. Note that under Windows, EPD_ comes
with a compiler (mingw) and facilitates building Mayavi.
distributions indicated above. Note that under Windows,
`Enthought Canopy`_ comes with a compiler (mingw) and facilitates
building Mayavi.

* Linux: Most Linux distributions will have installable binaries
available for the some of the above. For example, under Debian_ or
Ubuntu_ you would need ``python-vtk``, ``python-wxgtk2.6``,
``python-setuptools``, ``python-numpy``, ``python-configobj``.
More information on specific distributions and how you can get the
requirements for each of these should be available from the list of
distributions here:

https://svn.enthought.com/enthought/wiki/Install

* Mac OS X: The best available instructions for this platform are
available on the IntelMacPython25_ page. If you are building VTK
yourself, make sure to use the following options::

VTK_USE_CARBON=ON
VTK_USE_COCOA=OFF
VTK_USE_RPATH=ON

Instructions for Snow Leopard can be found below.


There are several ways to install TVTK_, Traits_ and Mayavi. These
are described in the following.

.. _TVTK: https://svn.enthought.com/enthought/wiki/TVTK
.. _Mayavi: http://docs.enthought.com/mayavi/mayavi
.. _TVTK: http://docs.enthought.com/mayavi/tvtk
.. _VTK: http://www.vtk.org
.. _envisage: https://svn.enthought.com/enthought/wiki/Envisage
.. _Traits: https://svn.enthought.com/enthought/wiki/Traits
.. _envisage: http://docs.enthought.com/envisage
.. _Traits: http://docs.enthought.com/traits
.. _wxPython: http://www.wxpython.org
.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
.. _enstaller: http://code.enthought.com/enstaller
.. _Debian: http://www.debian.org
.. _Ubuntu: http://www.ubuntu.com
.. _IntelMacPython25: https://svn.enthought.com/enthought/wiki/IntelMacPython25
.. _numpy: http://numpy.scipy.org
.. _EPD: http://www.enthought.com/products/epd.php
.. _Pythonxy: http://www.pythonxy.com
.. _Enthought Canopy: https://www.enthought.com/products/canopy/
.. _Pythonxy: http://code.google.com/p/pythonxy/
.. _Anaconda: https://store.continuum.io/cshop/anaconda/
.. _configobj: http://pypi.python.org/pypi/ConfigObj/

Doing it yourself: Python packages: Eggs
Expand Down Expand Up @@ -159,7 +145,7 @@ installed, and then build and install the eggs like so::
This one command will download, build and install all the required ETS
related modules that Mayavi needs for the latest ETS release, this means
that the `Traits` dependencies and the `Envisage` dependencies will be
installed automatically (more details on the `Enthought Install`_ pages).
installed automatically.

If you are running a unix system (such as Linux) we advice you not to
install the files in the system directories (`/usr`). An easy way to
Expand All @@ -179,16 +165,10 @@ avoid this is to run::
violation". In this case, it can be useful to try the download and
install command a few times.

If you still have problems, given this background, please see the
following `Enthought Install`_ describes how ETS can be installed
with eggs. Check this page first. It contains information on how to
install the prebuilt binary eggs for various platforms along with any
dependencies.


.. note:: Automatic downloading of required eggs

If you whish to download all the eggs fetched by `easy_install`, for
If you wish to download all the eggs fetched by `easy_install`, for
instance to propagate to an offline PC, you can use virtualenv to
create an empty site-packages, and install to it::

Expand Down Expand Up @@ -255,8 +235,7 @@ will run.


.. _Eggs: http://peak.telecommunity.com/DevCenter/PythonEggs
.. _Enthought Install: https://svn.enthought.com/enthought/wiki/Install
.. _ETS: http://code.enthought.com/ets
.. _ETS: http://code.enthought.com/

Downloading tarballs
.....................
Expand Down
5 changes: 1 addition & 4 deletions docs/source/mayavi/misc.rst
Expand Up @@ -28,10 +28,7 @@ Discussion and bug reports are also sometimes sent to the mayavi-users
mailing list (Mayavi-users@lists.sourceforge.net). We recommend
sending messages to the enthought-dev list though.

The Mayavi wiki page: https://svn.enthought.com/enthought/wiki/MayaVi

is a trac page where one can also enter bug reports and feature
requests.
The Mayavi web page: http://docs.enthought.com/mayavi/mayavi

If this manual, the Mayavi web page, the wiki page and google are of no
help feel free to post on the enthought-dev mailing list for help.
Expand Down

0 comments on commit 268dd60

Please sign in to comment.