##// END OF EJS Templates
change docs/examples refs to be just examples...
Paul Ivanov -
Show More
@@ -74,7 +74,7 b' The actual results are stored in a dictionary, ``tr.results``, and a namespace o'
74
74
75 That should cover the basics of running simple Tasks. There are several more powerful things the user can do with Tasks covered later. The most useful probably being using a ``MutiEngineClient`` interface to initialize all the engines with the import dependencies necessary to run the user's Tasks.
75 That should cover the basics of running simple Tasks. There are several more powerful things the user can do with Tasks covered later. The most useful probably being using a ``MutiEngineClient`` interface to initialize all the engines with the import dependencies necessary to run the user's Tasks.
76
76
77 There are many options for running and managing Tasks. The best way to learn further about the ``Task`` interface is to study the examples in ``docs/examples``. If the user do so and learn a lots about this interface, we encourage the user to expand this documentation about the ``Task`` system.
77 There are many options for running and managing Tasks. The best way to learn further about the ``Task`` interface is to study the examples in ``examples``. If the user do so and learn a lots about this interface, we encourage the user to expand this documentation about the ``Task`` system.
78
78
79 Overview of the Task System
79 Overview of the Task System
80 ===========================
80 ===========================
@@ -1033,7 +1033,7 b' Second, when using the ``PyOSInputHook`` approach, a GUI application should'
1033 in IPython and as standalone apps need to have special code to detects how the
1033 in IPython and as standalone apps need to have special code to detects how the
1034 application is being run. We highly recommend using IPython's support for this.
1034 application is being run. We highly recommend using IPython's support for this.
1035 Since the details vary slightly between toolkits, we point you to the various
1035 Since the details vary slightly between toolkits, we point you to the various
1036 examples in our source directory :file:`docs/examples/lib` that demonstrate
1036 examples in our source directory :file:`examples/lib` that demonstrate
1037 these capabilities.
1037 these capabilities.
1038
1038
1039 Third, unlike previous versions of IPython, we no longer "hijack" (replace
1039 Third, unlike previous versions of IPython, we no longer "hijack" (replace
@@ -1042,7 +1042,7 b' actually need to run the real event loops to do so. This is often needed to'
1042 process pending events at critical points.
1042 process pending events at critical points.
1043
1043
1044 Finally, we also have a number of examples in our source directory
1044 Finally, we also have a number of examples in our source directory
1045 :file:`docs/examples/lib` that demonstrate these capabilities.
1045 :file:`examples/lib` that demonstrate these capabilities.
1046
1046
1047 PyQt and PySide
1047 PyQt and PySide
1048 ---------------
1048 ---------------
@@ -147,4 +147,4 b' To break that down:'
147 handling individual results as they arrive, but with metadata), you can always
147 handling individual results as they arrive, but with metadata), you can always
148 just split the original result's ``msg_ids`` attribute, and handle them as you like.
148 just split the original result's ``msg_ids`` attribute, and handle them as you like.
149
149
150 For an example of this, see :file:`docs/examples/parallel/customresult.py`
150 For an example of this, see :file:`examples/parallel/customresult.py`
@@ -10,7 +10,7 b' for working with Graphs is NetworkX_. Here, we will walk through a demo mapping'
10 a nx DAG to task dependencies.
10 a nx DAG to task dependencies.
11
11
12 The full script that runs this demo can be found in
12 The full script that runs this demo can be found in
13 :file:`docs/examples/parallel/dagdeps.py`.
13 :file:`examples/parallel/dagdeps.py`.
14
14
15 Why are DAGs good for task dependencies?
15 Why are DAGs good for task dependencies?
16 ----------------------------------------
16 ----------------------------------------
@@ -30,7 +30,7 b' million digits.'
30
30
31 In both the serial and parallel calculation we will be using functions defined
31 In both the serial and parallel calculation we will be using functions defined
32 in the :file:`pidigits.py` file, which is available in the
32 in the :file:`pidigits.py` file, which is available in the
33 :file:`docs/examples/parallel` directory of the IPython source distribution.
33 :file:`examples/parallel` directory of the IPython source distribution.
34 These functions provide basic facilities for working with the digits of pi and
34 These functions provide basic facilities for working with the digits of pi and
35 can be loaded into IPython by putting :file:`pidigits.py` in your current
35 can be loaded into IPython by putting :file:`pidigits.py` in your current
36 working directory and then doing:
36 working directory and then doing:
@@ -108,7 +108,7 b' calculation, we will need two top-level functions from :file:`pidigits.py`:'
108
108
109 We will also use the :func:`plot_two_digit_freqs` function to plot the
109 We will also use the :func:`plot_two_digit_freqs` function to plot the
110 results. The code to run this calculation in parallel is contained in
110 results. The code to run this calculation in parallel is contained in
111 :file:`docs/examples/parallel/parallelpi.py`. This code can be run in parallel
111 :file:`examples/parallel/parallelpi.py`. This code can be run in parallel
112 using IPython by following these steps:
112 using IPython by following these steps:
113
113
114 1. Use :command:`ipcluster` to start 15 engines. We used 16 cores of an SGE linux
114 1. Use :command:`ipcluster` to start 15 engines. We used 16 cores of an SGE linux
@@ -9,11 +9,11 b' Examples'
9 ========
9 ========
10
10
11 We have various example scripts and notebooks for using IPython.parallel in our
11 We have various example scripts and notebooks for using IPython.parallel in our
12 :file:`docs/examples/parallel` directory, or they can be found `on GitHub`__.
12 :file:`examples/parallel` directory, or they can be found `on GitHub`__.
13 Some of these are covered in more detail in the :ref:`examples
13 Some of these are covered in more detail in the :ref:`examples
14 <parallel_examples>` section.
14 <parallel_examples>` section.
15
15
16 .. __: https://github.com/ipython/ipython/tree/master/docs/examples/parallel
16 .. __: https://github.com/ipython/ipython/tree/master/examples/parallel
17
17
18 Introduction
18 Introduction
19 ============
19 ============
@@ -497,7 +497,7 b' Additional new features'
497
497
498 * For developers :mod:`IPython.lib.inputhook` provides a simple interface
498 * For developers :mod:`IPython.lib.inputhook` provides a simple interface
499 for managing the event loops in their interactive GUI applications.
499 for managing the event loops in their interactive GUI applications.
500 Examples can be found in our :file:`docs/examples/lib` directory.
500 Examples can be found in our :file:`examples/lib` directory.
501
501
502 Backwards incompatible changes
502 Backwards incompatible changes
503 ------------------------------
503 ------------------------------
@@ -127,7 +127,7 b' to the user, with callbacks in Javascript executing calls to the Kernel. This'
127 will enable many interactive elements to be added by users in notebooks.
127 will enable many interactive elements to be added by users in notebooks.
128
128
129 An example of this capability has been provided as a proof of concept in
129 An example of this capability has been provided as a proof of concept in
130 :file:`docs/examples/widgets` that lets you directly communicate with one or more
130 :file:`examples/widgets` that lets you directly communicate with one or more
131 parallel engines, acting as a mini-console for parallel debugging and
131 parallel engines, acting as a mini-console for parallel debugging and
132 introspection.
132 introspection.
133
133
General Comments 0
You need to be logged in to leave comments. Login now