From 0ea67006bd02a8a47fd72aeb2eddb3c1423bae63 Mon Sep 17 00:00:00 2001 From: Amir Poolad Date: Wed, 14 May 2025 11:34:56 -0400 Subject: [PATCH] Add documentation to explain which parts of VPR are parellel --- doc/src/vpr/command_line_usage.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/src/vpr/command_line_usage.rst b/doc/src/vpr/command_line_usage.rst index 61dd775abb..960aedc484 100644 --- a/doc/src/vpr/command_line_usage.rst +++ b/doc/src/vpr/command_line_usage.rst @@ -223,6 +223,12 @@ General Options If this option is not specified it may be set from the ``VPR_NUM_WORKERS`` environment variable; otherwise the default is used. + If this option is set to something other than 1, the following algorithms can be run in parallel: + + * Timing Analysis + * Routing (If routing algorithm is set to parallel or parallel_decomp; See :option:`--router_algorithm`) + * Portions of analytical placement (If using the analytical placement flow and compiled VPR with Eigen enabled; See :option:`--analytical_place`) + .. note:: To compile VPR to allow the usage of parallel workers, ``libtbb-dev`` must be installed in the system. **Default:** ``1``