slurmgen


Nameslurmgen JSON
Version 3.4.0 PyPI version JSON
download
home_pageNone
SummarySlurmGen - Simple Slurm Manager
upload_time2024-05-03 06:49:21
maintainerNone
docs_urlNone
authorNone
requires_python>=3.6
licenseBSD-2-Clause
keywords python slurm hpc cluster
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # SlurmGen - Simple Slurm Manager

> * **Repository: [github.com/otvam/slurmgen](https://github.com/otvam/slurmgen)**
> * **Package: [pypi.org/project/slurmgen](https://pypi.org/project/slurmgen)**

## Summary

**SlurmGen** is a very **simple** **Slurm** manager:
* The job description is stored in JSON files.
* The JSON files are transformed into Slurm scripts.
* The Slurm script can be run locally or on a Slurm Cluster.

**SlurmGen** is only supporting a small **subset** of **Slurm**:
* Create and delete folders.
* Set environment variables.
* Set the job name and log.
* Set the ressources (memory, time, CPU, etc.).
* Define the set of commands to be executed.

SlurmGen is not a binding and/or a wrapper for Slurm.
SlurmGen is only generating Slurm scripts from JSON files.
SlurmGen is written in Python without any external dependencies.

## Example

An example is located in the `example` folder of the repository:
* `job_def.json` contains the job definition
* `job_tmpl.json` contains the template data
* `run_slurm.py` contains is dummy script executed by the jon
* `slurm_output` contains the generated Slurm script and log file
* `data_output` contains data generated by the Slurm job

```bash
# Create a Slurm script with a command line template.
sgen job_def.json --tmpl_str "title" "test" --tmpl_str "var" "Welcome to everyone"

# Create a Slurm script with a JSON file template.
sgen job_def.json --tmpl_file job_tmpl.json

# Create a Slurm script and run the job locally.
sgen job_def.json --local --tmpl_file job_tmpl.json

# Create a Slurm script and run the job on the cluster.
sgen job_def.json --cluster --tmpl_file job_tmpl.json
```

## Project Links

* Repository: https://github.com/otvam/slurmgen
* Releases: https://github.com/otvam/slurmgen/releases
* Tags: https://github.com/otvam/slurmgen/tags
* Issues: https://github.com/otvam/slurmgen/issues
* PyPi: https://pypi.org/project/slurmgen

## Author

* **Thomas Guillod**
* Email: guillod@otvam.ch
* Website: https://otvam.ch

## Copyright

> (c) 2023 - Thomas Guillod
> 
>  BSD 2-Clause "Simplified" License

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "slurmgen",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "Thomas Guillod <guillod@otvam.ch>",
    "keywords": "Python, Slurm, HPC, Cluster",
    "author": null,
    "author_email": "Thomas Guillod <guillod@otvam.ch>",
    "download_url": "https://files.pythonhosted.org/packages/5c/93/38751f3cdaf475ee265d2851ce0fe02ddc71f94c1c5cbda9e6e4979e3a58/slurmgen-3.4.0.tar.gz",
    "platform": null,
    "description": "# SlurmGen - Simple Slurm Manager\n\n> * **Repository: [github.com/otvam/slurmgen](https://github.com/otvam/slurmgen)**\n> * **Package: [pypi.org/project/slurmgen](https://pypi.org/project/slurmgen)**\n\n## Summary\n\n**SlurmGen** is a very **simple** **Slurm** manager:\n* The job description is stored in JSON files.\n* The JSON files are transformed into Slurm scripts.\n* The Slurm script can be run locally or on a Slurm Cluster.\n\n**SlurmGen** is only supporting a small **subset** of **Slurm**:\n* Create and delete folders.\n* Set environment variables.\n* Set the job name and log.\n* Set the ressources (memory, time, CPU, etc.).\n* Define the set of commands to be executed.\n\nSlurmGen is not a binding and/or a wrapper for Slurm.\nSlurmGen is only generating Slurm scripts from JSON files.\nSlurmGen is written in Python without any external dependencies.\n\n## Example\n\nAn example is located in the `example` folder of the repository:\n* `job_def.json` contains the job definition\n* `job_tmpl.json` contains the template data\n* `run_slurm.py` contains is dummy script executed by the jon\n* `slurm_output` contains the generated Slurm script and log file\n* `data_output` contains data generated by the Slurm job\n\n```bash\n# Create a Slurm script with a command line template.\nsgen job_def.json --tmpl_str \"title\" \"test\" --tmpl_str \"var\" \"Welcome to everyone\"\n\n# Create a Slurm script with a JSON file template.\nsgen job_def.json --tmpl_file job_tmpl.json\n\n# Create a Slurm script and run the job locally.\nsgen job_def.json --local --tmpl_file job_tmpl.json\n\n# Create a Slurm script and run the job on the cluster.\nsgen job_def.json --cluster --tmpl_file job_tmpl.json\n```\n\n## Project Links\n\n* Repository: https://github.com/otvam/slurmgen\n* Releases: https://github.com/otvam/slurmgen/releases\n* Tags: https://github.com/otvam/slurmgen/tags\n* Issues: https://github.com/otvam/slurmgen/issues\n* PyPi: https://pypi.org/project/slurmgen\n\n## Author\n\n* **Thomas Guillod**\n* Email: guillod@otvam.ch\n* Website: https://otvam.ch\n\n## Copyright\n\n> (c) 2023 - Thomas Guillod\n> \n>  BSD 2-Clause \"Simplified\" License\n",
    "bugtrack_url": null,
    "license": "BSD-2-Clause",
    "summary": "SlurmGen - Simple Slurm Manager",
    "version": "3.4.0",
    "project_urls": {
        "Homepage": "https://github.com/otvam/slurmgen",
        "Issues": "https://github.com/otvam/slurmgen/issues",
        "Releases": "https://github.com/otvam/slurmgen/releases",
        "Repository": "https://github.com/otvam/slurmgen",
        "Tags": "https://github.com/otvam/slurmgen/tags"
    },
    "split_keywords": [
        "python",
        " slurm",
        " hpc",
        " cluster"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "85c4bf8d6d54b0b7c66c2a7727bd7f538ac1fd0eddd0dbe6847650a0e76e0b74",
                "md5": "9557d2726e4ead27abb1448f9110ad0f",
                "sha256": "1b8b17833f30787b492af894b3da3f7a0f7b9aa2ffef211321bb0b94057c0b14"
            },
            "downloads": -1,
            "filename": "slurmgen-3.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9557d2726e4ead27abb1448f9110ad0f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 8783,
            "upload_time": "2024-05-03T06:49:20",
            "upload_time_iso_8601": "2024-05-03T06:49:20.432574Z",
            "url": "https://files.pythonhosted.org/packages/85/c4/bf8d6d54b0b7c66c2a7727bd7f538ac1fd0eddd0dbe6847650a0e76e0b74/slurmgen-3.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5c9338751f3cdaf475ee265d2851ce0fe02ddc71f94c1c5cbda9e6e4979e3a58",
                "md5": "cca5dbbffca1f38c2e0b7189c99a7170",
                "sha256": "912e6670555a4fbf1be536556a00750af50d1e46f79455fbb65d3de5ebcd78f9"
            },
            "downloads": -1,
            "filename": "slurmgen-3.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "cca5dbbffca1f38c2e0b7189c99a7170",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 10572,
            "upload_time": "2024-05-03T06:49:21",
            "upload_time_iso_8601": "2024-05-03T06:49:21.775465Z",
            "url": "https://files.pythonhosted.org/packages/5c/93/38751f3cdaf475ee265d2851ce0fe02ddc71f94c1c5cbda9e6e4979e3a58/slurmgen-3.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-03 06:49:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "otvam",
    "github_project": "slurmgen",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "slurmgen"
}
None
Elapsed time: 0.32432s