Show More
@@ -0,0 +1,7 b'' | |||
|
1 | What's new in IPython | |
|
2 | ===================== | |
|
3 | ||
|
4 | .. toctree:: | |
|
5 | :maxdepth: 1 | |
|
6 | ||
|
7 | changes.txt |
@@ -0,0 +1,272 b'' | |||
|
1 | ============================= | |
|
2 | Basic installation of IPython | |
|
3 | ============================= | |
|
4 | ||
|
5 | Installation | |
|
6 | ============ | |
|
7 | ||
|
8 | Instant instructions | |
|
9 | -------------------- | |
|
10 | ||
|
11 | If you are of the impatient kind, under Linux/Unix simply untar/unzip | |
|
12 | the download, then install with 'python setup.py install'. Under | |
|
13 | Windows, double-click on the provided .exe binary installer. | |
|
14 | ||
|
15 | Then, take a look at Customization_ section for configuring things | |
|
16 | optimally and `Quick tips`_ for quick tips on efficient use of | |
|
17 | IPython. You can later refer to the rest of the manual for all the | |
|
18 | gory details. | |
|
19 | ||
|
20 | See the notes in upgrading_ section for upgrading IPython versions. | |
|
21 | ||
|
22 | ||
|
23 | Detailed Unix instructions (Linux, Mac OS X, etc.) | |
|
24 | ||
|
25 | For RPM based systems, simply install the supplied package in the usual | |
|
26 | manner. If you download the tar archive, the process is: | |
|
27 | ||
|
28 | 1. Unzip/untar the ipython-XXX.tar.gz file wherever you want (XXX is | |
|
29 | the version number). It will make a directory called ipython-XXX. | |
|
30 | Change into that directory where you will find the files README | |
|
31 | and setup.py. Once you've completed the installation, you can | |
|
32 | safely remove this directory. | |
|
33 | 2. If you are installing over a previous installation of version | |
|
34 | 0.2.0 or earlier, first remove your $HOME/.ipython directory, | |
|
35 | since the configuration file format has changed somewhat (the '=' | |
|
36 | were removed from all option specifications). Or you can call | |
|
37 | ipython with the -upgrade option and it will do this automatically | |
|
38 | for you. | |
|
39 | 3. IPython uses distutils, so you can install it by simply typing at | |
|
40 | the system prompt (don't type the $):: | |
|
41 | ||
|
42 | $ python setup.py install | |
|
43 | ||
|
44 | Note that this assumes you have root access to your machine. If | |
|
45 | you don't have root access or don't want IPython to go in the | |
|
46 | default python directories, you'll need to use the ``--home`` option | |
|
47 | (or ``--prefix``). For example:: | |
|
48 | ||
|
49 | $ python setup.py install --home $HOME/local | |
|
50 | ||
|
51 | will install IPython into $HOME/local and its subdirectories | |
|
52 | (creating them if necessary). | |
|
53 | You can type:: | |
|
54 | ||
|
55 | $ python setup.py --help | |
|
56 | ||
|
57 | for more details. | |
|
58 | ||
|
59 | Note that if you change the default location for ``--home`` at | |
|
60 | installation, IPython may end up installed at a location which is | |
|
61 | not part of your $PYTHONPATH environment variable. In this case, | |
|
62 | you'll need to configure this variable to include the actual | |
|
63 | directory where the IPython/ directory ended (typically the value | |
|
64 | you give to ``--home`` plus /lib/python). | |
|
65 | ||
|
66 | ||
|
67 | Mac OSX information | |
|
68 | ------------------- | |
|
69 | ||
|
70 | Under OSX, there is a choice you need to make. Apple ships its own build | |
|
71 | of Python, which lives in the core OSX filesystem hierarchy. You can | |
|
72 | also manually install a separate Python, either purely by hand | |
|
73 | (typically in /usr/local) or by using Fink, which puts everything under | |
|
74 | /sw. Which route to follow is a matter of personal preference, as I've | |
|
75 | seen users who favor each of the approaches. Here I will simply list the | |
|
76 | known installation issues under OSX, along with their solutions. | |
|
77 | ||
|
78 | This page: http://geosci.uchicago.edu/~tobis/pylab.html contains | |
|
79 | information on this topic, with additional details on how to make | |
|
80 | IPython and matplotlib play nicely under OSX. | |
|
81 | ||
|
82 | To run IPython and readline on OSX "Leopard" system python, see the | |
|
83 | wiki page at http://ipython.scipy.org/moin/InstallationOSXLeopard | |
|
84 | ||
|
85 | ||
|
86 | GUI problems | |
|
87 | ------------ | |
|
88 | ||
|
89 | The following instructions apply to an install of IPython under OSX from | |
|
90 | unpacking the .tar.gz distribution and installing it for the default | |
|
91 | Python interpreter shipped by Apple. If you are using a fink install, | |
|
92 | fink will take care of these details for you, by installing IPython | |
|
93 | against fink's Python. | |
|
94 | ||
|
95 | IPython offers various forms of support for interacting with graphical | |
|
96 | applications from the command line, from simple Tk apps (which are in | |
|
97 | principle always supported by Python) to interactive control of WX, Qt | |
|
98 | and GTK apps. Under OSX, however, this requires that ipython is | |
|
99 | installed by calling the special pythonw script at installation time, | |
|
100 | which takes care of coordinating things with Apple's graphical environment. | |
|
101 | ||
|
102 | So when installing under OSX, it is best to use the following command:: | |
|
103 | ||
|
104 | $ sudo pythonw setup.py install --install-scripts=/usr/local/bin | |
|
105 | ||
|
106 | or | |
|
107 | ||
|
108 | $ sudo pythonw setup.py install --install-scripts=/usr/bin | |
|
109 | ||
|
110 | depending on where you like to keep hand-installed executables. | |
|
111 | ||
|
112 | The resulting script will have an appropriate shebang line (the first | |
|
113 | line in the script whic begins with #!...) such that the ipython | |
|
114 | interpreter can interact with the OS X GUI. If the installed version | |
|
115 | does not work and has a shebang line that points to, for example, just | |
|
116 | /usr/bin/python, then you might have a stale, cached version in your | |
|
117 | build/scripts-<python-version> directory. Delete that directory and | |
|
118 | rerun the setup.py. | |
|
119 | ||
|
120 | It is also a good idea to use the special flag ``--install-scripts`` as | |
|
121 | indicated above, to ensure that the ipython scripts end up in a location | |
|
122 | which is part of your $PATH. Otherwise Apple's Python will put the | |
|
123 | scripts in an internal directory not available by default at the command | |
|
124 | line (if you use /usr/local/bin, you need to make sure this is in your | |
|
125 | $PATH, which may not be true by default). | |
|
126 | ||
|
127 | ||
|
128 | Readline problems | |
|
129 | ----------------- | |
|
130 | ||
|
131 | By default, the Python version shipped by Apple does not include the | |
|
132 | readline library, so central to IPython's behavior. If you install | |
|
133 | IPython against Apple's Python, you will not have arrow keys, tab | |
|
134 | completion, etc. For Mac OSX 10.3 (Panther), you can find a prebuilt | |
|
135 | readline library here: | |
|
136 | http://pythonmac.org/packages/readline-5.0-py2.3-macosx10.3.zip | |
|
137 | ||
|
138 | If you are using OSX 10.4 (Tiger), after installing this package you | |
|
139 | need to either: | |
|
140 | ||
|
141 | 1. move readline.so from /Library/Python/2.3 to | |
|
142 | /Library/Python/2.3/site-packages, or | |
|
143 | 2. install http://pythonmac.org/packages/TigerPython23Compat.pkg.zip | |
|
144 | ||
|
145 | Users installing against Fink's Python or a properly hand-built one | |
|
146 | should not have this problem. | |
|
147 | ||
|
148 | ||
|
149 | DarwinPorts | |
|
150 | ----------- | |
|
151 | ||
|
152 | I report here a message from an OSX user, who suggests an alternative | |
|
153 | means of using IPython under this operating system with good results. | |
|
154 | Please let me know of any updates that may be useful for this section. | |
|
155 | His message is reproduced verbatim below: | |
|
156 | ||
|
157 | From: Markus Banfi <markus.banfi-AT-mospheira.net> | |
|
158 | ||
|
159 | As a MacOS X (10.4.2) user I prefer to install software using | |
|
160 | DawinPorts instead of Fink. I had no problems installing ipython | |
|
161 | with DarwinPorts. It's just: | |
|
162 | ||
|
163 | sudo port install py-ipython | |
|
164 | ||
|
165 | It automatically resolved all dependencies (python24, readline, | |
|
166 | py-readline). So far I did not encounter any problems with the | |
|
167 | DarwinPorts port of ipython. | |
|
168 | ||
|
169 | ||
|
170 | ||
|
171 | Windows instructions | |
|
172 | -------------------- | |
|
173 | ||
|
174 | Some of IPython's very useful features are: | |
|
175 | ||
|
176 | * Integrated readline support (Tab-based file, object and attribute | |
|
177 | completion, input history across sessions, editable command line, | |
|
178 | etc.) | |
|
179 | * Coloring of prompts, code and tracebacks. | |
|
180 | ||
|
181 | .. _pyreadline: | |
|
182 | ||
|
183 | These, by default, are only available under Unix-like operating systems. | |
|
184 | However, thanks to Gary Bishop's work, Windows XP/2k users can also | |
|
185 | benefit from them. His readline library originally implemented both GNU | |
|
186 | readline functionality and color support, so that IPython under Windows | |
|
187 | XP/2k can be as friendly and powerful as under Unix-like environments. | |
|
188 | ||
|
189 | This library, now named PyReadline, has been absorbed by the IPython | |
|
190 | team (Jörgen Stenarson, in particular), and it continues to be developed | |
|
191 | with new features, as well as being distributed directly from the | |
|
192 | IPython site. | |
|
193 | ||
|
194 | The PyReadline extension requires CTypes and the windows IPython | |
|
195 | installer needs PyWin32, so in all you need: | |
|
196 | ||
|
197 | 1. PyWin32 from http://sourceforge.net/projects/pywin32. | |
|
198 | 2. PyReadline for Windows from | |
|
199 | http://ipython.scipy.org/moin/PyReadline/Intro. That page contains | |
|
200 | further details on using and configuring the system to your liking. | |
|
201 | 3. Finally, only if you are using Python 2.3 or 2.4, you need CTypes | |
|
202 | from http://starship.python.net/crew/theller/ctypes(you must use | |
|
203 | version 0.9.1 or newer). This package is included in Python 2.5, | |
|
204 | so you don't need to manually get it if your Python version is 2.5 | |
|
205 | or newer. | |
|
206 | ||
|
207 | Warning about a broken readline-like library: several users have | |
|
208 | reported problems stemming from using the pseudo-readline library at | |
|
209 | http://newcenturycomputers.net/projects/readline.html. This is a broken | |
|
210 | library which, while called readline, only implements an incomplete | |
|
211 | subset of the readline API. Since it is still called readline, it fools | |
|
212 | IPython's detection mechanisms and causes unpredictable crashes later. | |
|
213 | If you wish to use IPython under Windows, you must NOT use this library, | |
|
214 | which for all purposes is (at least as of version 1.6) terminally broken. | |
|
215 | ||
|
216 | ||
|
217 | Installation procedure | |
|
218 | ---------------------- | |
|
219 | ||
|
220 | Once you have the above installed, from the IPython download directory | |
|
221 | grab the ipython-XXX.win32.exe file, where XXX represents the version | |
|
222 | number. This is a regular windows executable installer, which you can | |
|
223 | simply double-click to install. It will add an entry for IPython to your | |
|
224 | Start Menu, as well as registering IPython in the Windows list of | |
|
225 | applications, so you can later uninstall it from the Control Panel. | |
|
226 | ||
|
227 | IPython tries to install the configuration information in a directory | |
|
228 | named .ipython (_ipython under Windows) located in your 'home' | |
|
229 | directory. IPython sets this directory by looking for a HOME environment | |
|
230 | variable; if such a variable does not exist, it uses HOMEDRIVE\HOMEPATH | |
|
231 | (these are always defined by Windows). This typically gives something | |
|
232 | like C:\Documents and Settings\YourUserName, but your local details may | |
|
233 | vary. In this directory you will find all the files that configure | |
|
234 | IPython's defaults, and you can put there your profiles and extensions. | |
|
235 | This directory is automatically added by IPython to sys.path, so | |
|
236 | anything you place there can be found by import statements. | |
|
237 | ||
|
238 | ||
|
239 | Upgrading | |
|
240 | --------- | |
|
241 | ||
|
242 | For an IPython upgrade, you should first uninstall the previous version. | |
|
243 | This will ensure that all files and directories (such as the | |
|
244 | documentation) which carry embedded version strings in their names are | |
|
245 | properly removed. | |
|
246 | ||
|
247 | ||
|
248 | Manual installation under Win32 | |
|
249 | ------------------------------- | |
|
250 | ||
|
251 | In case the automatic installer does not work for some reason, you can | |
|
252 | download the ipython-XXX.tar.gz file, which contains the full IPython | |
|
253 | source distribution (the popular WinZip can read .tar.gz files). After | |
|
254 | uncompressing the archive, you can install it at a command terminal just | |
|
255 | like any other Python module, by using 'python setup.py install'. | |
|
256 | ||
|
257 | After the installation, run the supplied win32_manual_post_install.py | |
|
258 | script, which creates the necessary Start Menu shortcuts for you. | |
|
259 | ||
|
260 | ||
|
261 | .. upgrading: | |
|
262 | ||
|
263 | Upgrading from a previous version | |
|
264 | --------------------------------- | |
|
265 | ||
|
266 | If you are upgrading from a previous version of IPython, you may want | |
|
267 | to upgrade the contents of your ~/.ipython directory. Just run | |
|
268 | %upgrade, look at the diffs and delete the suggested files manually, | |
|
269 | if you think you can lose the old versions. %upgrade will never | |
|
270 | overwrite or delete anything. | |
|
271 | ||
|
272 |
|
1 | NO CONTENT: file renamed from docs/source/parallel/faq.txt to docs/source/faq.txt |
@@ -1,3 +1,7 b'' | |||
|
1 | ========================================= | |
|
2 | Advanced installation options for IPython | |
|
3 | ========================================= | |
|
4 | ||
|
1 | 5 | .. _install: |
|
2 | 6 | |
|
3 | 7 | =================== |
@@ -7,10 +7,5 b' User Documentation' | |||
|
7 | 7 | .. toctree:: |
|
8 | 8 | :maxdepth: 2 |
|
9 | 9 | |
|
10 |
|
|
|
11 | parallel_intro.txt | |
|
12 | parallel_multiengine.txt | |
|
13 | parallel_task.txt | |
|
14 | parallel_mpi.txt | |
|
15 | changes.txt | |
|
16 | faq.txt | |
|
10 | basic.txt | |
|
11 | advanced.txt |
@@ -204,273 +204,6 b' subversion access, mailing lists and a bug tracking system. I am very' | |||
|
204 | 204 | grateful to Enthought (http://www.enthought.com) and all of the SciPy |
|
205 | 205 | team for their contribution. |
|
206 | 206 | |
|
207 | Installation | |
|
208 | ============ | |
|
209 | ||
|
210 | Instant instructions | |
|
211 | -------------------- | |
|
212 | ||
|
213 | If you are of the impatient kind, under Linux/Unix simply untar/unzip | |
|
214 | the download, then install with 'python setup.py install'. Under | |
|
215 | Windows, double-click on the provided .exe binary installer. | |
|
216 | ||
|
217 | Then, take a look at Customization_ section for configuring things | |
|
218 | optimally and `Quick tips`_ for quick tips on efficient use of | |
|
219 | IPython. You can later refer to the rest of the manual for all the | |
|
220 | gory details. | |
|
221 | ||
|
222 | See the notes in upgrading_ section for upgrading IPython versions. | |
|
223 | ||
|
224 | ||
|
225 | Detailed Unix instructions (Linux, Mac OS X, etc.) | |
|
226 | ||
|
227 | For RPM based systems, simply install the supplied package in the usual | |
|
228 | manner. If you download the tar archive, the process is: | |
|
229 | ||
|
230 | 1. Unzip/untar the ipython-XXX.tar.gz file wherever you want (XXX is | |
|
231 | the version number). It will make a directory called ipython-XXX. | |
|
232 | Change into that directory where you will find the files README | |
|
233 | and setup.py. Once you've completed the installation, you can | |
|
234 | safely remove this directory. | |
|
235 | 2. If you are installing over a previous installation of version | |
|
236 | 0.2.0 or earlier, first remove your $HOME/.ipython directory, | |
|
237 | since the configuration file format has changed somewhat (the '=' | |
|
238 | were removed from all option specifications). Or you can call | |
|
239 | ipython with the -upgrade option and it will do this automatically | |
|
240 | for you. | |
|
241 | 3. IPython uses distutils, so you can install it by simply typing at | |
|
242 | the system prompt (don't type the $):: | |
|
243 | ||
|
244 | $ python setup.py install | |
|
245 | ||
|
246 | Note that this assumes you have root access to your machine. If | |
|
247 | you don't have root access or don't want IPython to go in the | |
|
248 | default python directories, you'll need to use the ``--home`` option | |
|
249 | (or ``--prefix``). For example:: | |
|
250 | ||
|
251 | $ python setup.py install --home $HOME/local | |
|
252 | ||
|
253 | will install IPython into $HOME/local and its subdirectories | |
|
254 | (creating them if necessary). | |
|
255 | You can type:: | |
|
256 | ||
|
257 | $ python setup.py --help | |
|
258 | ||
|
259 | for more details. | |
|
260 | ||
|
261 | Note that if you change the default location for ``--home`` at | |
|
262 | installation, IPython may end up installed at a location which is | |
|
263 | not part of your $PYTHONPATH environment variable. In this case, | |
|
264 | you'll need to configure this variable to include the actual | |
|
265 | directory where the IPython/ directory ended (typically the value | |
|
266 | you give to ``--home`` plus /lib/python). | |
|
267 | ||
|
268 | ||
|
269 | Mac OSX information | |
|
270 | ------------------- | |
|
271 | ||
|
272 | Under OSX, there is a choice you need to make. Apple ships its own build | |
|
273 | of Python, which lives in the core OSX filesystem hierarchy. You can | |
|
274 | also manually install a separate Python, either purely by hand | |
|
275 | (typically in /usr/local) or by using Fink, which puts everything under | |
|
276 | /sw. Which route to follow is a matter of personal preference, as I've | |
|
277 | seen users who favor each of the approaches. Here I will simply list the | |
|
278 | known installation issues under OSX, along with their solutions. | |
|
279 | ||
|
280 | This page: http://geosci.uchicago.edu/~tobis/pylab.html contains | |
|
281 | information on this topic, with additional details on how to make | |
|
282 | IPython and matplotlib play nicely under OSX. | |
|
283 | ||
|
284 | To run IPython and readline on OSX "Leopard" system python, see the | |
|
285 | wiki page at http://ipython.scipy.org/moin/InstallationOSXLeopard | |
|
286 | ||
|
287 | ||
|
288 | GUI problems | |
|
289 | ------------ | |
|
290 | ||
|
291 | The following instructions apply to an install of IPython under OSX from | |
|
292 | unpacking the .tar.gz distribution and installing it for the default | |
|
293 | Python interpreter shipped by Apple. If you are using a fink install, | |
|
294 | fink will take care of these details for you, by installing IPython | |
|
295 | against fink's Python. | |
|
296 | ||
|
297 | IPython offers various forms of support for interacting with graphical | |
|
298 | applications from the command line, from simple Tk apps (which are in | |
|
299 | principle always supported by Python) to interactive control of WX, Qt | |
|
300 | and GTK apps. Under OSX, however, this requires that ipython is | |
|
301 | installed by calling the special pythonw script at installation time, | |
|
302 | which takes care of coordinating things with Apple's graphical environment. | |
|
303 | ||
|
304 | So when installing under OSX, it is best to use the following command:: | |
|
305 | ||
|
306 | $ sudo pythonw setup.py install --install-scripts=/usr/local/bin | |
|
307 | ||
|
308 | or | |
|
309 | ||
|
310 | $ sudo pythonw setup.py install --install-scripts=/usr/bin | |
|
311 | ||
|
312 | depending on where you like to keep hand-installed executables. | |
|
313 | ||
|
314 | The resulting script will have an appropriate shebang line (the first | |
|
315 | line in the script whic begins with #!...) such that the ipython | |
|
316 | interpreter can interact with the OS X GUI. If the installed version | |
|
317 | does not work and has a shebang line that points to, for example, just | |
|
318 | /usr/bin/python, then you might have a stale, cached version in your | |
|
319 | build/scripts-<python-version> directory. Delete that directory and | |
|
320 | rerun the setup.py. | |
|
321 | ||
|
322 | It is also a good idea to use the special flag ``--install-scripts`` as | |
|
323 | indicated above, to ensure that the ipython scripts end up in a location | |
|
324 | which is part of your $PATH. Otherwise Apple's Python will put the | |
|
325 | scripts in an internal directory not available by default at the command | |
|
326 | line (if you use /usr/local/bin, you need to make sure this is in your | |
|
327 | $PATH, which may not be true by default). | |
|
328 | ||
|
329 | ||
|
330 | Readline problems | |
|
331 | ----------------- | |
|
332 | ||
|
333 | By default, the Python version shipped by Apple does not include the | |
|
334 | readline library, so central to IPython's behavior. If you install | |
|
335 | IPython against Apple's Python, you will not have arrow keys, tab | |
|
336 | completion, etc. For Mac OSX 10.3 (Panther), you can find a prebuilt | |
|
337 | readline library here: | |
|
338 | http://pythonmac.org/packages/readline-5.0-py2.3-macosx10.3.zip | |
|
339 | ||
|
340 | If you are using OSX 10.4 (Tiger), after installing this package you | |
|
341 | need to either: | |
|
342 | ||
|
343 | 1. move readline.so from /Library/Python/2.3 to | |
|
344 | /Library/Python/2.3/site-packages, or | |
|
345 | 2. install http://pythonmac.org/packages/TigerPython23Compat.pkg.zip | |
|
346 | ||
|
347 | Users installing against Fink's Python or a properly hand-built one | |
|
348 | should not have this problem. | |
|
349 | ||
|
350 | ||
|
351 | DarwinPorts | |
|
352 | ----------- | |
|
353 | ||
|
354 | I report here a message from an OSX user, who suggests an alternative | |
|
355 | means of using IPython under this operating system with good results. | |
|
356 | Please let me know of any updates that may be useful for this section. | |
|
357 | His message is reproduced verbatim below: | |
|
358 | ||
|
359 | From: Markus Banfi <markus.banfi-AT-mospheira.net> | |
|
360 | ||
|
361 | As a MacOS X (10.4.2) user I prefer to install software using | |
|
362 | DawinPorts instead of Fink. I had no problems installing ipython | |
|
363 | with DarwinPorts. It's just: | |
|
364 | ||
|
365 | sudo port install py-ipython | |
|
366 | ||
|
367 | It automatically resolved all dependencies (python24, readline, | |
|
368 | py-readline). So far I did not encounter any problems with the | |
|
369 | DarwinPorts port of ipython. | |
|
370 | ||
|
371 | ||
|
372 | ||
|
373 | Windows instructions | |
|
374 | -------------------- | |
|
375 | ||
|
376 | Some of IPython's very useful features are: | |
|
377 | ||
|
378 | * Integrated readline support (Tab-based file, object and attribute | |
|
379 | completion, input history across sessions, editable command line, | |
|
380 | etc.) | |
|
381 | * Coloring of prompts, code and tracebacks. | |
|
382 | ||
|
383 | .. _pyreadline: | |
|
384 | ||
|
385 | These, by default, are only available under Unix-like operating systems. | |
|
386 | However, thanks to Gary Bishop's work, Windows XP/2k users can also | |
|
387 | benefit from them. His readline library originally implemented both GNU | |
|
388 | readline functionality and color support, so that IPython under Windows | |
|
389 | XP/2k can be as friendly and powerful as under Unix-like environments. | |
|
390 | ||
|
391 | This library, now named PyReadline, has been absorbed by the IPython | |
|
392 | team (Jörgen Stenarson, in particular), and it continues to be developed | |
|
393 | with new features, as well as being distributed directly from the | |
|
394 | IPython site. | |
|
395 | ||
|
396 | The PyReadline extension requires CTypes and the windows IPython | |
|
397 | installer needs PyWin32, so in all you need: | |
|
398 | ||
|
399 | 1. PyWin32 from http://sourceforge.net/projects/pywin32. | |
|
400 | 2. PyReadline for Windows from | |
|
401 | http://ipython.scipy.org/moin/PyReadline/Intro. That page contains | |
|
402 | further details on using and configuring the system to your liking. | |
|
403 | 3. Finally, only if you are using Python 2.3 or 2.4, you need CTypes | |
|
404 | from http://starship.python.net/crew/theller/ctypes(you must use | |
|
405 | version 0.9.1 or newer). This package is included in Python 2.5, | |
|
406 | so you don't need to manually get it if your Python version is 2.5 | |
|
407 | or newer. | |
|
408 | ||
|
409 | Warning about a broken readline-like library: several users have | |
|
410 | reported problems stemming from using the pseudo-readline library at | |
|
411 | http://newcenturycomputers.net/projects/readline.html. This is a broken | |
|
412 | library which, while called readline, only implements an incomplete | |
|
413 | subset of the readline API. Since it is still called readline, it fools | |
|
414 | IPython's detection mechanisms and causes unpredictable crashes later. | |
|
415 | If you wish to use IPython under Windows, you must NOT use this library, | |
|
416 | which for all purposes is (at least as of version 1.6) terminally broken. | |
|
417 | ||
|
418 | ||
|
419 | Installation procedure | |
|
420 | ---------------------- | |
|
421 | ||
|
422 | Once you have the above installed, from the IPython download directory | |
|
423 | grab the ipython-XXX.win32.exe file, where XXX represents the version | |
|
424 | number. This is a regular windows executable installer, which you can | |
|
425 | simply double-click to install. It will add an entry for IPython to your | |
|
426 | Start Menu, as well as registering IPython in the Windows list of | |
|
427 | applications, so you can later uninstall it from the Control Panel. | |
|
428 | ||
|
429 | IPython tries to install the configuration information in a directory | |
|
430 | named .ipython (_ipython under Windows) located in your 'home' | |
|
431 | directory. IPython sets this directory by looking for a HOME environment | |
|
432 | variable; if such a variable does not exist, it uses HOMEDRIVE\HOMEPATH | |
|
433 | (these are always defined by Windows). This typically gives something | |
|
434 | like C:\Documents and Settings\YourUserName, but your local details may | |
|
435 | vary. In this directory you will find all the files that configure | |
|
436 | IPython's defaults, and you can put there your profiles and extensions. | |
|
437 | This directory is automatically added by IPython to sys.path, so | |
|
438 | anything you place there can be found by import statements. | |
|
439 | ||
|
440 | ||
|
441 | Upgrading | |
|
442 | --------- | |
|
443 | ||
|
444 | For an IPython upgrade, you should first uninstall the previous version. | |
|
445 | This will ensure that all files and directories (such as the | |
|
446 | documentation) which carry embedded version strings in their names are | |
|
447 | properly removed. | |
|
448 | ||
|
449 | ||
|
450 | Manual installation under Win32 | |
|
451 | ------------------------------- | |
|
452 | ||
|
453 | In case the automatic installer does not work for some reason, you can | |
|
454 | download the ipython-XXX.tar.gz file, which contains the full IPython | |
|
455 | source distribution (the popular WinZip can read .tar.gz files). After | |
|
456 | uncompressing the archive, you can install it at a command terminal just | |
|
457 | like any other Python module, by using 'python setup.py install'. | |
|
458 | ||
|
459 | After the installation, run the supplied win32_manual_post_install.py | |
|
460 | script, which creates the necessary Start Menu shortcuts for you. | |
|
461 | ||
|
462 | ||
|
463 | .. upgrading: | |
|
464 | ||
|
465 | Upgrading from a previous version | |
|
466 | --------------------------------- | |
|
467 | ||
|
468 | If you are upgrading from a previous version of IPython, you may want | |
|
469 | to upgrade the contents of your ~/.ipython directory. Just run | |
|
470 | %upgrade, look at the diffs and delete the suggested files manually, | |
|
471 | if you think you can lose the old versions. %upgrade will never | |
|
472 | overwrite or delete anything. | |
|
473 | ||
|
474 | 207 | Initial configuration of your environment |
|
475 | 208 | ========================================= |
|
476 | 209 |
@@ -0,0 +1,3 b'' | |||
|
1 | ============================= | |
|
2 | IPython Copyright and License | |
|
3 | ============================= |
@@ -7,10 +7,8 b' User Documentation' | |||
|
7 | 7 | .. toctree:: |
|
8 | 8 | :maxdepth: 2 |
|
9 | 9 | |
|
10 | install.txt | |
|
11 | 10 | parallel_intro.txt |
|
12 | 11 | parallel_multiengine.txt |
|
13 | 12 | parallel_task.txt |
|
14 | 13 | parallel_mpi.txt |
|
15 | changes.txt | |
|
16 | faq.txt | |
|
14 |
|
1 | NO CONTENT: file was removed |
General Comments 0
You need to be logged in to leave comments.
Login now