Skip to content

Commit 7513f40

Browse files
committed
Updated docs with dependencies
1 parent 2683de8 commit 7513f40

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

doc/users/resource_sched_profiler.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,12 @@ It is not always easy to estimate the amount of resources a particular function
6060
or command uses. To help with this, Nipype provides some feedback about the
6161
system resources used by every node during workflow execution via the built-in
6262
runtime profiler. The runtime profiler is automatically enabled if the
63-
``psutil`` Python package is installed and found on the system. If the package
64-
is not found, the workflow will run normally without the runtime profiler.
63+
psutil_ Python package is installed and found on the system.
64+
65+
.. _psutil: https://pythonhosted.org/psutil/
66+
67+
If the package is not found, the workflow will run normally without the runtime
68+
profiler.
6569

6670
The runtime profiler records the number of threads and the amount of memory (GB)
6771
used as ``runtime_threads`` and ``runtime_memory_gb`` in the Node's
@@ -121,6 +125,9 @@ Visualizing Pipeline Resources
121125
Nipype provides the ability to visualize the workflow execution based on the
122126
runtimes and system resources each node takes. It does this using the log file
123127
generated from the callback logger after workflow execution - as shown above.
128+
The pandas_ Python package is required to use this feature.
129+
130+
.. _pandas: http://pandas.pydata.org/
124131

125132
::
126133
from nipype.pipeline.plugins.callback_log import log_nodes_cb

0 commit comments

Comments
 (0)