Skip to main content

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

Metadata

Release files for research-dashboard 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for research-dashboard 0.1.0
File Size Uploaded Provenance
research_dashboard-0.1.0.tar.gz 7.2 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for research-dashboard 0.1.0
File Interpreter ABI Platform
research_dashboard-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 14.4 kB

Release files / research_dashboard-0.1.0.tar.gz

Download URL research_dashboard-0.1.0.tar.gz
Size 7.2 kB
Tags Source
SHA-256 checksum
How to use checksums
e558daee8895e7f278087067a98fa0a41d98e12125b0ecab25468c95b68eae6e
BLAKE2b-256 checksum
How to use checksums
7d3e920abfde6e20fc6fc3f5513e7f820323f6dd95d9b2ccdf3a61f4482cef60
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.2

Release files / research_dashboard-0.1.0-py3-none-any.whl

Download URL research_dashboard-0.1.0-py3-none-any.whl
Size 7.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fa9c14ac70350b0eea085bbabd87920726dd0ed5bd4a969c35ecad4c7bf3637f
BLAKE2b-256 checksum
How to use checksums
60a1ba377a0ec4d15ec4e74451408a94a1341655123d12f68fb1b5fa858c2d84
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.2

Security for research-dashboard 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page