DOC - add info on how to change default tempdir (multiprocessing).

dipy · Oct 8, 2014 · 24c0bcb · 24c0bcb
1 parent 2bacbd3
commit 24c0bcb
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/dipy/reconst/peaks.py b/dipy/reconst/peaks.py
@@ -368,9 +368,11 @@ def peaks_from_model(model, data, sphere, relative_peak_threshold,
         Inverse of B.
     parallel: bool
         If True, use multiprocessing to compute peaks and metric
-        (default False).
+        (default False). Temporary files are saved in the default temporary
+        directory of the system. It can be changed using ``import tempfile``
+        and ``tempfile.tempdir = '/path/to/tempdir'``.
     nbr_processes: int
-        If `parallel == True`, the number of subprocesses to use
+        If ``parallel == True``, the number of subprocesses to use
         (default multiprocessing.cpu_count()).
 
     Returns