|
|
import os
|
|
|
|
|
|
c = get_config()
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Select which launchers to use
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
# This allows you to control what method is used to start the controller
|
|
|
# and engines. The following methods are currently supported:
|
|
|
# - Start as a regular process on localhost.
|
|
|
# - Start using mpiexec.
|
|
|
# - Start using the Windows HPC Server 2008 scheduler
|
|
|
# - Start using PBS/SGE
|
|
|
# - Start using SSH
|
|
|
|
|
|
|
|
|
# The selected launchers can be configured below.
|
|
|
|
|
|
# Options are:
|
|
|
# - LocalControllerLauncher
|
|
|
# - MPIExecControllerLauncher
|
|
|
# - PBSControllerLauncher
|
|
|
# - SGEControllerLauncher
|
|
|
# - WindowsHPCControllerLauncher
|
|
|
# c.IPClusterStartApp.controller_launcher = 'IPython.parallel.apps.launcher.LocalControllerLauncher'
|
|
|
# c.IPClusterStartApp.controller_launcher = 'IPython.parallel.apps.launcher.PBSControllerLauncher'
|
|
|
|
|
|
# Options are:
|
|
|
# - LocalEngineSetLauncher
|
|
|
# - MPIExecEngineSetLauncher
|
|
|
# - PBSEngineSetLauncher
|
|
|
# - SGEEngineSetLauncher
|
|
|
# - WindowsHPCEngineSetLauncher
|
|
|
# c.IPClusterEnginesApp.engine_launcher = 'IPython.parallel.apps.launcher.LocalEngineSetLauncher'
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Application configuration
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
# The default number of engines that will be started. This is overridden by
|
|
|
# the -n command line option: "ipcluster start -n 4"
|
|
|
# c.IPClusterEnginesApp.n = 2
|
|
|
|
|
|
# Log to a file in cluster_dir/log, otherwise just log to sys.stdout.
|
|
|
# c.BaseParallelApp.log_to_file = False
|
|
|
|
|
|
# Remove old logs from cluster_dir/log before starting.
|
|
|
# c.BaseParallelApp.clean_logs = True
|
|
|
|
|
|
# The working directory for the process. The application will use os.chdir
|
|
|
# to change to this directory before starting.
|
|
|
# c.BaseParallelApp.work_dir = os.getcwd()
|
|
|
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Local process launchers
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
# The command line arguments to call the controller with.
|
|
|
# c.LocalControllerLauncher.controller_args = \
|
|
|
# ['--log-to-file','--log-level', '40']
|
|
|
|
|
|
# The working directory for the controller
|
|
|
# c.LocalEngineSetLauncher.work_dir = u''
|
|
|
|
|
|
# Command line argument passed to the engines.
|
|
|
# c.LocalEngineSetLauncher.engine_args = ['--log-to-file','--log-level', '40']
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# MPIExec launchers
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
# The mpiexec/mpirun command to use in both the controller and engines.
|
|
|
# c.MPIExecLauncher.mpi_cmd = ['mpiexec']
|
|
|
|
|
|
# Additional arguments to pass to the actual mpiexec command.
|
|
|
# c.MPIExecLauncher.mpi_args = []
|
|
|
|
|
|
# The mpiexec/mpirun command and args can be overridden if they should be different
|
|
|
# for controller and engines.
|
|
|
# c.MPIExecControllerLauncher.mpi_cmd = ['mpiexec']
|
|
|
# c.MPIExecControllerLauncher.mpi_args = []
|
|
|
# c.MPIExecEngineSetLauncher.mpi_cmd = ['mpiexec']
|
|
|
# c.MPIExecEngineSetLauncher.mpi_args = []
|
|
|
|
|
|
# The command line argument to call the controller with.
|
|
|
# c.MPIExecControllerLauncher.controller_args = \
|
|
|
# ['--log-to-file','--log-level', '40']
|
|
|
|
|
|
# Command line argument passed to the engines.
|
|
|
# c.MPIExecEngineSetLauncher.engine_args = ['--log-to-file','--log-level', '40']
|
|
|
|
|
|
# The default number of engines to start if not given elsewhere.
|
|
|
# c.MPIExecEngineSetLauncher.n = 1
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# SSH launchers
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
# ipclusterz can be used to launch controller and engines remotely via ssh.
|
|
|
# Note that currently ipclusterz does not do any file distribution, so if
|
|
|
# machines are not on a shared filesystem, config and json files must be
|
|
|
# distributed. For this reason, the reuse_files defaults to True on an
|
|
|
# ssh-launched Controller. This flag can be overridded by the program_args
|
|
|
# attribute of c.SSHControllerLauncher.
|
|
|
|
|
|
# set the ssh cmd for launching remote commands. The default is ['ssh']
|
|
|
# c.SSHLauncher.ssh_cmd = ['ssh']
|
|
|
|
|
|
# set the ssh cmd for launching remote commands. The default is ['ssh']
|
|
|
# c.SSHLauncher.ssh_args = ['tt']
|
|
|
|
|
|
# Set the user and hostname for the controller
|
|
|
# c.SSHControllerLauncher.hostname = 'controller.example.com'
|
|
|
# c.SSHControllerLauncher.user = os.environ.get('USER','username')
|
|
|
|
|
|
# Set the arguments to be passed to ipcontrollerz
|
|
|
# note that remotely launched ipcontrollerz will not get the contents of
|
|
|
# the local ipcontrollerz_config.py unless it resides on the *remote host*
|
|
|
# in the location specified by the --cluster_dir argument.
|
|
|
# c.SSHControllerLauncher.program_args = ['-r', '-ip', '0.0.0.0', '--cluster_dir', '/path/to/cd']
|
|
|
|
|
|
# Set the default args passed to ipengine for SSH launched engines
|
|
|
# c.SSHEngineSetLauncher.engine_args = ['--mpi', 'mpi4py']
|
|
|
|
|
|
# SSH engines are launched as a dict of locations/n-engines.
|
|
|
# if a value is a tuple instead of an int, it is assumed to be of the form
|
|
|
# (n, [args]), setting the arguments to passed to ipengine on `host`.
|
|
|
# otherwise, c.SSHEngineSetLauncher.engine_args will be used as the default.
|
|
|
|
|
|
# In this case, there will be 3 engines at my.example.com, and
|
|
|
# 2 at you@ipython.scipy.org with a special json connector location.
|
|
|
# c.SSHEngineSetLauncher.engines = {'my.example.com' : 3,
|
|
|
# 'you@ipython.scipy.org' : (2, ['-f', '/path/to/ipcontroller-engine.json']}
|
|
|
# }
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Unix batch (PBS) schedulers launchers
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
# SGE and PBS are very similar. All configurables in this section called 'PBS*'
|
|
|
# also exist as 'SGE*'.
|
|
|
|
|
|
# The command line program to use to submit a PBS job.
|
|
|
# c.PBSLauncher.submit_command = ['qsub']
|
|
|
|
|
|
# The command line program to use to delete a PBS job.
|
|
|
# c.PBSLauncher.delete_command = ['qdel']
|
|
|
|
|
|
# The PBS queue in which the job should run
|
|
|
# c.PBSLauncher.queue = 'myqueue'
|
|
|
|
|
|
# A regular expression that takes the output of qsub and find the job id.
|
|
|
# c.PBSLauncher.job_id_regexp = r'\d+'
|
|
|
|
|
|
# If for some reason the Controller and Engines have different options above, they
|
|
|
# can be set as c.PBSControllerLauncher.<option> etc.
|
|
|
|
|
|
# PBS and SGE have default templates, but you can specify your own, either as strings
|
|
|
# or from files, as described here:
|
|
|
|
|
|
# The batch submission script used to start the controller. This is where
|
|
|
# environment variables would be setup, etc. This string is interpreted using
|
|
|
# Python's string formatting. Basically, you can use {queue} for the name
|
|
|
# of the PBS queue, and {profile_dir} for the profile_dir.
|
|
|
# c.PBSControllerLauncher.batch_template = """
|
|
|
# #PBS -N ipcontroller
|
|
|
# #PBS -q {queue}
|
|
|
#
|
|
|
# ipcontroller profile_dir={profile_dir}
|
|
|
# """
|
|
|
|
|
|
# You can also load this template from a file
|
|
|
# c.PBSControllerLauncher.batch_template_file = u"/path/to/my/template.sh"
|
|
|
|
|
|
# The name of the instantiated batch script that will actually be used to
|
|
|
# submit the job. This will be written to the cluster directory.
|
|
|
# c.PBSControllerLauncher.batch_file_name = u'pbs_controller'
|
|
|
|
|
|
# The batch submission script used to start the engines. This is where
|
|
|
# environment variables would be setup, etc. This string is interpreted using
|
|
|
# Python's string formatting. Basically, you can use {queue} for the name
|
|
|
# of the PBS queue, and {profile_dir} for the profile_dir, and {n}
|
|
|
# for the number of engines.
|
|
|
# c.PBSEngineSetLauncher.batch_template = """
|
|
|
# #PBS -N ipengine
|
|
|
# #PBS -l nprocs={n}
|
|
|
#
|
|
|
# ipengine profile_dir={profile_dir}
|
|
|
# """
|
|
|
|
|
|
# You can also load this template from a file
|
|
|
# c.PBSControllerLauncher.batch_template_file = u"/path/to/my/template.sh"
|
|
|
|
|
|
# The name of the instantiated batch script that will actually be used to
|
|
|
# submit the job. This will be written to the cluster directory.
|
|
|
# c.PBSEngineSetLauncher.batch_file_name = u'pbs_engines'
|
|
|
|
|
|
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Windows HPC Server 2008 launcher configuration
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
# c.IPControllerJob.job_name = 'IPController'
|
|
|
# c.IPControllerJob.is_exclusive = False
|
|
|
# c.IPControllerJob.username = r'USERDOMAIN\USERNAME'
|
|
|
# c.IPControllerJob.priority = 'Highest'
|
|
|
# c.IPControllerJob.requested_nodes = ''
|
|
|
# c.IPControllerJob.project = 'MyProject'
|
|
|
|
|
|
# c.IPControllerTask.task_name = 'IPController'
|
|
|
# c.IPControllerTask.controller_cmd = [u'ipcontroller.exe']
|
|
|
# c.IPControllerTask.controller_args = ['--log-to-file', 'log_level=40']
|
|
|
# c.IPControllerTask.environment_variables = {}
|
|
|
|
|
|
# c.WindowsHPCControllerLauncher.scheduler = 'HEADNODE'
|
|
|
# c.WindowsHPCControllerLauncher.job_file_name = u'ipcontroller_job.xml'
|
|
|
|
|
|
|
|
|
# c.IPEngineSetJob.job_name = 'IPEngineSet'
|
|
|
# c.IPEngineSetJob.is_exclusive = False
|
|
|
# c.IPEngineSetJob.username = r'USERDOMAIN\USERNAME'
|
|
|
# c.IPEngineSetJob.priority = 'Highest'
|
|
|
# c.IPEngineSetJob.requested_nodes = ''
|
|
|
# c.IPEngineSetJob.project = 'MyProject'
|
|
|
|
|
|
# c.IPEngineTask.task_name = 'IPEngine'
|
|
|
# c.IPEngineTask.engine_cmd = [u'ipengine.exe']
|
|
|
# c.IPEngineTask.engine_args = ['--log-to-file', 'log_level=40']
|
|
|
# c.IPEngineTask.environment_variables = {}
|
|
|
|
|
|
# c.WindowsHPCEngineSetLauncher.scheduler = 'HEADNODE'
|
|
|
# c.WindowsHPCEngineSetLauncher.job_file_name = u'ipengineset_job.xml'
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
