<commit_before>.TH MAYAVI2 1
.SH NAME
mayavi2 \- A scientific visualization package for 2-D and 3-D data
.SH SYNOPSIS
.B mayavi2 [options]  [args]

Where arg1, arg2 etc\&. are optional file names that correspond to saved
Mayavi2 visualizations (filename\&.mv2),  Mayavi2 scripts
(filename\&.py) and any data file formats that Mayavi supports\&.

.SH "DESCRIPTION"

.PP
Mayavi2 is a tool for 2-D and 3-D scientific visualization\&. Features
of Mayavi2 include:

.PP
.IP *
Visualization of scalar and vector data in 2 and 3 dimensions
.IP *
Easy scriptability using Python 
.IP *
Easy extendability via sources, components, modules, and data filters
.IP *
Reading several file formats: VTK (legacy and XML), PLOT3D, etc\&.
.IP *
Saving of visualizations 
.IP *
Saving rendered visualization in a variety of image formats\&.


.SH "OPTIONS"
.PP
.B -h

This prints all the available command line options and exits\&.  Also
available through \fB\-\-help\fP\&.

.PP
.B -V

This prints the Mayavi version on the command line and exits\&.  Also
available through \fB\-\-version\fP\&.

.PP
.B -z filename\&.mv2

This loads a previously saved Mayavi2 visualization\&.  Also available
through \fB\-\-viz\fP filename\&.mv2 or \fB\-\-visualization\fP
filename\&.mv2\&.

.PP
.B -d
datafile\&.*

Opens any of the supported data file formats or a non-file related data
source\&.  This includes VTK file formats (*\&.vtk, *\&.xml,
*\&.vt[i,p,r,s,u], *\&.pvt[i,p,r,s,u]), VRML2 (*\&.wrl), 3D Studio
(*\&.3ds), PLOT3D (*\&.xyz), STL, BYU, RAW, PLY, PDB, SLC, FACET, OBJ,
AVSUCD (*\&.inp), GAMBIT (*\&.neu), Exodus (*\&.exii), PNG, JPEG, BMP,
PNM, DCM, DEM, MHA, MHD, MINC, XIMG, TIFF, and various others that are
supported\&.  datafile\&.* can also be a source object not associated
with a file, for example ParametricSurface or PointLoad will load the
corresponding data sources into Mayavi\&.  Also available through
\fB\-\-data\fP\&.

.PP
.B -m
module-name

A module is an object that actually visualizes the data\&.  The given
module-name is loaded in the current ModuleManager\&.  The module name
must be a valid one if not you will get an error message\&.

If a module is specified as 'package\&.sub\&.module\&.SomeModule' then the
module (SomeModule) is imported from 'package\&.sub\&.module'\&.  Standard
modules provided with mayavi2 do not need the full path
specification\&.  For example:
.PP
.RS
\f(CWmayavi2 \-d data\&.vtk \-m Outline \-m m2_user_modules\&.TestModule\fP
.RE

In this example 'Outline' is a standard module 
and 'm2_user_modules\&.TestModule' is some user defined module\&.  See
.B MAYAVI2 MODULES
section below for an exhaustive list of available modules\&.  Also
available through \fB\-\-module\fP\&.

.PP
.B -f
filter-name

A filter is an object that filters out the data in some way or the 
other\&.  The given filter-name is loaded with respect to the current
source/filter object\&.  The filter name must be a valid one if not you
will get an error message\&.

If the filter is specified as 'package\&.sub\&.filter\&.SomeFilter' then the
filter (`SomeFilter`) is imported from 'package\&.sub\&.filter'\&.  Standard
modules provided with mayavi2 do not need the full path
specification\&.  For example:
.PP
.RS
\f(CWmayavi2 \-d data\&.vtk \-f ExtractVectorNorm \-f m2_user_filters\&.TestFilter\fP
.RE

In this example 'ExtractVectorNorm' is a standard filter 
and 'm2_user_filters\&.TestFilter' is some user defined filter\&.

See
.B MAYAVI2 FILTERS
section below for an exhaustive list of available filters\&. Also
available through \fB\-\-filter\fP\&.

.PP
.B -M

Starts up a new module manager on the Mayavi pipeline\&. Also available
through \fB\-\-module\-mgr\fP\&.

.PP
.B -n

Creates a new window/scene\&. Any options passed after this will apply
to this newly created scene\&.  Also available through \fB\-\-new\-window\fP\&.

.PP
.B -t

Runs the mayavi2 test suite and exits\&.  If run as such, this runs
both the TVTK and Mayavi2 unittests\&.  If any additional arguments
are passed they are passed along to the test runner\&.  So this may be
used to run other tests as well\&.  For example:
.PP
.RS
\f(CWmayavi2 \-t enthought\&.persistence\fP
.RE

This will run just the tests inside the enthought\&.persistence
package\&.  You can also specify a directory with test files to run
with this, for example:
.PP
.RS
\f(CWmayavi2 \-t relative_path_to/integrationtests/mayavi\fP
.RE

will run the integration tests from the mayavi sources.   Also available
through \fB\-\-test\fP\&.

.PP
.B -x
script-file

This executes the given script in a namespace where we guarantee that 
the name 'mayavi' is Mayavi's script instance -- just like in the
embedded Python interpreter\&.  Also available through \fB\-\-exec\fP

.B WARNING:
Note that this uses `execfile`, so please note that
this can be dangerous if the script does something nasty!

.PP
.B -s 
python-expression

Execute the expression on the last created object\&.  For example, if
the previous object was a module, and we want to set the color of that
object one can do -s "actor\&.property\&.color = (1,0,0)".  One should
use quotes for the expression. Also available with \fB\-\-set\fP\&.  For
example: 

.PP
.RS
 \f(CWmayavi2 \-d ParametricSurface \-m Outline \\ \fP
 \f(CW \-s "actor\&.property.color = (1,0,0)" \\ \fP
 \f(CW \-s "scene.save('test\&.png', size=(800, 800))"\fP
.RE

.B WARNING:
Note that this uses `exec`, so please note that this can be dangerous!

.SH "MAYAVI2 MODULES"

.TP
.B Axes
Draws simple axes\&.

.TP
.B ContourGridPlane
A contour grid plane module\&. This module lets one take a slice of<commit_msg>DOC: Fix formatting in the man page. Thanks to <NAME> for the patch.<commit_after>.TH MAYAVI2 1
.SH NAME
mayavi2 \- A scientific visualization package for 2-D and 3-D data
.SH SYNOPSIS
.B mayavi2 [options]  [args]

Where arg1, arg2 etc\&. are optional file names that correspond to saved
Mayavi2 visualizations (filename\&.mv2),  Mayavi2 scripts
(filename\&.py) and any data file formats that Mayavi supports\&.

.SH "DESCRIPTION"

.PP
Mayavi2 is a tool for 2-D and 3-D scientific visualization\&. Features
of Mayavi2 include:

.PP
.IP *
Visualization of scalar and vector data in 2 and 3 dimensions
.IP *
Easy scriptability using Python 
.IP *
Easy extendability via sources, components, modules, and data filters
.IP *
Reading several file formats: VTK (legacy and XML), PLOT3D, etc\&.
.IP *
Saving of visualizations 
.IP *
Saving rendered visualization in a variety of image formats\&.


.SH "OPTIONS"
.PP
.B -h

This prints all the available command line options and exits\&.  Also
available through \fB\-\-help\fP\&.

.PP
.B -V

This prints the Mayavi version on the command line and exits\&.  Also
available through \fB\-\-version\fP\&.

.PP
.B -z filename\&.mv2

This loads a previously saved Mayavi2 visualization\&.  Also available
through \fB\-\-viz\fP filename\&.mv2 or \fB\-\-visualization\fP
filename\&.mv2\&.

.PP
.B -d
datafile\&.*

Opens any of the supported data file formats or a non-file related data
source\&.  This includes VTK file formats (*\&.vtk, *\&.xml,
*\&.vt[i,p,r,s,u], *\&.pvt[i,p,r,s,u]), VRML2 (*\&.wrl), 3D Studio
(*\&.3ds), PLOT3D (*\&.xyz), STL, BYU, RAW, PLY, PDB, SLC, FACET, OBJ,
AVSUCD (*\&.inp), GAMBIT (*\&.neu), Exodus (*\&.exii), PNG, JPEG, BMP,
PNM, DCM, DEM, MHA, MHD, MINC, XIMG, TIFF, and various others that are
supported\&.  datafile\&.* can also be a source object not associated
with a file, for example ParametricSurface or PointLoad will load the
corresponding data sources into Mayavi\&.  Also available through
\fB\-\-data\fP\&.

.PP
.B -m
module-name

A module is an object that actually visualizes the data\&.  The given
module-name is loaded in the current ModuleManager\&.  The module name
must be a valid one if not you will get an error message\&.

If a module is specified as 'package\&.sub\&.module\&.SomeModule' then the
module (SomeModule) is imported from 'package\&.sub\&.module'\&.  Standard
modules provided with mayavi2 do not need the full path
specification\&.  For example:
.PP
.RS
\f(CWmayavi2 \-d data\&.vtk \-m Outline \-m m2_user_modules\&.TestModule\fP
.RE

In this example 'Outline' is a standard module 
and 'm2_user_modules\&.TestModule' is some user defined module\&.  See
.B MAYAVI2 MODULES
section below for an exhaustive list of available modules\&.  Also
available through \fB\-\-module\fP\&.

.PP
.B -f
filter-name

A filter is an object that filters out the data in some way or the 
other\&.  The given filter-name is loaded with respect to the current
source/filter object\&.  The filter name must be a valid one if not you
will get an error message\&.

If the filter is specified as 'package\&.sub\&.filter\&.SomeFilter' then the
filter (`SomeFilter`) is imported from 'package\&.sub\&.filter'\&.  Standard
modules provided with mayavi2 do not need the full path
specification\&.  For example:
.PP
.RS
\f(CWmayavi2 \-d data\&.vtk \-f ExtractVectorNorm \-f m2_user_filters\&.TestFilter\fP
.RE

In this example 'ExtractVectorNorm' is a standard filter 
and 'm2_user_filters\&.TestFilter' is some user defined filter\&.

See
.B MAYAVI2 FILTERS
section below for an exhaustive list of available filters\&. Also
available through \fB\-\-filter\fP\&.

.PP
.B -M

Starts up a new module manager on the Mayavi pipeline\&. Also available
through \fB\-\-module\-mgr\fP\&.

.PP
.B -n

Creates a new window/scene\&. Any options passed after this will apply
to this newly created scene\&.  Also available through \fB\-\-new\-window\fP\&.

.PP
.B -t

Runs the mayavi2 test suite and exits\&.  If run as such, this runs
both the TVTK and Mayavi2 unittests\&.  If any additional arguments
are passed they are passed along to the test runner\&.  So this may be
used to run other tests as well\&.  For example:
.PP
.RS
\f(CWmayavi2 \-t enthought\&.persistence\fP
.RE

This will run just the tests inside the enthought\&.persistence
package\&.  You can also specify a directory with test files to run
with this, for example:
.PP
.RS
\f(CWmayavi2 \-t relative_path_to/integrationtests/mayavi\fP
.RE

will run the integration tests from the mayavi sources.   Also available
through \fB\-\-test\fP\&.

.PP
.B -x
script-file

This executes the given script in a namespace where we guarantee that 
the name 'mayavi' is Mayavi's script instance -- just like in the
embedded Python interpreter\&.  Also available through \fB\-\-exec\fP

.B WARNING:
Note that this uses `execfile`, so please note that
this can be dangerous if the script does something nasty!

.PP
.B -s 
python-expression

Execute the expression on the last created object\&.  For example, if
the previous object was a module, and we want to set the color of that
object one can do \-s "actor\&.property\&.color = (1,0,0)".  One should
use quotes for the expression. Also available with \fB\-\-set\fP\&.  For
example: 

.PP
.RS
 \f(CWmayavi2 \-d ParametricSurface \-m Outline \\ \fP
 \f(CW \-s "actor\&.property.color = (1,0,0)" \\ \fP
 \f(CW \-s "scene.save('test\&.png', size=(800, 800))"\fP
.RE

.B WARNING:
Note that this uses `exec`, so please note that this can be dangerous!

.SH "MAYAVI2 MODULES"

.TP
.B Axes
Draws simple axes\&.

.TP
.B ContourGridPlane
A contour grid plane module\&. This module lets one take a slice of
{'fraction_non_alphanumeric': 0.11588287488908607, 'fraction_numerical': 0.009582963620230702, 'mean_word_length': 3.385603112840467, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5676041', 'n_tokens_mistral': 4044, 'n_tokens_neox': 3910, 'n_words': 1609}