Skip to main content

A sleek, modern job monitoring tool for Slurm workload manager

Project description

🎯 SWATCH (Slurm Watch)

A sleek, modern job monitoring tool for Slurm workload manager that doesn't make you want to pull your hair out!

SWATCH GUI

🌟 Features

  • 🎨 Beautiful dark theme interface
  • 🔄 Real-time job status monitoring
  • 🔐 Secure SSH authentication
  • 🎯 Status-based color coding
  • ⚡ Configurable auto-refresh
  • 🎮 Drag-and-drop window movement
  • 🧪 Test mode for demos and development

📦 Installation

Using pip

pip install swatch-slurm

Development Installation

git clone https://github.com/Jakeelamb/SWATCH.git
cd SWATCH
pip install -e ".[dev]"

🚀 Usage

After installation, simply run the tool using the swatch command:

# Run SWATCH with normal mode
swatch

# Run SWATCH in test mode
swatch --test

🎮 Command Line Options

Flag Description Example
-h, --help Show help message and exit swatch --help
-t, --test Run in test mode with sample data swatch --test

🎯 Job Status Colors

Status Color Description
🟢 Running Soft Green Job is actively running
🟡 Pending Soft Orange Job is waiting in queue
🔵 Completed Soft Blue Job finished successfully
🔴 Failed Soft Red Job failed or timed out

⚙️ Configuration

SWATCH automatically saves your configuration in ~/.hpcjobmonitor/config.json. You can:

  • 💾 Save login credentials (optional)
  • ⏰ Set refresh intervals:
    • 5 seconds
    • 30 seconds
    • 1 minute
    • 5 minutes
    • 10 minutes
    • 30 minutes

🔒 Security Note

When saving credentials, passwords are stored locally. For enhanced security:

  • 🚫 Don't save credentials on shared machines
  • ✅ Use SSH keys when possible
  • 🔑 Ensure ~/.hpcjobmonitor has appropriate permissions

🎨 Interface Features

  • 🖱️ Draggable window (click and drag title bar)
  • 📊 Sortable job columns
  • 🎯 Status indicators
  • 📈 Job statistics summary
  • ⏱️ Auto-refresh toggle

🤝 Contributing

Found a bug? Want to add a feature? We'd love your help!

  1. 🍴 Fork the repository
  2. 🌿 Create your feature branch
  3. 💾 Commit your changes
  4. 📤 Push to the branch
  5. 🎯 Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🎉 Fun Facts

  • The name "SWATCH" comes from "Slurm Watch" (not the watch company! 😉)

🐛 Known Issues

Remember: Happy monitoring! 🚀

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

swatch_slurm-0.1.1.tar.gz (61.0 kB view details)

Uploaded Source

Built Distribution

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

swatch_slurm-0.1.1-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file swatch_slurm-0.1.1.tar.gz.

File metadata

  • Download URL: swatch_slurm-0.1.1.tar.gz
  • Upload date:
  • Size: 61.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for swatch_slurm-0.1.1.tar.gz
Algorithm Hash digest
SHA256 1f848edec36794265a7d2e76a387898403c072d661ce9bfb7656f688a402635d
MD5 99de1143a5400cec3a5a380405382c02
BLAKE2b-256 00f435f9872ed251f983179118e5c0cff53fc0a95a3b4734e0de2618aac47eaa

See more details on using hashes here.

File details

Details for the file swatch_slurm-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: swatch_slurm-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for swatch_slurm-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b73528b29cdf9ee421e9cad4b33f6d71386edc8761d91d674395d603133b0967
MD5 a651e6a80435f2ffcae69ff7901e2f9e
BLAKE2b-256 07165bc2950769dd82942d62115211cb7d0a3b2122a1aa3de75aabb08ad3a009

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