##// END OF EJS Templates
rename '--cluster' flag to '--parallel' in ProfileApp...
MinRK -
Show More
@@ -36,7 +36,7 b' from IPython.utils.traitlets import Unicode, Bool, Dict'
36 # Constants
36 # Constants
37 #-----------------------------------------------------------------------------
37 #-----------------------------------------------------------------------------
38
38
39 create_help = """Create an ipcluster profile by name
39 create_help = """Create an IPython profile by name
40
40
41 Create an ipython profile directory by its name or
41 Create an ipython profile directory by its name or
42 profile directory path. Profile directories contain
42 profile directory path. Profile directories contain
@@ -45,7 +45,7 b" using the convention 'profile_<name>'. By default they are"
45 located in your ipython directory. Once created, you will
45 located in your ipython directory. Once created, you will
46 can edit the configuration files in the profile
46 can edit the configuration files in the profile
47 directory to configure IPython. Most users will create a
47 directory to configure IPython. Most users will create a
48 cluster directory by profile name,
48 profile directory by name,
49 `ipython profile create myprofile`, which will put the directory
49 `ipython profile create myprofile`, which will put the directory
50 in `<ipython_dir>/profile_myprofile`.
50 in `<ipython_dir>/profile_myprofile`.
51 """
51 """
@@ -124,7 +124,7 b' create_flags = {}'
124 create_flags.update(base_flags)
124 create_flags.update(base_flags)
125 create_flags.update(boolean_flag('reset', 'ProfileCreate.overwrite',
125 create_flags.update(boolean_flag('reset', 'ProfileCreate.overwrite',
126 "reset config files to defaults", "leave existing config files"))
126 "reset config files to defaults", "leave existing config files"))
127 create_flags.update(boolean_flag('cluster', 'ProfileCreate.cluster',
127 create_flags.update(boolean_flag('parallel', 'ProfileCreate.parallel',
128 "Include parallel computing config files",
128 "Include parallel computing config files",
129 "Don't include parallel computing config files"))
129 "Don't include parallel computing config files"))
130
130
@@ -136,18 +136,18 b' class ProfileCreate(BaseIPythonApplication):'
136 def _copy_config_files_default(self):
136 def _copy_config_files_default(self):
137 return True
137 return True
138
138
139 cluster = Bool(False, config=True,
139 parallel = Bool(False, config=True,
140 help="whether to include parallel computing config files")
140 help="whether to include parallel computing config files")
141 def _cluster_changed(self, name, old, new):
141 def _parallel_changed(self, name, old, new):
142 cluster_files = [ 'ipcontroller_config.py',
142 parallel_files = [ 'ipcontroller_config.py',
143 'ipengine_config.py',
143 'ipengine_config.py',
144 'ipcluster_config.py'
144 'ipcluster_config.py'
145 ]
145 ]
146 if new:
146 if new:
147 for cf in cluster_files:
147 for cf in parallel_files:
148 self.config_files.append(cf)
148 self.config_files.append(cf)
149 else:
149 else:
150 for cf in cluster_files:
150 for cf in parallel_files:
151 if cf in self.config_files:
151 if cf in self.config_files:
152 self.config_files.remove(cf)
152 self.config_files.remove(cf)
153
153
@@ -174,7 +174,7 b' class ProfileCreate(BaseIPythonApplication):'
174 pass
174 pass
175 else:
175 else:
176 apps.append(IPythonQtConsoleApp)
176 apps.append(IPythonQtConsoleApp)
177 if self.cluster:
177 if self.parallel:
178 from IPython.parallel.apps.ipcontrollerapp import IPControllerApp
178 from IPython.parallel.apps.ipcontrollerapp import IPControllerApp
179 from IPython.parallel.apps.ipengineapp import IPEngineApp
179 from IPython.parallel.apps.ipengineapp import IPEngineApp
180 from IPython.parallel.apps.ipclusterapp import IPClusterStart
180 from IPython.parallel.apps.ipclusterapp import IPClusterStart
@@ -92,7 +92,7 b' Configuring an IPython cluster'
92
92
93 Cluster configurations are stored as `profiles`. You can create a new profile with::
93 Cluster configurations are stored as `profiles`. You can create a new profile with::
94
94
95 $ ipython profile create --cluster profile=myprofile
95 $ ipython profile create --parallel profile=myprofile
96
96
97 This will create the directory :file:`IPYTHONDIR/cluster_myprofile`, and populate it
97 This will create the directory :file:`IPYTHONDIR/cluster_myprofile`, and populate it
98 with the default configuration files for the three IPython cluster commands. Once
98 with the default configuration files for the three IPython cluster commands. Once
@@ -133,7 +133,7 b' The mpiexec/mpirun mode is useful if you:'
133
133
134 If these are satisfied, you can create a new profile::
134 If these are satisfied, you can create a new profile::
135
135
136 $ ipython profile create --cluster profile=mpi
136 $ ipython profile create --parallel profile=mpi
137
137
138 and edit the file :file:`IPYTHONDIR/cluster_mpi/ipcluster_config.py`.
138 and edit the file :file:`IPYTHONDIR/cluster_mpi/ipcluster_config.py`.
139
139
@@ -190,7 +190,7 b' The PBS mode uses the Portable Batch System [PBS]_ to start the engines.'
190
190
191 As usual, we will start by creating a fresh profile::
191 As usual, we will start by creating a fresh profile::
192
192
193 $ ipython profile create --cluster profile=pbs
193 $ ipython profile create --parallel profile=pbs
194
194
195 And in :file:`ipcluster_config.py`, we will select the PBS launchers for the controller
195 And in :file:`ipcluster_config.py`, we will select the PBS launchers for the controller
196 and engines:
196 and engines:
@@ -310,7 +310,7 b' nodes and :command:`ipcontroller` can be run remotely as well, or on localhost.'
310
310
311 As usual, we start by creating a clean profile::
311 As usual, we start by creating a clean profile::
312
312
313 $ ipython profile create --cluster profile=ssh
313 $ ipython profile create --parallel profile=ssh
314
314
315 To use this mode, select the SSH launchers in :file:`ipcluster_config.py`:
315 To use this mode, select the SSH launchers in :file:`ipcluster_config.py`:
316
316
@@ -179,7 +179,7 b' describe how to configure and run an IPython cluster on an actual compute'
179 cluster running Windows HPC Server 2008. Here is an outline of the needed
179 cluster running Windows HPC Server 2008. Here is an outline of the needed
180 steps:
180 steps:
181
181
182 1. Create a cluster profile using: ``ipython profile create --cluster profile=mycluster``
182 1. Create a cluster profile using: ``ipython profile create --parallel profile=mycluster``
183
183
184 2. Edit configuration files in the directory :file:`.ipython\\cluster_mycluster`
184 2. Edit configuration files in the directory :file:`.ipython\\cluster_mycluster`
185
185
@@ -204,7 +204,7 b' security keys. The naming convention for cluster directories is:'
204 To create a new cluster profile (named "mycluster") and the associated cluster
204 To create a new cluster profile (named "mycluster") and the associated cluster
205 directory, type the following command at the Windows Command Prompt::
205 directory, type the following command at the Windows Command Prompt::
206
206
207 ipython profile create --cluster profile=mycluster
207 ipython profile create --parallel profile=mycluster
208
208
209 The output of this command is shown in the screenshot below. Notice how
209 The output of this command is shown in the screenshot below. Notice how
210 :command:`ipcluster` prints out the location of the newly created cluster
210 :command:`ipcluster` prints out the location of the newly created cluster
General Comments 0
You need to be logged in to leave comments. Login now