https://github.com/auneri/ipyslurm

Python interface to Slurm Workload Manager.
https://github.com/auneri/ipyslurm

ipython jupyter slurm

Last synced: 4 days ago
JSON representation

Python interface to Slurm Workload Manager.

• Host: GitHub
• URL: https://github.com/auneri/ipyslurm
• Owner: auneri
• License: mit
• Created: 2017-11-26T04:00:31.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2023-11-21T19:13:49.000Z (about 1 year ago)
• Last Synced: 2024-04-23T15:41:15.320Z (10 months ago)
• Topics: ipython, jupyter, slurm
• Language: Python
• Homepage: https://auneri.github.io/ipyslurm/
• Size: 187 KB
• Stars: 6
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# ipyslurm

Python interface to [Slurm Workload Manager](https://slurm.schedmd.com).

[![license](https://img.shields.io/github/license/auneri/ipyslurm)](https://github.com/auneri/ipyslurm/blob/main/LICENSE.md)

[![build](https://img.shields.io/github/actions/workflow/status/auneri/ipyslurm/main.yml)](https://github.com/auneri/ipyslurm/actions)

[![pypi](https://img.shields.io/pypi/v/ipyslurm)](https://pypi.org/project/ipyslurm)

[![conda-forge](https://img.shields.io/conda/vn/conda-forge/ipyslurm)](https://anaconda.org/conda-forge/ipyslurm)

## Getting started

Install using `pip install ipyslurm` or `conda install -c conda-forge ipyslurm`.

See [example notebooks](https://github.com/auneri/ipyslurm/tree/main/examples) for different use cases.

## Magic commands

Line magics: `sinteract`, `slogin`, `slogout`, `stail`  

Cell magics: `scommand`, `sbatch`, `sftp`, `swritefile`

Use [?](http://ipython.readthedocs.io/en/stable/interactive/tutorial.html#exploring-your-objects) to get help on individual commands.

## Releasing a new version

1. Update `project.version` in `pyproject.toml` and `CHANGELOG` with commit message "Release vX.X.X".

2. Add tag vX.X.X with message "Release vX.X.X".

3. Push the tag and create a new release on [ipyslurm](https://github.com/auneri/ipyslurm).

4. Merge the auto-generated pull request on [ipyslurm-feedstock](https://github.com/conda-forge/ipyslurm-feedstock).