[yt-svn] commit/yt: ngoldbaum: Updat outdated instructions in RockstarHaloFinder docstrings

[commits-noreply at bitbucket.org]

1 new commit in yt:

https://bitbucket.org/yt_analysis/yt/commits/d758c501e2f9/
Changeset:   d758c501e2f9
Branch:      yt
User:        ngoldbaum
Date:        2016-10-11 02:06:42+00:00
Summary:     Updat outdated instructions in RockstarHaloFinder docstrings
Affected #:  1 file

diff -r a0b5472ce04d4296e351d82f2dcc23c736cd8e82 -r d758c501e2f978eb8e2c817550595f41071b4b82 yt/analysis_modules/halo_finding/rockstar/rockstar.py
--- a/yt/analysis_modules/halo_finding/rockstar/rockstar.py
+++ b/yt/analysis_modules/halo_finding/rockstar/rockstar.py
@@ -114,7 +114,7 @@
 
     Parameters
     ----------
-    ts   : DatasetSeries, Dataset
+    ts: DatasetSeries, Dataset
         This is the data source containing the DM particles. Because 
         halo IDs may change from one snapshot to the next, the only
         way to keep a consistent halo ID across time is to feed 
@@ -165,13 +165,12 @@
     --------
     
     To use the script below you must run it using MPI:
-    mpirun -np 4 python run_rockstar.py --parallel
+    mpirun -np 4 python run_rockstar.py
 
     >>> import yt
+    >>> yt.enable_parallelism()
     >>> from yt.analysis_modules.halo_finding.rockstar.api import \
-    ... RockstarHaloFinder
-    >>> from yt.data_objects.particle_filters import \
-    ... particle_filter
+    ...     RockstarHaloFinder
 
     >>> # create a particle filter to remove star particles
     >>> @yt.particle_filter("dark_matter", requires=["creation_time"])

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

--

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