upstream/ipython Files · docs/man/ipcluster.1

Merge pull request from minrk/proxylauncher...

Merge pull request from minrk/proxylauncher Incremental improvements to SSH launchers: * add to_send/fetch steps for moving connection files around. * add SSHProxyEngineSetLauncher, for invoking to `ipcluster engines` on a remote host. This can be used to start a set of engines via PBS/SGE/MPI *remotely*. This makes the SSHLauncher usable on machines without shared filesystems. When sending files, the destination directory must *already exist* - that is, `ipython profile create` may be necessary on the remote system, before the security dir exists for putting the connection file the first time.

Julian Taylor - - Load All Authors

File last commit:

r5342:0a49a993


                r6622:66e42d93

Download file

             ipcluster.1
        
                    48 lines
            
             | 1.5 KiB
            
                | application/x-troff
            
             |
                GroffLexer
            
             / docs / man / ipcluster.1
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      .TH IPCLUSTER 1 "July 15, 2011" "" ""

      .SH NAME

      \fBipcluster \- IPython parallel computing cluster control tool

      .SH SYNOPSIS

      .nf

      .fam C

      \fBipcluster\fP {\fmpiexec,local,mpirun,pbs,ssh\fP} [\fIoptions\fP]

      .fam T

      .fi

      .SH DESCRIPTION

      ipcluster is a control tool for IPython's parallel computing functions.

      IPython cluster startup. This starts a controller and engines using various

      approaches. Use the IPYTHON_DIR environment variable to change your IPython

      directory from the default of ~/.ipython or ~/.config/ipython. The log and security

      subdirectories of your IPython directory will be used by this script for log

      files and security files.

      .SH POSITIONAL ARGUMENTS

      The first positional argument should be one of: {start, stop, engines},

      which are the available subcommands.

      For detailed help on each, type "ipcluster CMD \-\-help". Briefly:

        start         start an IPython cluster

        stop          stop a running IPython cluster

        engines       add a number of engines to a running cluster

      .SH OPTIONS

      .TP

      .B

      \-h, \-\-help

      show help message and exit

      .SH EXAMPLE

      ipcluster start \-\-n=4

      This command will start 4 IPython engines on the local computer.

      .SH SEE ALSO

      .BR ipython(1),

      .BR ipcontroller(1),

      .BR ipengine(1)

      .br

      .SH AUTHOR

      \fBipcluster\fP is a tool that ships with IPython, created by

      the IPython Development Team.

      .PP

      This manual page was written by Stephan Peijnik <debian@sp.or.at>,

      for the Debian project (but may be used by others).  Modified by Fernando Perez

      <Fernando.Perez@berkeley.edu> for inclusion in IPython.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				.TH IPCLUSTER 1 "July 15, 2011" "" ""
				.SH NAME
				\fBipcluster \- IPython parallel computing cluster control tool
				.SH SYNOPSIS
				.nf
				.fam C
				\fBipcluster\fP {\fmpiexec,local,mpirun,pbs,ssh\fP} [\fIoptions\fP]
				.fam T
				.fi
				.SH DESCRIPTION
				ipcluster is a control tool for IPython's parallel computing functions.

				IPython cluster startup. This starts a controller and engines using various
				approaches. Use the IPYTHON_DIR environment variable to change your IPython
				directory from the default of ~/.ipython or ~/.config/ipython. The log and security
				subdirectories of your IPython directory will be used by this script for log
				files and security files.
				.SH POSITIONAL ARGUMENTS

				The first positional argument should be one of: {start, stop, engines},
				which are the available subcommands.

				For detailed help on each, type "ipcluster CMD \-\-help". Briefly:

				start start an IPython cluster
				stop stop a running IPython cluster
				engines add a number of engines to a running cluster
				.SH OPTIONS
				.TP
				.B
				\-h, \-\-help
				show help message and exit
				.SH EXAMPLE
				ipcluster start \-\-n=4

				This command will start 4 IPython engines on the local computer.
				.SH SEE ALSO
				.BR ipython(1),
				.BR ipcontroller(1),
				.BR ipengine(1)
				.br
				.SH AUTHOR
				\fBipcluster\fP is a tool that ships with IPython, created by
				the IPython Development Team.
				.PP
				This manual page was written by Stephan Peijnik <debian@sp.or.at>,
				for the Debian project (but may be used by others). Modified by Fernando Perez
				<Fernando.Perez@berkeley.edu> for inclusion in IPython.