[yt-svn] commit/yt-doc: brittonsmith: Updating SimulationTimeSeries docs for recent change with find_outputs keyword.
Bitbucket
commits-noreply at bitbucket.org
Mon Aug 13 13:45:04 PDT 2012
1 new commit in yt-doc:
https://bitbucket.org/yt_analysis/yt-doc/changeset/eb3c3f1f7552/
changeset: eb3c3f1f7552
user: brittonsmith
date: 2012-08-13 22:40:53
summary: Updating SimulationTimeSeries docs for recent change with find_outputs keyword.
affected #: 1 file
diff -r 3c649ce9253c16600933ee08e951ea86263412af -r eb3c3f1f75520f7a3bdcb0920b694254234f1175 source/analyzing/time_series_analysis.rst
--- a/source/analyzing/time_series_analysis.rst
+++ b/source/analyzing/time_series_analysis.rst
@@ -176,11 +176,17 @@
.. code-block:: python
from yt.mods import *
- my_sim = simulation('enzo_tiny_cosmology/32Mpc_32.enzo', 'Enzo')
+ my_sim = simulation('enzo_tiny_cosmology/32Mpc_32.enzo', 'Enzo',
+ find_outputs=False)
Then, create a ``TimeSeriesData`` object with the :meth:`get_time_series`
function. With no additional keywords, the time series will include every
-dataset.
+dataset. If the **find_outputs** keyword is set to True, a search of the
+simulation directory will be performed looking for potential datasets. These
+datasets will be temporarily loaded in order to figure out the time and
+redshift associated with them. This can be used when simulation data was
+created in a non-standard way, making it difficult to guess the corresponding
+time and redshift information
.. code-block:: python
@@ -243,13 +249,6 @@
the requested times or redshifts. If None, the nearest output is always
taken. Default: None.
- * **find_outputs** (*bool*): If True, subdirectories within the GlobalDir
- directory are searched one by one for datasets. Time and redshift
- information are gathered by temporarily instantiating each dataset. This
- can be used when simulation data was created in a non-standard way, making
- it difficult to guess the corresponding time and redshift information.
- Default: False.
-
* **parallel** (*bool*/*int*): If True, the generated TimeSeriesData will
divide the work such that a single processor works on each dataset. If an
integer is supplied, the work will be divided into that number of jobs.
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.
More information about the yt-svn
mailing list