| Name | slurm-top-python JSON |
| Version |
1.0.0a9
JSON |
| download |
| home_page | None |
| Summary | A task manager written in Python for HPC systems that use Slurm |
| upload_time | 2025-07-30 02:15:34 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=2.7 |
| license | The MIT License (MIT)
Copyright (c) 2025 Aashray Reddy
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Includes other software related under the MIT license:
- ptop, Copyright (c) 2018 Ankush Sharma. For licensing, see LICENSE-ptop |
| keywords |
top
slurm_top_python
task manager
python
slurm
hpc
ptop
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# slurm_top_python
`slurm_top_python` is a task manager for high-performance computing systems that use Slurm. It was originally designed for the UCSD Expanse servers, but can work on other servers that use Slurm and Slurm jobs.
Credit to [ptop](https://github.com/darxtrix/ptop) - original creators of the Python taskmanager app that this is based on. You can view the licensing under the LICENSE file. This app is an adaptation of their program.
## Work in progress
## Installation
`slurm_top_python` is compaible with both Python2.x and Python3.x and is tested on Linux and MaxOSx (should be invoked as root) environments.
```bash
pip install slurm_top_python
```
or
```bash
git clone https://github.com/kinetekenergy/slurm_top_python
cd slurm_top_python/
pip install -r requirements.txt # install requirements
sudo python setup.py install
```
## Upgrading slurm_top_python
```bash
pip install --upgrade slurm_top_python
```
## Usage
```bash
slurm_top_python
```
Alternatively, you can type `s_top`.
## Common Errors
When running the program, you might get the following error: `(<class 'npyscreen.wgwidget.NotEnoughSpaceForWidget'>, NotEnoughSpaceForWidget('Not enough space for requested size'), <traceback object at 0x155552ca4e00>)`.
This means that your terminal size isn't big enough. To fix this, make your terminal window larger. You can maximize it or manually make it larger.
## Developing slurm_top_python
```bash
git clone https://github.com/kinetekenergy/slurm_top_python
code slurm_top_python # vscode is preferred, but any IDE that supports docker + devcontainers will work
```
Open the devcontainer in your IDE. If you are using vscode, there will be a pop-up asking to reopen the folder in a devcontainer. Accept it, and all the necessary tools will be installed.
**Note:** slurm_top_python will create a log file called `.slurm_top_python.log` in the home directory of the user.
## Main modules
- `slurm_top_python.core` : Defines a basic `Plugin` class that other plugins in the `slurm_top_python.plugins` inherit.
- `slurm_top_python.interfaces` : The interface to the slurm_top_python built using npyscreen.
- `slurm_top_python.plugins` : This module contains all the plugin sensors supported i.e `Disk Sensor`,`Memory Sensor`,`Process Sensor`, etc. ( Any new plugin should be added here).
- `slurm_top_python.statistics` : Generate continuous statistics using background thread jobs by locating plugins in the plugins directory.
- `slurm_top_python.utils` : Custom thread classes.
## Publishing
**First time:**
```bash
python -m build
python -m twine upload dist/*
# enter your api key when prompted
```
**To update:**
First, update your version number. Then:
```bash
python -m build
python -m twine upload dist/<the .whl file that was generated>
# enter your api key when prompted
```
Raw data
{
"_id": null,
"home_page": null,
"name": "slurm-top-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=2.7",
"maintainer_email": null,
"keywords": "top, slurm_top_python, task manager, python, slurm, HPC, ptop",
"author": null,
"author_email": "Aashray Reddy <aashrayr.101@gmail.com>",
"download_url": null,
"platform": null,
"description": "# slurm_top_python\n\n`slurm_top_python` is a task manager for high-performance computing systems that use Slurm. It was originally designed for the UCSD Expanse servers, but can work on other servers that use Slurm and Slurm jobs.\n\nCredit to [ptop](https://github.com/darxtrix/ptop) - original creators of the Python taskmanager app that this is based on. You can view the licensing under the LICENSE file. This app is an adaptation of their program.\n\n## Work in progress\n\n## Installation\n\n`slurm_top_python` is compaible with both Python2.x and Python3.x and is tested on Linux and MaxOSx (should be invoked as root) environments.\n\n```bash\npip install slurm_top_python\n```\n\nor\n\n```bash\ngit clone https://github.com/kinetekenergy/slurm_top_python\ncd slurm_top_python/\npip install -r requirements.txt # install requirements\nsudo python setup.py install\n```\n\n## Upgrading slurm_top_python\n\n```bash\npip install --upgrade slurm_top_python\n```\n\n## Usage\n\n```bash\nslurm_top_python\n```\n\nAlternatively, you can type `s_top`.\n\n## Common Errors\n\nWhen running the program, you might get the following error: `(<class 'npyscreen.wgwidget.NotEnoughSpaceForWidget'>, NotEnoughSpaceForWidget('Not enough space for requested size'), <traceback object at 0x155552ca4e00>)`.\n\nThis means that your terminal size isn't big enough. To fix this, make your terminal window larger. You can maximize it or manually make it larger.\n\n## Developing slurm_top_python\n\n```bash\ngit clone https://github.com/kinetekenergy/slurm_top_python\ncode slurm_top_python # vscode is preferred, but any IDE that supports docker + devcontainers will work\n```\n\nOpen the devcontainer in your IDE. If you are using vscode, there will be a pop-up asking to reopen the folder in a devcontainer. Accept it, and all the necessary tools will be installed.\n\n\n**Note:** slurm_top_python will create a log file called `.slurm_top_python.log` in the home directory of the user.\n\n## Main modules\n\n- `slurm_top_python.core` : Defines a basic `Plugin` class that other plugins in the `slurm_top_python.plugins` inherit.\n- `slurm_top_python.interfaces` : The interface to the slurm_top_python built using npyscreen.\n- `slurm_top_python.plugins` : This module contains all the plugin sensors supported i.e `Disk Sensor`,`Memory Sensor`,`Process Sensor`, etc. ( Any new plugin should be added here).\n- `slurm_top_python.statistics` : Generate continuous statistics using background thread jobs by locating plugins in the plugins directory.\n- `slurm_top_python.utils` : Custom thread classes.\n\n## Publishing\n\n**First time:**\n\n```bash\npython -m build\npython -m twine upload dist/*\n# enter your api key when prompted\n```\n\n**To update:**\n\nFirst, update your version number. Then:\n\n```bash\npython -m build\npython -m twine upload dist/<the .whl file that was generated>\n# enter your api key when prompted\n```\n",
"bugtrack_url": null,
"license": "The MIT License (MIT)\n \n Copyright (c) 2025 Aashray Reddy\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n \n Includes other software related under the MIT license:\n - ptop, Copyright (c) 2018 Ankush Sharma. For licensing, see LICENSE-ptop",
"summary": "A task manager written in Python for HPC systems that use Slurm",
"version": "1.0.0a9",
"project_urls": {
"Download": "https://github.com/kinetekenergy/slurm_top_python/releases/download/v1.0.0a1/slurm_top_python-1.0.0a1_2025-07-22.tar.gz",
"Homepage": "https://github.com/kinetekenergy/slurm_top_python",
"Issues": "https://github.com/kinetekenergy/slurm_top_python"
},
"split_keywords": [
"top",
" slurm_top_python",
" task manager",
" python",
" slurm",
" hpc",
" ptop"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "12d07fa24e8cbbe63e046d8111d297f57486b6cb38b79fa72cb7452c782ff745",
"md5": "fbf91ac8deb73c0229862582a34d988c",
"sha256": "f443af5851d87c56dd95f5dcd68a683ab8387c2ada7953c2d70c3a971eaa72d1"
},
"downloads": -1,
"filename": "slurm_top_python-1.0.0a9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fbf91ac8deb73c0229862582a34d988c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=2.7",
"size": 26025,
"upload_time": "2025-07-30T02:15:34",
"upload_time_iso_8601": "2025-07-30T02:15:34.729560Z",
"url": "https://files.pythonhosted.org/packages/12/d0/7fa24e8cbbe63e046d8111d297f57486b6cb38b79fa72cb7452c782ff745/slurm_top_python-1.0.0a9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-30 02:15:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kinetekenergy",
"github_project": "slurm_top_python",
"github_not_found": true,
"lcname": "slurm-top-python"
}
