README.md

# Fastpath

Fastpath is a command-line tool specifically designed for monitoring the
performance of the Linux kernel by executing structured performance benchmarks
on a diverse range of hardware platforms. It automates the collection, storage,
and analysis of performance data to assess how Linux kernel modifications impact
various workloads. By structuring execution plans in YAML and providing flexible
result management, Fastpath enables developers and performance engineers to
detect regressions, validate optimizations, and track long-term performance
trends effectively.

- Documentation is available at: https://fastpath.docs.arm.com
- Source Code is available at: https://gitlab.arm.com/tooling/fastpath
- Container Images are available at: https://gitlab.arm.com/tooling/fastpath/container_registry

The documentation (linked above) contains a [User
Guide](https://fastpath.docs.arm.com/en/latest/user-guide/index.html), which
details how to install and use the tool. However, if you are in a hurry, here
are the minimal steps:

```
  git clone https://git.gitlab.arm.com/tooling/fastpath.git
  pip install -r fastpath/fastpath/requirements.txt
  export PATH=$PWD/fastpath/fastpath:$PATH
```

```
  fastpath --help
```