[yt-svn] commit/yt-doc: ngoldbaum: Updating the parallel analysis docs to reflect changes in the TimeSeries machinery.

[Bitbucket]

1 new commit in yt-doc:


https://bitbucket.org/yt_analysis/yt-doc/changeset/6d5ad835bfe4/
changeset:   6d5ad835bfe4
user:        ngoldbaum
date:        2012-09-13 21:28:50
summary:     Updating the parallel analysis docs to reflect changes in the TimeSeries machinery.
affected #:  1 file

diff -r f560ac5922abe73af89b9141fd73f9b9ef4da56f -r 6d5ad835bfe40845ab517bff0c7188a441aebf47 source/advanced/parallel_computation.rst
--- a/source/advanced/parallel_computation.rst
+++ b/source/advanced/parallel_computation.rst
@@ -203,8 +203,8 @@
 -----------------------------
 
 The same :func:`parallel_objects` machinery discussed above is turned on by
-default when using a ``TimeSeries`` object (see :ref:`time-series-analysis`) to
-iterate over simulation outputs.  The syntax for this is very simple.  As an
+default when using a ``TimeSeriesData`` object (see :ref:`time-series-analysis`)
+to iterate over simulation outputs.  The syntax for this is very simple.  As an
 example, we can use the following script to find the angular momentum vector in
 a 1 pc sphere centered on the maximum density cell in a large number of
 simulation outputs:
@@ -212,22 +212,22 @@
 .. code-block:: python
 
    from yt.mods import *
-   ts = TimeSeries.from_filenames("DD*/output_*", Parallel = True)
+   ts = TimeSeriesData.from_filenames("DD*/output_*", parallel = True)
    sphere = ts.sphere("max", (1.0, "pc"))
    L_vecs = sphere.quantities["AngularMomentumVector"]()
 
 Note that this script can be run in serial or parallel with an arbitrary number
 of processors.  When running in parallel, each output is given to a different
-processor.  By default, Parallel is set to ``True``, so you do not have to
-explicitly set ``Parallel = True`` as in the above example. 
+processor.  By default, parallel is set to ``True``, so you do not have to
+explicitly set ``parallel = True`` as in the above example. 
 
 One could get the same effect by iterating over the individual parameter files
-in the TimeSeries object:
+in the TimeSeriesData object:
 
 .. code-block:: python
 
    from yt.mods import *
-   ts = TimeSeries.from_filenames("DD*/output_*", Parallel = True)
+   ts = TimeSeriesData.from_filenames("DD*/output_*", parallel = True)
    my_storage = {}
    for sto,pf in ts.piter(storage=my_storage):
        sphere = pf.h.sphere("max", (1.0, "pc"))
@@ -247,12 +247,12 @@
 .. code-block:: python
 
    from yt.mods import *
-   ts = TimeSeries.from_filenames("DD*/output_*", Parallel = 4)
+   ts = TimeSeriesData.from_filenames("DD*/output_*", parallel = 4)
    sphere = ts.sphere("max", (1.0, "pc))
    L_vecs = sphere.quantities["AngularMomentumVector"]()
 
 If you do not want to use ``parallel_objects`` parallelism when using a
-TimeSeries object, set ``Parallel = False``.  When running python in parallel,
+TimeSeries object, set ``parallel = False``.  When running python in parallel,
 this will use all of the available processors to evaluate the requested
 operation on each simulation output.  Some care and possibly trial and error
 might be necessary to estimate the correct settings for your Simulation

Repository URL: https://bitbucket.org/yt_analysis/yt-doc/

--

This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.