Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grburgess/slurmworm
to monitor mein slurm jobs
https://github.com/grburgess/slurmworm
email-notification slurm
Last synced: about 1 month ago
JSON representation
to monitor mein slurm jobs
- Host: GitHub
- URL: https://github.com/grburgess/slurmworm
- Owner: grburgess
- License: gpl-3.0
- Created: 2020-11-11T15:01:43.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-26T12:36:42.000Z (over 2 years ago)
- Last Synced: 2024-10-06T00:46:36.679Z (3 months ago)
- Topics: email-notification, slurm
- Language: Python
- Homepage:
- Size: 165 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# slurmworm
This is a rather simple tool to monitor SLURM emails and alert you via a telegram bot about your jobs.
**Note!** This is under heavy development!
## Installation
* install [imapclient](https://github.com/mjs/imapclient) directly from the github repo *not* pip
* clone this repo and run
```bash
python setup install
```
* create a directory ```~/.config/slurmworm```
* in this directory you need to place two files.
* * one is the telegram bot info for the *your* bot that you must [create](https://firstwarning.net/vanilla/discussion/4/create-telegram-bot-and-get-bots-token-and-the-groups-chat-id) named ```access.yml```
* * the other is a UNIX conf file with your IMAP email info named ```imap_monitor.ini``` which identifies the email account to which you will send slurm messages
## Telegram bot setup
If you read the above guide to create your bot you will have nearly everything you need. You then need to get that info into your ```access.yml``` file:
```yaml
token:
''
chat_id:
''
```
You should have your bot chat to a group you have created.
## email setup
This is what should go in ```imap_monitor.ini```:
```ini
[imap]
host =
username =
password =
ssl = True
folder = INBOX
[path]
download =
```
## Running
After you have installed and set everything up, just type
```bash
slurmworm
```
in a shell and it will run and monitor your email.
It is likely best to have this running in a tmux shell you can disconnect from.
May all your jobs exit 0!