~ubuntu-branches/ubuntu/hardy/mayavi2/hardy-backports

<p>Up-to-date install instructions are always available at the <a class="reference" href="https://svn.enthought.com/enthought/wiki/MayaVi">Mayavi2</a>

web page. The following instructions are likely not up-to-date but

should give you a good idea of the general installation procedure and

a start on where to look.</p>

<h2 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>

<p>Mayavi requires at the very minimum the following packages:</p>

<li><a class="reference" href="http://www.vtk.org">VTK</a> >= 4.4 (5.x is ideal)</li>

<li><a class="reference" href="http://numpy.scipy.org">numpy</a> >= 1.0.1</li>

<li><a class="reference" href="http://peak.telecommunity.com/DevCenter/setuptools">setuptools</a> (for installation and egg builds)</li>

<li><a class="reference" href="https://svn.enthought.com/enthought/wiki/TVTK">TVTK</a> (<cite>enthought.tvtk</cite>)</li>

<li><a class="reference" href="https://svn.enthought.com/enthought/wiki/Traits">Traits</a> >= 2.0 (<cite>enthought.traits</cite>)</li>

</ul>

</blockquote>

<p>The following requirements are really optional but strongly recommended,

especially if you are new to mayavi:</p>

<li><a class="reference" href="https://svn.enthought.com/enthought/wiki/Envisage">Envisage</a> == 2.x (<cite>enthought.envisage</cite>)</li>

<li><a class="reference" href="http://www.wxpython.org">wxPython</a> 2.6.x or 2.8.x</li>

</ul>

</blockquote>

<p>One can install the requirements in several ways.</p>

<ul>

<li><p class="first">Win32: Under Win32 the best way to get all the dependencies is to

use Enthought’s <a class="reference" href="http://code.enthought.com/enstaller">enstaller</a>. This will also let you install mayavi.</p>

</li>

<li><p class="first">Linux: Most Linux distributions will have installable binaries

available for the some of the above. For example, under <a class="reference" href="http://www.debian.org">Debian</a> or

<a class="reference" href="http://www.ubuntu.com">Ubuntu</a> you would need <tt class="docutils literal"><span class="pre">python-vtk</span></tt>, <tt class="docutils literal"><span class="pre">python-wxgtk2.6</span></tt>,

<tt class="docutils literal"><span class="pre">python-setuptools</span></tt>, <tt class="docutils literal"><span class="pre">python-numpy</span></tt>. 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:</p>

<p><a class="reference" href="https://svn.enthought.com/enthought/wiki/Install">https://svn.enthought.com/enthought/wiki/Install</a></p>

</blockquote>

</li>

<li><p class="first">Mac OS X: The best available instructions for this platform are

available on the <a class="reference" href="https://svn.enthought.com/enthought/wiki/IntelMacPython25">IntelMacPython25</a> page.</p>

</li>

</ul>

</blockquote>

<p>There are several ways to install <a class="reference" href="https://svn.enthought.com/enthought/wiki/TVTK">TVTK</a>, <a class="reference" href="https://svn.enthought.com/enthought/wiki/Traits">Traits</a> and Mayavi. These

are described in the following.</p>

100

</div>

101

102

<h2 id="python-packages-eggs">Python packages: Eggs<a class="headerlink" href="#python-packages-eggs" title="Permalink to this headline">¶</a></h2>

103

<p><a class="reference" href="https://svn.enthought.com/enthought/wiki/MayaVi">Mayavi2</a> is part of the Enthought Tool Suite (<a class="reference" href="http://code.enthought.com/ets">ETS</a>). As such, it is

104

distributed as part of ETS and therefore binary packages and source

105

packages of ETS will contain Mayavi2. Mayavi releases are almost always

106

made along with an ETS release. You may choose to install all of ETS or

107

just Mayavi2 alone from a release.</p>

108

<p>ETS has been organized into several different Python packages. These

109

packages are distributed as Python <a class="reference" href="http://peak.telecommunity.com/DevCenter/PythonEggs">Eggs</a>. Python eggs are fairly

110

sophisticated and carry information on dependencies with other eggs. As

111

such they are rapidly becoming the standard for distributing Python

112

packages.</p>

113

<p>There are primarily two ways to use ETS eggs.</p>

114

115

116

<li>The first and easiest is to use pre-built eggs built for your

117

particular platform. More instructions on this are below.</li>

118

<li>The second is to build the eggs from the source tarballs. This is

119

also fairly easy to do if you have a proper build environment.</li>

120

</ol>

121

</blockquote>

122

<p>Given this background please see the following:</p>

123

124

<ul>

125

<li><p class="first"><a class="reference" href="https://svn.enthought.com/enthought/wiki/Install">Enthought Install</a> describes how ETS can be installed with eggs.

126

Check this page first. It contains information on how to install

127

the prebuilt binary eggs for various platforms along with any

128

dependencies.</p>

129

</li>

130

<li><p class="first">If there aren’t any pre-built eggs for your platform, first make

131

sure the requirements are installed, and then build and install

132

the eggs like so:</p>

133

<pre>$ easy_install -f http://code.enthought.com/enstaller/eggs/source \

134

> enthought.mayavi</pre>

135

<p>This one command will download, build and install all the required

136

ETS related modules that mayavi needs for the latest ETS release.

137

If you run into trouble please check the <a class="reference" href="https://svn.enthought.com/enthought/wiki/Install">Enthought Install</a> pages.

138

Note that the above is really one line, it has been split with the

139

<tt class="docutils literal"><span class="pre">\</span></tt> character into two lines in order to fit on the printed

140

version of this document.</p>

141

</li>

142

</ul>

143

</blockquote>

144

</div>

145

146

<h2 id="the-bleeding-edge-svn">The bleeding edge: SVN<a class="headerlink" href="#the-bleeding-edge-svn" title="Permalink to this headline">¶</a></h2>

147

<p>If you want to get the latest development version of Mayavi, we

148

recommend that you check it out from SVN. Mayavi depends on several

149

packages that are part of ETS. It is highly likely that the

150

in-development mayavi version may depend on some feature of an as yet

151

unreleased component. Therefore, it is very convenient to get all the

152

relevant ETS projects that mayavi recursively depends on in one single

153

checkout. In order to do this easily, Dave Peterson has created a

154

package called <a class="reference" href="https://svn.enthought.com/enthought/wiki/SVNScripts">ETSProjectTools</a>. This must first be installed and then

155

any of ETS related repositories may be checked out. Here is how you can

156

get the latest development sources.</p>

157

158

159

<li><p class="first">Install <a class="reference" href="https://svn.enthought.com/enthought/wiki/SVNScripts">ETSProjectTools</a> like so:</p>

160

<pre>$ svn co https://svn.enthought.com/svn/enthought/ETSProjectTools/trunk \

161

ETSProjectTools

162

$ cd ETSProjectTools

163

$ python setup.py install</pre>

164

<p>This will give you several useful scripts like <tt class="docutils literal"><span class="pre">etsco</span></tt>, <tt class="docutils literal"><span class="pre">etsup</span></tt>,

165

<tt class="docutils literal"><span class="pre">etsdevelop</span></tt> etc.</p>

166

</li>

167

<li><p class="first">To get just the sources for mayavi and all its dependencies do this:</p>

168

<pre>$ etsco enthought.mayavi</pre>

169

<p>This will look at the latest available mayavi, parse its ETS

170

dependencies and check out the relevant sources. If you want a

171

particular mayavi release you may do:</p>

172

<pre>$ etsco "enthought.mayavi==2.0.2"</pre>

173

<p>If you’d like to get the sources for an entire ETS release do this

174

for example:</p>

175

<pre>$ etsco "ets==2.7.0"</pre>

176

<p>This will checkout all the relevant sources from SVN. Be patient,

177

this will take a while. More options for the <tt class="docutils literal"><span class="pre">etsco</span></tt> tool are

178

available in the <a class="reference" href="https://svn.enthought.com/enthought/wiki/SVNScripts">ETSProjectTools</a> page.</p>

179

</li>

180

<li><p class="first">Once the sources are checked out you may either do an:</p>

181

<pre>$ etsdevelop</pre>

182

<p>This will install all the checked out sources via a <tt class="docutils literal"><span class="pre">setup.py</span>

183

<span class="pre">develop</span></tt> applied to each package.</p>

184

</li>

185

<li><p class="first">Alternatively, you may want to build binary eggs, of the sources.

186

At this time ETSProjectTools does not provide a build script,

187

however you can use the <tt class="docutils literal"><span class="pre">egg_builder.py</span></tt> script from here:</p>

188

<pre>$ svn cat https://svn.enthought.com/svn/enthought/sandbox/egg_builder.py \

189

> egg_builder.py</pre>

190

<p>This script can be used to build eggs like so (here we assume that

191

<tt class="docutils literal"><span class="pre">etsco</span></tt> checked out the sources into <tt class="docutils literal"><span class="pre">ets-2.7.0</span></tt>):</p>

192

<pre>$ cd ets-2.7.0

193

$ python ../egg_builder.py</pre>

194

<p>This will build all the eggs and put them inside a <tt class="docutils literal"><span class="pre">dist</span></tt>

195

subdirectory. The mayavi development egg and its dependencies may

196

be installed via:</p>

197

<pre>$ easy_install -f dist enthought.mayavi</pre>

198

<p>Alternatively, if you’d like just <tt class="docutils literal"><span class="pre">enthought.mayavi</span></tt> installed via

199

<tt class="docutils literal"><span class="pre">setup.py</span> <span class="pre">develop</span></tt> with the rest as binary eggs you may do:</p>

200

<pre>$ cd enthought.mayavi_x.y.z

201

$ python setup.py develop -f ../dist</pre>

202

<p>This will pull in any dependencies from the built eggs.</p>

203

</li>

204

</ol>

205

</blockquote>

206

<p>You should now have the latest version of Mayavi installed and usable.</p>

207

</div>

208

209

<h2 id="testing-your-installation">Testing your installation<a class="headerlink" href="#testing-your-installation" title="Permalink to this headline">¶</a></h2>

210

<p>The easiest way to test if your installation is OK is to run the mayavi2

211

application like so:</p>

212

<div class="highlight"><pre><span class="n">mayavi2</span>

213

</pre></div>

214

<p>To get more help on the command try this:</p>

215

<div class="highlight"><pre><span class="n">mayavi2</span> <span class="o">-</span><span class="n">h</span>

216

</pre></div>

217

<p><tt class="docutils literal"><span class="pre">mayavi2</span></tt> is the mayavi application. On some platforms like win32

218

you will need to double click on the <tt class="docutils literal"><span class="pre">mayavi2.exe</span></tt> program found in

219

your <tt class="docutils literal"><span class="pre">Python2X\Scripts</span></tt> folder. Make sure this directory is in your

220

path.</p>

221

222

223

<p class="last">Mayavi can be used in a variety of other ways but the <tt class="docutils literal"><span class="pre">mayavi2</span></tt>

224

application is the easiest to start with.</p>

225

</div>

226

<p>If you have the source tarball of mayavi or have checked out the sources

227

from the SVN repository, you can run the examples in

228

<tt class="docutils literal"><span class="pre">enthought.mayavi*/examples</span></tt>. There are plenty of example scripts

229

illustrating various features. Tests are available in the

230

<tt class="docutils literal"><span class="pre">enthought.mayavi*/tests</span></tt> sub-directory.</p>

231

</div>

232

</div>

233

234

235

</div>

236

</div>

237

</div>

238

239

240

241

<h3>Table Of Contents</h3>

242

<ul>

243

<li><a class="reference" href="">Installation</a><ul>

244

<li><a class="reference" href="#requirements">Requirements</a></li>

245

<li><a class="reference" href="#python-packages-eggs">Python packages: Eggs</a></li>

246

<li><a class="reference" href="#the-bleeding-edge-svn">The bleeding edge: SVN</a></li>

247

<li><a class="reference" href="#testing-your-installation">Testing your installation</a></li>

248

</ul>

249

</li>

250

</ul>

251

252

<h4>Previous topic</h4>

253

<p class="topless"><a href="introduction.html" title="previous chapter">Introduction</a></p>

254

<h4>Next topic</h4>

255

<p class="topless"><a href="overview.html" title="next chapter">An overview of Mayavi</a></p>

256

257

258

<li><a href="_sources/installation.txt">Show Source</a></li>

259

</ul>

260

<h3>Quick search</h3>

261

262

263

264

265

</form>

266

</div>

267

</div>

268

269

</div>

270

271

<h3>Navigation</h3>

272

<ul>

273

274

<a href="genindex.html" title="General Index"

275

accesskey="I">index</a></li>

276

277

<a href="modindex.html" title="Global Module Index"

278

accesskey="M">modules</a> |</li>

279

280

<a href="overview.html" title="An overview of Mayavi"

281

accesskey="N">next</a> |</li>

282

283

<a href="introduction.html" title="Introduction"

284

accesskey="P">previous</a> |</li>

285

<li><a href="index.html">Mayavi2 v2.2.0 documentation</a> »</li>

286

</ul>

287

</div>

288

289

290

Last updated on Jun 29, 2008.

291

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.

292

</div>

293

</body>

294

</html>

b'\\ No newline at end of file'

Older »