##// END OF EJS Templates
Fixing command line options and help strings to use new syntax....
Brian E. Granger -
Show More
@@ -61,7 +61,7 b" default_config_file_name = u'ipython_config.py'"
61 _examples = """
61 _examples = """
62 ipython --pylab # start in pylab mode
62 ipython --pylab # start in pylab mode
63 ipython --pylab=qt # start in pylab mode with the qt4 backend
63 ipython --pylab=qt # start in pylab mode with the qt4 backend
64 ipython --log_level=DEBUG # set logging to DEBUG
64 ipython --log-level=DEBUG # set logging to DEBUG
65 ipython --profile=foo # start with profile foo
65 ipython --profile=foo # start with profile foo
66
66
67 ipython qtconsole # start the qtconsole GUI application
67 ipython qtconsole # start the qtconsole GUI application
@@ -576,7 +576,7 b' class SSHEngineLauncher(SSHLauncher):'
576 help="remote ipengine command.")
576 help="remote ipengine command.")
577 # Command line arguments for ipengine.
577 # Command line arguments for ipengine.
578 program_args = List(
578 program_args = List(
579 ['--log-to-file','log_level=%i'%logging.INFO], config=True,
579 ['--log-to-file','--log_level=%i'%logging.INFO], config=True,
580 help="Command line arguments to ipengine."
580 help="Command line arguments to ipengine."
581 )
581 )
582
582
@@ -87,7 +87,7 b' All options with a [no] prepended can be specified in negated form'
87 execute the given command string. This is similar to the -c
87 execute the given command string. This is similar to the -c
88 option in the normal Python interpreter.
88 option in the normal Python interpreter.
89
89
90 ``--cache_size=<n>``
90 ``--cache-size=<n>``
91 size of the output cache (maximum number of entries to hold in
91 size of the output cache (maximum number of entries to hold in
92 memory). The default is 1000, you can change it permanently in your
92 memory). The default is 1000, you can change it permanently in your
93 config file. Setting it to 0 completely disables the caching system,
93 config file. Setting it to 0 completely disables the caching system,
@@ -253,7 +253,7 b' to specify your own. Here is a sample PBS script template:'
253 cd $PBS_O_WORKDIR
253 cd $PBS_O_WORKDIR
254 export PATH=$HOME/usr/local/bin
254 export PATH=$HOME/usr/local/bin
255 export PYTHONPATH=$HOME/usr/local/lib/python2.7/site-packages
255 export PYTHONPATH=$HOME/usr/local/lib/python2.7/site-packages
256 /usr/local/bin/mpiexec -n {n} ipengine --profile_dir={profile_dir}
256 /usr/local/bin/mpiexec -n {n} ipengine --profile-dir={profile_dir}
257
257
258 There are a few important points about this template:
258 There are a few important points about this template:
259
259
@@ -288,7 +288,7 b' The controller template should be similar, but simpler:'
288 cd $PBS_O_WORKDIR
288 cd $PBS_O_WORKDIR
289 export PATH=$HOME/usr/local/bin
289 export PATH=$HOME/usr/local/bin
290 export PYTHONPATH=$HOME/usr/local/lib/python2.7/site-packages
290 export PYTHONPATH=$HOME/usr/local/lib/python2.7/site-packages
291 ipcontroller --profile_dir={profile_dir}
291 ipcontroller --profile-dir={profile_dir}
292
292
293
293
294 Once you have created these scripts, save them with names like
294 Once you have created these scripts, save them with names like
@@ -373,8 +373,8 b" The controller's remote location and configuration can be specified:"
373 # Set the arguments to be passed to ipcontroller
373 # Set the arguments to be passed to ipcontroller
374 # note that remotely launched ipcontroller will not get the contents of
374 # note that remotely launched ipcontroller will not get the contents of
375 # the local ipcontroller_config.py unless it resides on the *remote host*
375 # the local ipcontroller_config.py unless it resides on the *remote host*
376 # in the location specified by the `profile_dir` argument.
376 # in the location specified by the `profile-dir` argument.
377 # c.SSHControllerLauncher.program_args = ['--reuse', '--ip=*', '--profile_dir=/path/to/cd']
377 # c.SSHControllerLauncher.program_args = ['--reuse', '--ip=*', '--profile-dir=/path/to/cd']
378
378
379 .. note::
379 .. note::
380
380
@@ -390,7 +390,7 b' on that host.'
390
390
391 c.SSHEngineSetLauncher.engines = { 'host1.example.com' : 2,
391 c.SSHEngineSetLauncher.engines = { 'host1.example.com' : 2,
392 'host2.example.com' : 5,
392 'host2.example.com' : 5,
393 'host3.example.com' : (1, ['--profile_dir=/home/different/location']),
393 'host3.example.com' : (1, ['--profile-dir=/home/different/location']),
394 'host4.example.com' : 8 }
394 'host4.example.com' : 8 }
395
395
396 * The `engines` dict, where the keys are the host we want to run engines on and
396 * The `engines` dict, where the keys are the host we want to run engines on and
@@ -403,7 +403,7 b' a single location:'
403
403
404 .. sourcecode:: python
404 .. sourcecode:: python
405
405
406 c.SSHEngineSetLauncher.engine_args = ['--profile_dir=/path/to/profile_ssh']
406 c.SSHEngineSetLauncher.engine_args = ['--profile-dir=/path/to/profile_ssh']
407
407
408 Current limitations of the SSH mode of :command:`ipcluster` are:
408 Current limitations of the SSH mode of :command:`ipcluster` are:
409
409
General Comments 0
You need to be logged in to leave comments. Login now