.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH IPENGINE "1" "September 2020" "ipyparallel 6.2.4" "User Commands"
.SH NAME
ipengine \- start an IPython cluster engine
.SH DESCRIPTION
Start an IPython engine for parallel computing.
.PP
IPython engines run in parallel and perform computations on behalf of a client
and controller. A controller needs to be started before the engines. The engine
can be configured using command line options or using a cluster directory.
Cluster directories contain config, log and security files and are usually
located in your ipython directory and named as "profile_name". See the `profile`
and `profile\-dir` options for details.
.PP
Options
\fB\-\-\-\-\-\-\-\fR
.PP
Arguments that take values are actually convenience aliases to full
Configurables, whose aliases are listed on the help line. For more information
on full configurables, see '\-\-help\-all'.
.PP
\fB\-\-mpi\fR
.IP
enable MPI integration
.PP
\fB\-\-log\-to\-file\fR
.IP
send log output to a file
.PP
\fB\-\-debug\fR
.IP
set log level to logging.DEBUG (maximize logging output)
.PP
\fB\-\-quiet\fR
.IP
set log level to logging.CRITICAL (minimize logging output)
.PP
\fB\-\-init\fR
.TP
Initialize profile with default config files.
This is equivalent
.IP
to running `ipython profile create <profile>` prior to startup.
.PP
\fB\-\-secure\fR
.IP
Use HMAC digests for authentication of messages.
Setting this flag will generate a new UUID to use as the HMAC key.
.PP
\fB\-\-no\-secure\fR
.IP
Don't authenticate messages.
.PP
\fB\-\-file=\fR<Unicode> (IPEngineApp.url_file)
.IP
Default: ''
The full location of the file containing the connection information for the
controller. If this is not given, the file must be in the security directory
of the cluster directory.  This location is resolved using the `profile` or
`profile_dir` options.
.PP
\fB\-c\fR <Unicode> (IPEngineApp.startup_command)
.IP
Default: ''
specify a command to be run at startup
.PP
\fB\-s\fR <Unicode> (IPEngineApp.startup_script)
.IP
Default: ''
specify a script to be run at startup
.PP
\fB\-\-url=\fR<Unicode> (EngineFactory.url)
.IP
Default: ''
The 0MQ url used for registration. This sets transport, ip, and port in one
variable. For example: url='tcp://127.0.0.1:12345' or url='epgm://*:90210'
.PP
\fB\-\-ssh=\fR<Unicode> (EngineFactory.sshserver)
.IP
Default: ''
The SSH server to use for tunneling connections to the Controller.
.PP
\fB\-\-sshkey=\fR<Unicode> (EngineFactory.sshkey)
.IP
Default: ''
The SSH private key file to use when tunneling connections to the
Controller.
.PP
\fB\-\-ip=\fR<Unicode> (EngineFactory.ip)
.IP
Default: ''
The IP address for registration.  This is generally either '127.0.0.1' for
loopback only or '*' for all interfaces.
.PP
\fB\-\-transport=\fR<Unicode> (EngineFactory.transport)
.IP
Default: 'tcp'
The 0MQ transport for communications.  This will likely be the default of
\&'tcp', but other values include 'ipc', 'epgm', 'inproc'.
.PP
\fB\-\-port=\fR<Int> (EngineFactory.regport)
.IP
Default: 0
The port on which the Hub listens for registration.
.PP
\fB\-\-location=\fR<Unicode> (EngineFactory.location)
.IP
Default: ''
The location (an IP address) of the controller.  This is used for
disambiguating URLs, to determine whether loopback should be used to connect
or the public address.
.PP
\fB\-\-timeout=\fR<Float> (EngineFactory.timeout)
.IP
Default: 5.0
The time (in seconds) to wait for the Controller to respond to registration
requests before giving up.
.PP
\fB\-\-profile\-dir=\fR<Unicode> (ProfileDir.location)
.IP
Default: ''
Set the profile location directly. This overrides the logic used by the
`profile` option.
.PP
\fB\-\-profile=\fR<Unicode> (BaseIPythonApplication.profile)
.IP
Default: 'default'
The IPython profile to use.
.PP
\fB\-\-ipython\-dir=\fR<Unicode> (BaseIPythonApplication.ipython_dir)
.IP
Default: ''
The name of the IPython directory. This directory is used for logging
configuration (through profiles), history storage, etc. The default is
usually $HOME/.ipython. This option can also be specified through the
environment variable IPYTHONDIR.
.PP
\fB\-\-log\-level=\fR<Enum> (Application.log_level)
.IP
Default: 30
Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL')
Set the log level by value or name.
.PP
\fB\-\-config=\fR<Unicode> (BaseIPythonApplication.extra_config_file)
.IP
Default: ''
Path to an extra config file to load.
If specified, load this config file in addition to any other IPython config.
.PP
\fB\-\-work\-dir=\fR<Unicode> (BaseParallelApplication.work_dir)
.IP
Default: '/home/joe'
Set the working dir for the process.
.PP
\fB\-\-log\-to\-file=\fR<Bool> (BaseParallelApplication.log_to_file)
.IP
Default: False
whether to log to a file
.PP
\fB\-\-clean\-logs=\fR<Bool> (BaseParallelApplication.clean_logs)
.IP
Default: False
whether to cleanup old logfiles before starting
.PP
\fB\-\-log\-url=\fR<Unicode> (BaseParallelApplication.log_url)
.IP
Default: ''
The ZMQ URL of the iplogger to aggregate logging.
.PP
\fB\-\-cluster\-id=\fR<Unicode> (BaseParallelApplication.cluster_id)
.IP
Default: ''
String id to add to runtime files, to prevent name collisions when using
multiple clusters with a single profile simultaneously.
When set, files will be named like: 'ipcontroller\-<cluster_id>\-engine.json'
Since this is text inserted into filenames, typical recommendations apply:
Simple character strings are ideal, and spaces are not recommended (but
should generally work).
.PP
\fB\-\-ident=\fR<CUnicode> (Session.session)
.IP
Default: ''
The UUID identifying this session.
.PP
\fB\-\-user=\fR<Unicode> (Session.username)
.IP
Default: 'joe'
Username for the Session. Default is your system username.
.PP
\fB\-\-keyfile=\fR<Unicode> (Session.keyfile)
.IP
Default: ''
path to file containing execution key.
.PP
To see all available configurables, use \fB\-\-help\-all\fR.
.SH EXAMPLES
.TP
ipengine \fB\-\-ip\fR=\fI\,192\/.168.0.1\fR \fB\-\-port\fR=\fI\,1000\/\fR
# connect to hub at ip and port
.TP
ipengine \fB\-\-log\-to\-file\fR \fB\-\-log\-level\fR=\fI\,DEBUG\/\fR
# log to a file with DEBUG verbosity