##// END OF EJS Templates
Added better documentation to command line programs.
Brian Granger -
Show More
@@ -171,10 +171,22 b' class IPClusterCLLoader(ArgParseConfigLoader):'
171 171 default_config_file_name = u'ipcluster_config.py'
172 172
173 173
174 _description = """Start an IPython cluster for parallel computing.\n\n
175
176 An IPython cluster consists of 1 controller and 1 or more engines.
177 This command automates the startup of these processes using a wide
178 range of startup methods (SSH, local processes, PBS, mpiexec,
179 Windows HPC Server 2008). To start a cluster with 4 engines on your
180 local host simply do "ipcluster start -n 4". For more complex usage
181 you will typically do "ipcluster create -p mycluster", then edit
182 configuration files, followed by "ipcluster start -p mycluster -n 4".
183 """
184
185
174 186 class IPClusterApp(ApplicationWithClusterDir):
175 187
176 188 name = u'ipcluster'
177 description = 'Start an IPython cluster (controller and engines).'
189 description = _description
178 190 config_file_name = default_config_file_name
179 191 default_log_level = logging.INFO
180 192 auto_create_cluster_dir = False
@@ -176,13 +176,23 b' class IPControllerAppCLConfigLoader(AppWithClusterDirArgParseConfigLoader):'
176 176 arguments = cl_args
177 177
178 178
179 _description = """Start the IPython controller for parallel computing.
180
181 The IPython controller provides a gateway between the IPython engines and
182 clients. The controller needs to be started before the engines and can be
183 configured using command line options or using a cluster directory. Cluster
184 directories contain config, log and security files and are usually located in
185 your .ipython directory and named as "cluster_<profile>". See the --profile
186 and --cluster-dir options for details.
187 """
188
179 189 default_config_file_name = u'ipcontroller_config.py'
180 190
181 191
182 192 class IPControllerApp(ApplicationWithClusterDir):
183 193
184 194 name = u'ipcontroller'
185 description = 'Start the IPython controller for parallel computing.'
195 description = _description
186 196 config_file_name = default_config_file_name
187 197 auto_create_cluster_dir = True
188 198
@@ -87,10 +87,21 b' mpi.size = 0'
87 87 default_config_file_name = u'ipengine_config.py'
88 88
89 89
90 _description = """Start an IPython engine for parallel computing.\n\n
91
92 IPython engines run in parallel and perform computations on behalf of a client
93 and controller. A controller needs to be started before the engines. The
94 engine can be configured using command line options or using a cluster
95 directory. Cluster directories contain config, log and security files and are
96 usually located in your .ipython directory and named as "cluster_<profile>".
97 See the --profile and --cluster-dir options for details.
98 """
99
100
90 101 class IPEngineApp(ApplicationWithClusterDir):
91 102
92 103 name = u'ipengine'
93 description = 'Start the IPython engine for parallel computing.'
104 description = _description
94 105 config_file_name = default_config_file_name
95 106 auto_create_cluster_dir = True
96 107
General Comments 0
You need to be logged in to leave comments. Login now