[yt-svn] commit/yt-doc: sskory: Touching up the Rockstar docs.

[Bitbucket]

1 new commit in yt-doc:


https://bitbucket.org/yt_analysis/yt-doc/changeset/dc8c2cecac47/
changeset:   dc8c2cecac47
user:        sskory
date:        2012-11-26 20:00:56
summary:     Touching up the Rockstar docs.
affected #:  1 file

diff -r 249744befbb764db4362ca494142637238223504 -r dc8c2cecac47eac70516e09572cd1aa4273c823c source/analysis_modules/running_halofinder.rst
--- a/source/analysis_modules/running_halofinder.rst
+++ b/source/analysis_modules/running_halofinder.rst
@@ -8,10 +8,10 @@
 method described in `Eisenstein and Hut (1998) <http://adsabs.harvard.edu/abs/1998ApJ...498..137E>`_. 
 A basic friends-of-friends (e.g. `Efstathiou et al. (1985) <http://adsabs.harvard.edu/abs/1985ApJS...57..241E>`_)
 halo finder is also implemented.
-Parallel HOP (` Skory et al. (2010) <http://adsabs.harvard.edu/abs/2010ApJS..191...43S>`_)
+Parallel HOP (`Skory et al. (2010) <http://adsabs.harvard.edu/abs/2010ApJS..191...43S>`_)
 is a true parallelization of the HOP method can analyze massive datasets on
 hundreds of processors.
-Finally Rockstar (` Behroozi et a. (2011) <http://adsabs.harvard.edu/abs/2011arXiv1110.4372B>`_)
+Finally Rockstar (`Behroozi et a. (2011) <http://adsabs.harvard.edu/abs/2011arXiv1110.4372B>`_)
 is a 6D-phase space halo finder developed by Peter Behroozi
 that excels in finding subhalos and substrcture,
 but does not allow multiple particle masses.
@@ -463,14 +463,15 @@
 groups in six phase-space dimensions and one time dimension, which 
 allows for robust (grid-independent, shape-independent, and noise-
 resilient) tracking of substructure. The code is prepackaged with yt, 
-but separately available <http://code.google.com/p/rockstar>. The lead 
+but also `separately available <http://code.google.com/p/rockstar>`_. The lead 
 developer is Peter Behroozi, and the methods are described in `Behroozi
-et al. 2011 <http://rockstar.googlecode.com/files/rockstar_ap101911.pdf>.` 
+et al. 2011 <http://rockstar.googlecode.com/files/rockstar_ap101911.pdf>`_. 
 
 .. note:: At the moment, Rockstar does not support multiple particle masses, 
   instead using a fixed particle mass. This will not affect most dark matter 
   simulations, but does make it less useful for finding halos from the stellar
-  mass.
+  mass. Also note that halo finding in a subvolume is not supported by
+  Rockstar.
 
 To run the Rockstar Halo finding, you must launch python with MPI and 
 parallelization enabled. While Rockstar itself does not require MPI to run, 
@@ -509,13 +510,13 @@
     Cannot vary between particles.
   * ``dm_type``, the index of the dark matter particle. Default is 1. 
   * ``outbase``, This is where the out*list files that Rockstar makes should be
-            placed. Default is 'rockstar_halos'.
+    placed. Default is 'rockstar_halos'.
   * ``num_readers``, the number of reader tasks (which are idle most of the 
-                 time.) Default is 1.
+    time.) Default is 1.
   * ``num_writers``, the number of writer tasks (which are fed particles and
-                do most of the analysis). Default is MPI_TASKS-num_readers-1. 
-                If left undefined, the above options are automatically 
-                configured from the number of available MPI tasks.
+    do most of the analysis). Default is MPI_TASKS-num_readers-1. 
+    If left undefined, the above options are automatically 
+    configured from the number of available MPI tasks.
   * ``force_res``, the resolution that Rockstar uses for various calculations
     and smoothing lengths. This is in units of Mpc/h.
     If no value is provided, this parameter is automatically set to
@@ -524,6 +525,7 @@
     longest) in the time series:
     ``pf_last.h.get_smallest_dx() * pf_last['mpch']``.
 
+
 Output Analysis
 ---------------
 
@@ -537,7 +539,7 @@
 The halo list can be automatically generated from the RockstarHaloFinder 
 object by calling ``RockstarHaloFinder.halo_list()``. Alternatively, the halo
 lists can be built from the RockstarHaloList class directly 
-``LoadRockstarHalos(pf,''outbase/out_0.list')``.
+``LoadRockstarHalos(pf,'outbase/out_0.list')``.
 
 .. code-block:: python

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.