Show More
@@ -0,0 +1,57 b'' | |||||
|
1 | .TH IPCLUSTER 1 "October 28, 2008" "" "" | |||
|
2 | .SH NAME | |||
|
3 | \fBipcluster \- IPython parallel computing cluster control tool | |||
|
4 | .SH SYNOPSIS | |||
|
5 | .nf | |||
|
6 | .fam C | |||
|
7 | \fBipcluster\fP [\fIoptions\fP] | |||
|
8 | .fam T | |||
|
9 | .fi | |||
|
10 | .SH DESCRIPTION | |||
|
11 | ipcluster is a control tool for IPython's parallel computing functions. | |||
|
12 | .SH OPTIONS | |||
|
13 | .TP | |||
|
14 | .B | |||
|
15 | \-h, \-\-help | |||
|
16 | show this help message and exit | |||
|
17 | .TP | |||
|
18 | .B | |||
|
19 | \-\-controller\-port=CONTROLLERPORT | |||
|
20 | the TCP port the controller is listening on | |||
|
21 | .TP | |||
|
22 | .B | |||
|
23 | \-\-controller\-ip=CONTROLLERIP | |||
|
24 | the TCP IP address of the controller | |||
|
25 | .TP | |||
|
26 | .B | |||
|
27 | \-n, \-\-num=N | |||
|
28 | the number of engines to start | |||
|
29 | .TP | |||
|
30 | .B | |||
|
31 | \-\-engine\-port=ENGINEPORT | |||
|
32 | the TCP port the controller will listen on for engine connections | |||
|
33 | .TP | |||
|
34 | .B | |||
|
35 | \-\-mpi=MPI | |||
|
36 | use mpi with package: for instance --mpi=mpi4py | |||
|
37 | .TP | |||
|
38 | .B | |||
|
39 | \-l LOGFILE, \-\-logfile=LOGFILE | |||
|
40 | log file name | |||
|
41 | .TP | |||
|
42 | .B | |||
|
43 | \-f CLUSTERFILE, \-\-cluster\-file=CLUSTERFILE | |||
|
44 | file describing a remote cluster | |||
|
45 | .SH EXAMPLE | |||
|
46 | ipcluster -n 4 | |||
|
47 | ||||
|
48 | This command will start 4 IPython engines. | |||
|
49 | .SH SEE ALSO | |||
|
50 | .BR ipython(1), ipcontroller(1), ipengine(1) | |||
|
51 | .br | |||
|
52 | .SH AUTHOR | |||
|
53 | \fBipcluster\fP is a tool that ships with IPython, created by | |||
|
54 | the IPython Development Team. | |||
|
55 | .PP | |||
|
56 | This manual page was written by Stephan Peijnik <debian@sp.or.at>, | |||
|
57 | for the Debian project (but may be used by others). |
@@ -0,0 +1,86 b'' | |||||
|
1 | .TH IPCONTROLLER 1 "October 29, 2008" "" "" | |||
|
2 | .SH NAME | |||
|
3 | \fBipcontroller \- IPython parallel computing controller control tool | |||
|
4 | .SH SYNOPSIS | |||
|
5 | .nf | |||
|
6 | .fam C | |||
|
7 | \fBipengine\fP [\fIoptions\fP] | |||
|
8 | .fam T | |||
|
9 | .fi | |||
|
10 | .SH DESCRIPTION | |||
|
11 | ipcontroller is a control tool for IPython's parallel computing functions. | |||
|
12 | .SH OPTIONS | |||
|
13 | .TP | |||
|
14 | .B | |||
|
15 | \-h, \-\-help | |||
|
16 | show this help message and exit | |||
|
17 | .TP | |||
|
18 | .B | |||
|
19 | \-\-client\-ip=CLIENT_IP | |||
|
20 | the IP address or hostname the controller will listen on for | |||
|
21 | client connections | |||
|
22 | .TP | |||
|
23 | .B | |||
|
24 | \-\-client\-port=CLIENT_PORT | |||
|
25 | the port the controller will listen on for client connections | |||
|
26 | .TP | |||
|
27 | .B | |||
|
28 | \-\-client\-location=CLIENT_LOCATION | |||
|
29 | hostname or ip for clients to connect to | |||
|
30 | .TP | |||
|
31 | .B | |||
|
32 | \-x | |||
|
33 | turn off all client security | |||
|
34 | .TP | |||
|
35 | .B | |||
|
36 | \-\-client\-cert\-file=CLIENT_CERT_FILE | |||
|
37 | file to store the client SSL certificate | |||
|
38 | .TP | |||
|
39 | .B | |||
|
40 | \-\-task\-furl\-file=TASK_FURL_FILE | |||
|
41 | file to store the FURL for task clients to connect with | |||
|
42 | .TP | |||
|
43 | .B | |||
|
44 | \-\-multiengine\-furl\-file=MULTIENGINE_FURL_FILE | |||
|
45 | file to store the FURL for multiengine clients to connect with | |||
|
46 | .TP | |||
|
47 | .B | |||
|
48 | \-\-engine\-ip=ENGINE_IP | |||
|
49 | the IP address or hostname the controller will listen on for engine connections | |||
|
50 | .TP | |||
|
51 | .B | |||
|
52 | \-\-engine\-port=ENGINE_PORT | |||
|
53 | the port the controller will listen on for engine connections | |||
|
54 | .TP | |||
|
55 | .B | |||
|
56 | \-\-engine\-location=ENGINE_LOCATION | |||
|
57 | the IP address or hostname for engine to connect to | |||
|
58 | .TP | |||
|
59 | .B | |||
|
60 | \-y | |||
|
61 | turn off all engine security | |||
|
62 | .TP | |||
|
63 | .B | |||
|
64 | \-\-engine\-cert\-file=ENGINE_CERT_FILE | |||
|
65 | file to store the engine SSL certificate | |||
|
66 | .TP | |||
|
67 | .B | |||
|
68 | \-\-engine\-furl\-file=ENGINE_FURL_FILE | |||
|
69 | file to store the FURL for engines to connect with | |||
|
70 | .TP | |||
|
71 | .B | |||
|
72 | \-l LOGFILE, \-\-logfile=LOGFILE | |||
|
73 | log file name (default is stdout) | |||
|
74 | .TP | |||
|
75 | .B | |||
|
76 | \-\-ipythondir=IPYTHONDIR | |||
|
77 | look for config files and profiles in this directory | |||
|
78 | .SH SEE ALSO | |||
|
79 | .BR ipython(1), ipcluster(1), ipengine(1) | |||
|
80 | .br | |||
|
81 | .SH AUTHOR | |||
|
82 | \fBipcontroller\fP is a tool that ships with IPython, created by | |||
|
83 | the IPython Development Team. | |||
|
84 | .PP | |||
|
85 | This manual page was written by Stephan Peijnik <debian@sp.or.at>, | |||
|
86 | for the Debian project (but may be used by others). |
@@ -0,0 +1,41 b'' | |||||
|
1 | .TH IPENGINE 1 "October 28, 2008" "" "" | |||
|
2 | .SH NAME | |||
|
3 | \fBipengine \- IPython parallel computing engine control tool | |||
|
4 | .SH SYNOPSIS | |||
|
5 | .nf | |||
|
6 | .fam C | |||
|
7 | \fBipengine\fP [\fIoptions\fP] | |||
|
8 | .fam T | |||
|
9 | .fi | |||
|
10 | .SH DESCRIPTION | |||
|
11 | ipengine is a control tool for IPython's parallel computing functions. | |||
|
12 | .SH OPTIONS | |||
|
13 | .TP | |||
|
14 | .B | |||
|
15 | \-h, \-\-help | |||
|
16 | show this help message and exit | |||
|
17 | .TP | |||
|
18 | .B | |||
|
19 | \-\-furl\-file=FURL_FILE | |||
|
20 | The filename containing the FURL of the controller | |||
|
21 | .TP | |||
|
22 | .B | |||
|
23 | \-\-mpi=MPI | |||
|
24 | How to enable MPI (mpi4py, pytrilions, or empty string to disable) | |||
|
25 | .TP | |||
|
26 | .B | |||
|
27 | \-l LOGFILE, \-\-logfile=LOGFILE | |||
|
28 | log file name (defaults to stdout) | |||
|
29 | .TP | |||
|
30 | .B | |||
|
31 | \-\-ipythondir=IPYTHONDIR | |||
|
32 | look for config files and profiles in this directory | |||
|
33 | .SH SEE ALSO | |||
|
34 | .BR ipython(1), ipcluster(1), ipcontroller(1) | |||
|
35 | .br | |||
|
36 | .SH AUTHOR | |||
|
37 | \fBipengine\fP is a tool that ships with IPython, created by | |||
|
38 | the IPython Development Team. | |||
|
39 | .PP | |||
|
40 | This manual page was written by Stephan Peijnik <debian@sp.or.at>, | |||
|
41 | for the Debian project (but may be used by others). |
@@ -0,0 +1,25 b'' | |||||
|
1 | .TH IPYTHON-WX 1 "October 29, 2008" "" "" | |||
|
2 | .SH NAME | |||
|
3 | \fBipython-wx \- Graphical frontend that embeds a multithreaded IPython Shell | |||
|
4 | .SH SYNOPSIS | |||
|
5 | .nf | |||
|
6 | .fam C | |||
|
7 | \fBipython-wx\fP | |||
|
8 | .fam T | |||
|
9 | .fi | |||
|
10 | .SH DESCRIPTION | |||
|
11 | ipython-wx is, compared to ipythonx, a more advanced graphical frontend | |||
|
12 | to IPython. It is implemented using WxWidgets. | |||
|
13 | .SH OPTIONS | |||
|
14 | .TP | |||
|
15 | .B | |||
|
16 | ipython-wx does not accept any command line options. | |||
|
17 | .SH SEE ALSO | |||
|
18 | .BR ipython(1), ipythonx(1) | |||
|
19 | .br | |||
|
20 | .SH AUTHOR | |||
|
21 | \fBipython-wx\fP is a tool that ships with IPython, created by | |||
|
22 | the IPython Development Team. | |||
|
23 | .PP | |||
|
24 | This manual page was written by Stephan Peijnik <debian@sp.or.at>, | |||
|
25 | for the Debian project (but may be used by others). |
@@ -0,0 +1,30 b'' | |||||
|
1 | .TH IPYTHONX 1 "October 29, 2008" "" "" | |||
|
2 | .SH NAME | |||
|
3 | \fBipythonx \- Simple graphical frontend to IPython, using WxWidgets. | |||
|
4 | .SH SYNOPSIS | |||
|
5 | .nf | |||
|
6 | .fam C | |||
|
7 | \fBipengine\fP [\fIoptions\fP] | |||
|
8 | .fam T | |||
|
9 | .fi | |||
|
10 | .SH DESCRIPTION | |||
|
11 | ipythonx is a simple graphical frontend to IPython, using WxWidgets. | |||
|
12 | .SH OPTIONS | |||
|
13 | .TP | |||
|
14 | .B | |||
|
15 | \-h, \-\-help | |||
|
16 | show this help message and exit | |||
|
17 | .TP | |||
|
18 | .B | |||
|
19 | \-d, \-\-debug | |||
|
20 | Enable debug messages for the wx frontend. | |||
|
21 | look for config files and profiles in this directory | |||
|
22 | .SH SEE ALSO | |||
|
23 | .BR ipython(1), ipython-wx(1) | |||
|
24 | .br | |||
|
25 | .SH AUTHOR | |||
|
26 | \fBipythonx\fP is a tool that ships with IPython, created by | |||
|
27 | the IPython Development Team. | |||
|
28 | .PP | |||
|
29 | This manual page was written by Stephan Peijnik <debian@sp.or.at>, | |||
|
30 | for the Debian project (but may be used by others). |
@@ -0,0 +1,52 b'' | |||||
|
1 | .TH IRUNNER 1 "April 24, 2007" "" "" | |||
|
2 | .SH NAME | |||
|
3 | \fBirunner \- interactive runner interface | |||
|
4 | .SH SYNOPSIS | |||
|
5 | .nf | |||
|
6 | .fam C | |||
|
7 | \fBirunner\fP [\fIoptions\fP] \fIfile_to_run\fP | |||
|
8 | .fam T | |||
|
9 | .fi | |||
|
10 | .SH DESCRIPTION | |||
|
11 | irunner is an interface to the various interactive runners | |||
|
12 | available in IPython's \fBirunner\fP module. | |||
|
13 | .PP | |||
|
14 | The already implemented runners are listed below; adding | |||
|
15 | one for a new program is a trivial task, see the source | |||
|
16 | for examples. | |||
|
17 | .SH OPTIONS | |||
|
18 | .TP | |||
|
19 | .B | |||
|
20 | \-h, \-\-help | |||
|
21 | show this help message and exit | |||
|
22 | .TP | |||
|
23 | .B | |||
|
24 | \-\-ipython | |||
|
25 | IPython interactive runner (default). | |||
|
26 | .TP | |||
|
27 | .B | |||
|
28 | \-\-python | |||
|
29 | Python interactive runner. | |||
|
30 | .TP | |||
|
31 | .B | |||
|
32 | \-\-sage | |||
|
33 | SAGE interactive runner. | |||
|
34 | .SH EXAMPLE | |||
|
35 | irunner.py \-\-python \-\- \-\-help | |||
|
36 | will pass \-\-help to the python runner. | |||
|
37 | Similarly, | |||
|
38 | irunner.py \-\-ipython \-\- \-\-interact script.ipy | |||
|
39 | .SH SEE ALSO | |||
|
40 | .BR ipython(1) | |||
|
41 | .br | |||
|
42 | .SH BUGS | |||
|
43 | The SAGE runner only works if you manually configure your SAGE | |||
|
44 | copy to use 'colors NoColor' in the ipythonrc config file, since | |||
|
45 | currently the prompt matching regexp does not identify color sequences. | |||
|
46 | .SH AUTHOR | |||
|
47 | \fBirunner\fP is an extension of Ken Schutte <kschutte-AT-csail.mit.edu>'s | |||
|
48 | script contributed on the ipython-user list: | |||
|
49 | http://scipy.net/pipermail/ipython-user/2006-May/001705.html | |||
|
50 | .PP | |||
|
51 | This manual page was written by Bernd Zeimetz <bernd@bzed.de>, | |||
|
52 | for the Debian project (but may be used by others). |
General Comments 0
You need to be logged in to leave comments.
Login now