slurmipy

Name	slurmipy JSON
Version	2024.0.4 JSON
	download
home_page	None
Summary	A package to manage Dask clusters on SLURM systems and execute functions with Dask parallelization.
upload_time	2024-10-23 19:30:04
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	MIT License
keywords	python slurm
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # SlurmiPy

Run python functions on a SLURM cluster as easy as:
```
@slurm_cluster.execute
def hello_world():
    print("YAY, I am running via SLURM!")
```

SlurmiPy provides a factory class for managing Dask clusters on SLURM-based systems and provides very easy exectution of python code on a SLURM cluster.

## Installation

```bash
pip install slurmipy
```

## Usage

Here iss a basic example of how to use `SlurmiPy` on NERSCs' Perlmutter Supercomputer:

```python
from slurmipy import SlurmiPy, configs

# Create a SLURM cluster with 4 jobs
slurm_cluster = SlurmiPy(jobs=4, **configs["perlmutter_shared_interactive"])

@slurm_cluster.execute
def process_data(data):
    return [x**2 for x in data]

# Execute the function using the SLURM cluster
result = process_data([1, 2, 3, 4])

print(result)  # Output: [1, 4, 9, 16]
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "slurmipy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "python, slurm",
    "author": null,
    "author_email": "Dennis Noll <github@nollde.de>",
    "download_url": "https://files.pythonhosted.org/packages/26/d4/61cc3a9669e7107c9025a18c4a44d20e409f9e3510576d0e3c6ddc41ad1e/slurmipy-2024.0.4.tar.gz",
    "platform": null,
    "description": "# SlurmiPy\n\nRun python functions on a SLURM cluster as easy as:\n```\n@slurm_cluster.execute\ndef hello_world():\n    print(\"YAY, I am running via SLURM!\")\n```\n\nSlurmiPy provides a factory class for managing Dask clusters on SLURM-based systems and provides very easy exectution of python code on a SLURM cluster.\n\n## Installation\n\n```bash\npip install slurmipy\n```\n\n## Usage\n\nHere iss a basic example of how to use `SlurmiPy` on NERSCs' Perlmutter Supercomputer:\n\n```python\nfrom slurmipy import SlurmiPy, configs\n\n# Create a SLURM cluster with 4 jobs\nslurm_cluster = SlurmiPy(jobs=4, **configs[\"perlmutter_shared_interactive\"])\n\n@slurm_cluster.execute\ndef process_data(data):\n    return [x**2 for x in data]\n\n# Execute the function using the SLURM cluster\nresult = process_data([1, 2, 3, 4])\n\nprint(result)  # Output: [1, 4, 9, 16]\n```\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "A package to manage Dask clusters on SLURM systems and execute functions with Dask parallelization.",
    "version": "2024.0.4",
    "project_urls": {
        "Homepage": "https://github.com/nollde/slurmipy",
        "Issues": "https://github.com/nollde/slurmipy/issues"
    },
    "split_keywords": [
        "python",
        " slurm"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4f2a9307bec5ca09740ae55066651aa0b08c500f5bd7b62d08c6fe90bfb5431d",
                "md5": "0c87b092bef42595ba97b4f1a8de3fb5",
                "sha256": "fae82e3bd7ea51cebb69cdf48e1b9a686e19fe017ce366251bc0cb6d2b6e2313"
            },
            "downloads": -1,
            "filename": "slurmipy-2024.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0c87b092bef42595ba97b4f1a8de3fb5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 3431,
            "upload_time": "2024-10-23T19:30:03",
            "upload_time_iso_8601": "2024-10-23T19:30:03.859084Z",
            "url": "https://files.pythonhosted.org/packages/4f/2a/9307bec5ca09740ae55066651aa0b08c500f5bd7b62d08c6fe90bfb5431d/slurmipy-2024.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "26d461cc3a9669e7107c9025a18c4a44d20e409f9e3510576d0e3c6ddc41ad1e",
                "md5": "6e2def54d664cb7a070bff2d48339aa3",
                "sha256": "2b3b607e652ad58341e11d4e8311d496347df781d80d599536d2b33307802999"
            },
            "downloads": -1,
            "filename": "slurmipy-2024.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "6e2def54d664cb7a070bff2d48339aa3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 2733,
            "upload_time": "2024-10-23T19:30:04",
            "upload_time_iso_8601": "2024-10-23T19:30:04.896877Z",
            "url": "https://files.pythonhosted.org/packages/26/d4/61cc3a9669e7107c9025a18c4a44d20e409f9e3510576d0e3c6ddc41ad1e/slurmipy-2024.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-23 19:30:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nollde",
    "github_project": "slurmipy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "slurmipy"
}