Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kerrychu committed Jan 17, 2024
1 parent bfddec2 commit f3c478d
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# Bunya Jobs
# SlurmWatch

**⚠️This repo is still under ACTIVE development.**

## Huh?
- **Slurm** is a robust open-source workload manager designed for high-performance computing clusters. It efficiently allocates resources, manages job submissions, and optimizes task execution. With commands like `sbatch` and `squeue`, Slurm provides a flexible and scalable solution for seamless task control and monitoring, making it a preferred choice in academic and research settings. Various research centers and universities have unique names for their Slurm clusters. At the University of Queensland, our clusters go by the distinctive name "Bunya."

## SlurmWatch

Introducing **SlurmWatch** - a tool meticulously crafted for effortless monitoring of sbatch jobs. Say goodbye to uncertainties; experience prompt notifications, ensuring you stay informed and in control.

## Scheduling

- For the moment, you can fork it, or just clone it and use crontab to run `monitor.py`
Expand All @@ -16,3 +23,14 @@

- follow [slack webhook tutorial](https://api.slack.com/messaging/webhooks) to create a slack app for your slack workspace and add it to appropriate channels
- remember to replace the `.env` webhook to your own

## Future Integrations

Currently, the future integrations considered are
- email

Feel free to create an issue or contact me at `xiaoran.chu@uq.edu.au` (call me kerry please)

or

Simply fork the repo and create a pull request and let's crunch some code together.

0 comments on commit f3c478d

Please sign in to comment.