Metadata-Version: 2.4
Name: wperf-cmn-visualizer
Version: 1.0.1
Summary: A GUI-based visualizer for Arm CMN (Coherent Mesh Network) systems using WindowsPerf backend
License: BSD-3-Clause
Requires-Python: <3.14,>=3.12.4
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PySide6
Requires-Dist: numpy
Requires-Dist: pandas
Dynamic: license-file

# CMN Mesh Visualizer

<p align="center">
  <img src="https://gitlab.com/Linaro/WindowsPerf/cmn-mesh-visualizer/-/raw/main/images/readme_main_logo.png" alt="CMN Mesh Visualiser Logo" width="400"/>
</p>

This is a Python project that provides a GUI-based visualizer for Arm CMN (Coherent Mesh Network) systems. It parses and displays information generated by [WindowsPerf](https://gitlab.com/Linaro/WindowsPerf/windowsperf) and [Topdown Tool](https://gitlab.arm.com/telemetry-solution/telemetry-solution/-/tree/main/tools/topdown_tool), presenting their output files in an interactive interface. The visualizer enables analysis of topology, traffic, and performance metrics using PMU data from XPs, DTCs, and related components—helping engineers identify bottlenecks and understand system behavior across complex SoCs.

## Installation

Install via pip using:

```bash
> pip install wperf-cmn-visualizer
```
> Note: For more information, checkout [INSTALL.md](https://gitlab.com/Linaro/WindowsPerf/cmn-mesh-visualizer/-/blob/main/INSTALL.md)

## Usage

Find out more about how to use this at [USAGE.md](https://gitlab.com/Linaro/WindowsPerf/cmn-mesh-visualizer/-/blob/main/USAGE.md)

## Contributing

To contribute to the project follow our [Contributing Guidelines](https://gitlab.com/Linaro/WindowsPerf/cmn-mesh-visualizer/-/blob/main/CONTRIBUTING.md).

## License

All code in this repository is licensed under the [BSD 3-Clause License](https://gitlab.com/Linaro/WindowsPerf/cmn-mesh-visualizer/-/blob/main/LICENSE)

### Third-Party Dependencies

This project uses the following third-party library licensed under the GNU Lesser General Public License (LGPL):

- [PySide6](https://pypi.org/project/PySide6/) – Licensed under LGPL-3.0-only.

The LGPL-licensed package is used without modification and is dynamically linked (imported as a separate dependency via PyPI). In accordance with LGPL terms, users are free to replace or modify this library independently of this project.

### Compliance Statement

The use of the LGPL-licensed package does not affect the licensing of this project, which remains under the BSD 3-Clause License. This is permitted under LGPL rules provided the library is dynamically linked and not embedded or modified.

For more details on the BSD 3-Clause License, see https://opensource.org/licenses/BSD-3-Clause.

For more details on the LGPL, see https://spdx.org/licenses/LGPL-3.0-only.html.
