Show More
@@ -156,7 +156,7 b' To connect and authenticate to the controller an engine or client needs' | |||||
156 | some information that the controller has stored in a JSON file. |
|
156 | some information that the controller has stored in a JSON file. | |
157 | Thus, the JSON files need to be copied to a location where |
|
157 | Thus, the JSON files need to be copied to a location where | |
158 | the clients and engines can find them. Typically, this is the |
|
158 | the clients and engines can find them. Typically, this is the | |
159 |
:file:`~/.ipython/ |
|
159 | :file:`~/.ipython/profile_default/security` directory on the host where the | |
160 | client/engine is running (which could be a different host than the controller). |
|
160 | client/engine is running (which could be a different host than the controller). | |
161 | Once the JSON files are copied over, everything should work fine. |
|
161 | Once the JSON files are copied over, everything should work fine. | |
162 |
|
162 | |||
@@ -218,7 +218,7 b' everything is working correctly, try the following commands:' | |||||
218 |
|
218 | |||
219 |
|
219 | |||
220 | When a client is created with no arguments, the client tries to find the corresponding JSON file |
|
220 | When a client is created with no arguments, the client tries to find the corresponding JSON file | |
221 |
in the local `~/.ipython/ |
|
221 | in the local `~/.ipython/profile_default/security` directory. Or if you specified a profile, | |
222 | you can use that with the Client. This should cover most cases: |
|
222 | you can use that with the Client. This should cover most cases: | |
223 |
|
223 | |||
224 | .. sourcecode:: ipython |
|
224 | .. sourcecode:: ipython |
@@ -37,7 +37,7 b' module and then create a :class:`.Client` instance:' | |||||
37 | In [2]: rc = Client() |
|
37 | In [2]: rc = Client() | |
38 |
|
38 | |||
39 | This form assumes that the default connection information (stored in |
|
39 | This form assumes that the default connection information (stored in | |
40 |
:file:`ipcontroller-client.json` found in :file:`IPYTHON_DIR/ |
|
40 | :file:`ipcontroller-client.json` found in :file:`IPYTHON_DIR/profile_default/security`) is | |
41 | accurate. If the controller was started on a remote machine, you must copy that connection |
|
41 | accurate. If the controller was started on a remote machine, you must copy that connection | |
42 | file to the client machine, or enter its contents as arguments to the Client constructor: |
|
42 | file to the client machine, or enter its contents as arguments to the Client constructor: | |
43 |
|
43 |
@@ -39,13 +39,13 b' hosts ``host1``-``hostn``. The following steps are then required:' | |||||
39 | (:file:`ipcontroller-engine.json`) is located. |
|
39 | (:file:`ipcontroller-engine.json`) is located. | |
40 |
|
40 | |||
41 | At this point, the controller and engines will be connected. By default, the JSON files |
|
41 | At this point, the controller and engines will be connected. By default, the JSON files | |
42 |
created by the controller are put into the :file:`~/.ipython/ |
|
42 | created by the controller are put into the :file:`~/.ipython/profile_default/security` | |
43 | directory. If the engines share a filesystem with the controller, step 2 can be skipped as |
|
43 | directory. If the engines share a filesystem with the controller, step 2 can be skipped as | |
44 | the engines will automatically look at that location. |
|
44 | the engines will automatically look at that location. | |
45 |
|
45 | |||
46 | The final step required to actually use the running controller from a client is to move |
|
46 | The final step required to actually use the running controller from a client is to move | |
47 | the JSON file :file:`ipcontroller-client.json` from ``host0`` to any host where clients |
|
47 | the JSON file :file:`ipcontroller-client.json` from ``host0`` to any host where clients | |
48 |
will be run. If these file are put into the :file:`~/.ipython/ |
|
48 | will be run. If these file are put into the :file:`~/.ipython/profile_default/security` | |
49 | directory of the client's host, they will be found automatically. Otherwise, the full path |
|
49 | directory of the client's host, they will be found automatically. Otherwise, the full path | |
50 | to them has to be passed to the client's constructor. |
|
50 | to them has to be passed to the client's constructor. | |
51 |
|
51 | |||
@@ -94,14 +94,14 b' Cluster configurations are stored as `profiles`. You can create a new profile w' | |||||
94 |
|
94 | |||
95 | $ ipython profile create --parallel profile=myprofile |
|
95 | $ ipython profile create --parallel profile=myprofile | |
96 |
|
96 | |||
97 |
This will create the directory :file:`IPYTHONDIR/ |
|
97 | This will create the directory :file:`IPYTHONDIR/profile_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 | |
99 | you edit those files, you can continue to call ipcluster/ipcontroller/ipengine |
|
99 | you edit those files, you can continue to call ipcluster/ipcontroller/ipengine | |
100 | with no arguments beyond ``p=myprofile``, and any configuration will be maintained. |
|
100 | with no arguments beyond ``profile=myprofile``, and any configuration will be maintained. | |
101 |
|
101 | |||
102 | There is no limit to the number of profiles you can have, so you can maintain a profile for each |
|
102 | There is no limit to the number of profiles you can have, so you can maintain a profile for each | |
103 | of your common use cases. The default profile will be used whenever the |
|
103 | of your common use cases. The default profile will be used whenever the | |
104 |
profile argument is not specified, so edit :file:`IPYTHONDIR/ |
|
104 | profile argument is not specified, so edit :file:`IPYTHONDIR/profile_default/*_config.py` to | |
105 | represent your most common use case. |
|
105 | represent your most common use case. | |
106 |
|
106 | |||
107 | The configuration files are loaded with commented-out settings and explanations, |
|
107 | The configuration files are loaded with commented-out settings and explanations, | |
@@ -135,7 +135,7 b' If these are satisfied, you can create a new profile::' | |||||
135 |
|
135 | |||
136 | $ ipython profile create --parallel profile=mpi |
|
136 | $ ipython profile create --parallel profile=mpi | |
137 |
|
137 | |||
138 |
and edit the file :file:`IPYTHONDIR/ |
|
138 | and edit the file :file:`IPYTHONDIR/profile_mpi/ipcluster_config.py`. | |
139 |
|
139 | |||
140 | There, instruct ipcluster to use the MPIExec launchers by adding the lines: |
|
140 | There, instruct ipcluster to use the MPIExec launchers by adding the lines: | |
141 |
|
141 | |||
@@ -366,7 +366,7 b' a single location:' | |||||
366 |
|
366 | |||
367 | .. sourcecode:: python |
|
367 | .. sourcecode:: python | |
368 |
|
368 | |||
369 |
c.SSHEngineSetLauncher.engine_args = ['profile_dir=/path/to/ |
|
369 | c.SSHEngineSetLauncher.engine_args = ['profile_dir=/path/to/profile_ssh'] | |
370 |
|
370 | |||
371 | Current limitations of the SSH mode of :command:`ipcluster` are: |
|
371 | Current limitations of the SSH mode of :command:`ipcluster` are: | |
372 |
|
372 | |||
@@ -398,7 +398,7 b' the command::' | |||||
398 | $ ipengine |
|
398 | $ ipengine | |
399 |
|
399 | |||
400 | The engines should start and automatically connect to the controller using the |
|
400 | The engines should start and automatically connect to the controller using the | |
401 |
JSON files in :file:`~/.ipython/ |
|
401 | JSON files in :file:`~/.ipython/profile_default/security`. You are now ready to use the | |
402 | controller and engines from IPython. |
|
402 | controller and engines from IPython. | |
403 |
|
403 | |||
404 | .. warning:: |
|
404 | .. warning:: |
General Comments 0
You need to be logged in to leave comments.
Login now