diff --git a/doc/src/vpr/command_line_usage.rst b/doc/src/vpr/command_line_usage.rst index be0896dd7c6..7954cdc3fd5 100644 --- a/doc/src/vpr/command_line_usage.rst +++ b/doc/src/vpr/command_line_usage.rst @@ -1879,6 +1879,8 @@ The following options are used to enable server mode in VPR. **Default:** ``60555`` +.. seealso:: :ref:`interactive_path_analysis_client` + Command-line Auto Completion ---------------------------- diff --git a/doc/src/vtr/server_mode/index.rst b/doc/src/vtr/server_mode/index.rst index 66972681241..0c68beeaa61 100644 --- a/doc/src/vtr/server_mode/index.rst +++ b/doc/src/vtr/server_mode/index.rst @@ -202,7 +202,19 @@ Draw selected critical path elements example .. note:: If status is not 1, the field ***DATA*** contains error string. +`The interactive path analysis (IPA) client `_ is useful for viewing timing paths, and to test VPR's server mode functionality. +.. _interactive_path_analysis_client: + +Interactive Path Analysis Client (IPA) +==================================================== + +The interactive path analysis (IPA) client connects to VPR's server mode and allows interactive visualization of timing paths and their placement and routing. This client application is called **IPAClient** and can also be used to test VPR's server mode functionality. It is available in a public Git repository: +`https://github.com/w0lek/IPAClient `_. + +This UI application is designed to generate requests for VPR in server mode and display the responses in a readable format, acting as a result viewer. + +More details on how to build and use **IPAClient** can be found in the `README `_.