# slurm-sbalance
`sbalance` is a Slurm utility for checking account balance. The utility calculates the remaining *service units* or *SU* left in the account.
# Prerequisites
* Slurm with Accounting enabled
Currently `sbalance` has been tested with:
* Python 2.7.5 and Python 3.6.6
* Slurm 18.08.5
# Usage
```
usage: sbalance [-h] [-V] [-k] [-m] [-v]
Query slurm account balance.
optional arguments:
-h, --help show this help message and exit
-V, --version show program's version number and exit
-k show output in kSU (1,000 SU)
-m show output in MSU (1,000,000 SU)
-v, --verbose verbose mode (multiple -v's increase verbosity)
```
# Setting up Slurm
`sbalance` currently support following setup.
* Balance is limited per account
* Account limit is set through QoS with `GrpTRESMins` and `NoDecay` flag.
Following is an example setup
Creating account `tutorial` and QoS `test` with billing balance of 1000000
```
sacctmgr add qos test set GrpTRESMins=billing=1000000 Flags=NoDecay
sacctmgr add account tutorial set QoS=test DefaultQoS=test
```
Add `test` user to account `tutorial`
```
sacctmgr add user test set Account=tutorial
```
Checking balance for `test` user
```
[test@localhost ~]$ sbalance
Account balances for user: test
tutorial:
Allocation: 1000000.00 SU
Remaining Balance: 991896.00 SU ( 99.19%)
Used: 8104.00 SU
```
Raw data
{
"_id": null,
"home_page": "https://github.com/puttsk/slurm-sbalance",
"name": "slurm-sbalance",
"maintainer": null,
"docs_url": null,
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,<4",
"maintainer_email": null,
"keywords": "slurm",
"author": "Putt Sakdhnagool",
"author_email": "putt.sakdhnagool@nectec.or.th",
"download_url": "https://files.pythonhosted.org/packages/00/94/8d3ffaee7c7c8c2a6c5d5070ee88316b5481ea90ce525b73da6fe1d521c2/slurm-sbalance-0.2.3.tar.gz",
"platform": null,
"description": "# slurm-sbalance\n`sbalance` is a Slurm utility for checking account balance. The utility calculates the remaining *service units* or *SU* left in the account. \n\n# Prerequisites\n* Slurm with Accounting enabled \n\nCurrently `sbalance` has been tested with: \n* Python 2.7.5 and Python 3.6.6\n* Slurm 18.08.5\n\n# Usage\n```\nusage: sbalance [-h] [-V] [-k] [-m] [-v]\n\nQuery slurm account balance.\n\noptional arguments:\n -h, --help show this help message and exit\n -V, --version show program's version number and exit\n -k show output in kSU (1,000 SU)\n -m show output in MSU (1,000,000 SU)\n -v, --verbose verbose mode (multiple -v's increase verbosity)\n\n```\n\n# Setting up Slurm\n`sbalance` currently support following setup. \n* Balance is limited per account\n* Account limit is set through QoS with `GrpTRESMins` and `NoDecay` flag.\n\nFollowing is an example setup\n\nCreating account `tutorial` and QoS `test` with billing balance of 1000000\n```\nsacctmgr add qos test set GrpTRESMins=billing=1000000 Flags=NoDecay \nsacctmgr add account tutorial set QoS=test DefaultQoS=test\n```\n\nAdd `test` user to account `tutorial`\n```\nsacctmgr add user test set Account=tutorial\n```\n\nChecking balance for `test` user\n```\n[test@localhost ~]$ sbalance \nAccount balances for user: test\ntutorial:\n\tAllocation: 1000000.00 SU\n\tRemaining Balance: 991896.00 SU ( 99.19%)\n\tUsed: 8104.00 SU\n```\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Slurm utility for checking account balance",
"version": "0.2.3",
"project_urls": {
"Bug Reports": "https://github.com/puttsk/slurm-sbalance/issues",
"Homepage": "https://github.com/puttsk/slurm-sbalance",
"Source": "https://github.com/puttsk/slurm-sbalance/"
},
"split_keywords": [
"slurm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d0bbdd2c1e33db03c2381657b37ee3d472b8ce587dda3762539237164bcd3c6",
"md5": "2fb5198380ed88175c697f28f8c62e6b",
"sha256": "f1e2c2b5da83c0e5e679b0d7ae8f287d2a8959589f27d891786906a78fa19d6b"
},
"downloads": -1,
"filename": "slurm_sbalance-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2fb5198380ed88175c697f28f8c62e6b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,<4",
"size": 10219,
"upload_time": "2024-05-17T04:04:00",
"upload_time_iso_8601": "2024-05-17T04:04:00.509455Z",
"url": "https://files.pythonhosted.org/packages/3d/0b/bdd2c1e33db03c2381657b37ee3d472b8ce587dda3762539237164bcd3c6/slurm_sbalance-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "00948d3ffaee7c7c8c2a6c5d5070ee88316b5481ea90ce525b73da6fe1d521c2",
"md5": "14aa82df6995a5baf55f4d657f5a20d4",
"sha256": "5b5f9e999ad657fcba4f19a7ababe447ffdfea47e88dda3e545e49b3e69e45dd"
},
"downloads": -1,
"filename": "slurm-sbalance-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "14aa82df6995a5baf55f4d657f5a20d4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,<4",
"size": 9504,
"upload_time": "2024-05-17T04:04:02",
"upload_time_iso_8601": "2024-05-17T04:04:02.711572Z",
"url": "https://files.pythonhosted.org/packages/00/94/8d3ffaee7c7c8c2a6c5d5070ee88316b5481ea90ce525b73da6fe1d521c2/slurm-sbalance-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-17 04:04:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "puttsk",
"github_project": "slurm-sbalance",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "bleach",
"specs": [
[
"==",
"3.1.4"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2018.11.29"
]
]
},
{
"name": "chardet",
"specs": [
[
"==",
"3.0.4"
]
]
},
{
"name": "docutils",
"specs": [
[
"==",
"0.14"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"2.8"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"1.16.6"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"0.24.2"
]
]
},
{
"name": "pkginfo",
"specs": [
[
"==",
"1.5.0.1"
]
]
},
{
"name": "Pygments",
"specs": [
[
"==",
"2.3.1"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"==",
"2.8.1"
]
]
},
{
"name": "pytz",
"specs": [
[
"==",
"2019.3"
]
]
},
{
"name": "readme-renderer",
"specs": [
[
"==",
"24.0"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.21.0"
]
]
},
{
"name": "requests-toolbelt",
"specs": [
[
"==",
"0.9.1"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.12.0"
]
]
},
{
"name": "tqdm",
"specs": [
[
"==",
"4.31.1"
]
]
},
{
"name": "twine",
"specs": [
[
"==",
"1.13.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"1.24.2"
]
]
},
{
"name": "webencodings",
"specs": [
[
"==",
"0.5.1"
]
]
}
],
"lcname": "slurm-sbalance"
}
JSON
