Skip to content

Installation

Requirements

  • Python 3
  • Access to your scheduler commands (or offline input files)
  • A terminal that supports ANSI colors (recommended)

Install from source

git clone https://github.com/qtop/qtop.git
cd qtop
./qtop --version

Install from PyPI

pip install qtop --user
$HOME/.local/bin/qtop --version

If you install system-wide, omit --user.

Optional local configuration

qtop behavior can be customized through qtopconf.yaml and related files.

Typical places to keep your local tuning:

  • User-level configuration
  • Site-level /etc deployment (for centrally managed systems)

Offline troubleshooting workflow

One of qtop's strengths is reproducibility from captured scheduler output.

For PBS-like environments, collect:

qstat -q > qstat_q.txt
qstat > qstat.txt
pbsnodes -a > pbsnodes_a.txt
tar -zcvf my_qtop_source_tarball.tar.gz pbsnodes_a.txt qstat_q.txt qstat.txt

Then replay using a source directory:

./qtop -s mydir/

This makes debugging much easier because the same input can be shared and reproduced exactly.