Skip to content

add chapter "IPA Client for Testing VPR Server Mode Functionality" to a server_mode/index.rst #2719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Oct 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/src/vpr/command_line_usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------------------------

Expand Down
12 changes: 12 additions & 0 deletions doc/src/vtr/server_mode/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/w0lek/IPAClient>`_ 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 <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 <https://github.com/w0lek/IPAClient/blob/main/README.md>`_.