Skip to main content

Tmux-based system monitoring dashboard for ML research workstations

Project description

research-dashboard

PyPI version CI Python 3.10+ License: MIT

A tmux-based system monitoring dashboard for ML research workstations. One command gives you GPU, CPU, disk I/O, network, temperatures, RAID status, and live log tailing in a single terminal.

Screenshot placeholder

Installation

pip install research-dashboard

Or install from source:

git clone https://github.com/ahbond/research-dashboard.git
cd research-dashboard
pip install -e .

Usage

research-dashboard

Options

Flag Description
--session-name Tmux session name (default: atlas-dash)
--no-gpu Skip GPU monitoring pane
--no-net Skip network monitoring pane
--no-disk Skip disk I/O monitoring pane
--dry-run Print tmux commands without executing them

Examples

# Launch with defaults
research-dashboard

# Custom session name, skip network pane
research-dashboard --session-name ml-monitor --no-net

# Preview commands without launching
research-dashboard --dry-run

Layout

+---------------------+----------------------+
|    nvtop (GPUs)     |   htop (processes)   |
|                     |                       |
+----------+----------+----------+------------+
| iotop    | nethogs  | sensors  | live logs  |
| (disk)   | (net)    | raid/df  |            |
+----------+----------+----------+------------+
  • Top-left -- GPU monitoring via nvtop (falls back to nvidia-smi watch)
  • Top-right -- Process monitoring via htop (falls back to btop or top)
  • Bottom-left -- Disk I/O via iotop (falls back to iostat)
  • Bottom-mid-left -- Network via nethogs (falls back to nload or /proc/net/dev)
  • Bottom-mid-right -- Temperatures, GPU stats, RAID status, disk usage
  • Bottom-right -- Live log tailing from /tmp/*.log

Requirements

  • tmux (required)
  • Optional monitoring tools (the dashboard adapts to what is installed):
    • nvtop or nvidia-smi -- GPU monitoring
    • htop, btop, or top -- process monitoring
    • iotop or iostat -- disk I/O
    • nethogs or nload -- network monitoring
    • sensors (lm-sensors) -- temperature readings

Install everything on Ubuntu/Debian:

sudo apt install tmux nvtop htop iotop nethogs lm-sensors

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

research_dashboard-0.1.0.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

research_dashboard-0.1.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file research_dashboard-0.1.0.tar.gz.

File metadata

  • Download URL: research_dashboard-0.1.0.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for research_dashboard-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e558daee8895e7f278087067a98fa0a41d98e12125b0ecab25468c95b68eae6e
MD5 967753a4ea3a14d8c27d6bdf97754d7b
BLAKE2b-256 7d3e920abfde6e20fc6fc3f5513e7f820323f6dd95d9b2ccdf3a61f4482cef60

See more details on using hashes here.

File details

Details for the file research_dashboard-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for research_dashboard-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fa9c14ac70350b0eea085bbabd87920726dd0ed5bd4a969c35ecad4c7bf3637f
MD5 9b64a7dde8a17e15c3af7a509c16ccf1
BLAKE2b-256 60a1ba377a0ec4d15ec4e74451408a94a1341655123d12f68fb1b5fa858c2d84

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page