1IPCLUSTER(1)                                                      IPCLUSTER(1)
2
3
4

NAME

6       ipcluster - IPython parallel computing cluster control tool
7

SYNOPSIS

9       ipcluster {piexec,local,mpirun,pbs,ssh} [options]
10

DESCRIPTION

12       ipcluster is a control tool for IPython's parallel computing functions.
13
14       IPython  cluster  startup.  This  starts a controller and engines using
15       various approaches. Use the IPYTHONDIR environment variable  to  change
16       your  IPython  directory  from the default of .ipython or _ipython. The
17       log and security subdirectories of your IPython directory will be  used
18       by this script for log files and security files.
19

POSITIONAL ARGUMENTS

21       The  first  positional  argument  should  be  one  of: {mpiexec, local,
22       mpirun, pbs, ssh}, which are the available cluster types.
23
24       For detailed help on each, type "ipcluster TYPE --help". Briefly:
25
26         local         run a local cluster
27         mpirun        run a cluster using mpirun (mpiexec also works)
28         mpiexec       run a cluster using mpiexec (mpirun also works)
29         pbs           run a pbs cluster
30         ssh           run a cluster using ssh, should have ssh-keys setup
31

OPTIONS

33       -h, --help
34              show help message and exit
35

EXAMPLE

37       ipcluster local -n 4
38
39       This command will start 4 IPython engines on the local computer.
40

SEE ALSO

42       ipython(1),ipcontroller(1),ipengine(1)
43

AUTHOR

45       ipcluster is a tool that ships with IPython,  created  by  the  IPython
46       Development Team.
47
48       This  manual page was written by Stephan Peijnik <debian@sp.or.at>, for
49       the Debian project (but may be used by others).  Modified  by  Fernando
50       Perez <Fernando.Perez@berkeley.edu> for inclusion in IPython.
51
52
53
54                               October 28, 2008                   IPCLUSTER(1)