| Name | slurmgen JSON |
| Version |
3.14.0
JSON |
| download |
| home_page | None |
| Summary | SlurmGen - Simple Manager for Slurm Jobs |
| upload_time | 2024-12-19 21:36:23 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | BSD-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 Manager for Slurm Jobs
> * **Repository: [github.com/otvam/slurmgen](https://github.com/otvam/slurmgen)**
> * **PyPi: [pypi.org/project/slurmgen](https://pypi.org/project/slurmgen)**
> * **Conda: [anaconda.org/conda-forge/slurmgen](https://anaconda.org/conda-forge/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 Slurm job
* `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
* Conda: https://anaconda.org/conda-forge/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.9",
"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/f6/9d/a9e6df71137245c6c03d2167f52fe6b64a9ee0689e56c962b30e3c5a454c/slurmgen-3.14.0.tar.gz",
"platform": null,
"description": "# SlurmGen - Simple Manager for Slurm Jobs\n\n> * **Repository: [github.com/otvam/slurmgen](https://github.com/otvam/slurmgen)**\n> * **PyPi: [pypi.org/project/slurmgen](https://pypi.org/project/slurmgen)**\n> * **Conda: [anaconda.org/conda-forge/slurmgen](https://anaconda.org/conda-forge/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 Slurm job\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* Conda: https://anaconda.org/conda-forge/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 Manager for Slurm Jobs",
"version": "3.14.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": "5fec6c1a3bce3b97b2ce0c1e3a2dfdc48f046229917192572d078cceaf62f0a6",
"md5": "a5f7df47bac3cd242ab073aa4eabab4c",
"sha256": "be1f37d651213f5f24c2889fa10cfa58e406679303afd688a25131fc90a5032f"
},
"downloads": -1,
"filename": "slurmgen-3.14.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a5f7df47bac3cd242ab073aa4eabab4c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9041,
"upload_time": "2024-12-19T21:36:21",
"upload_time_iso_8601": "2024-12-19T21:36:21.251362Z",
"url": "https://files.pythonhosted.org/packages/5f/ec/6c1a3bce3b97b2ce0c1e3a2dfdc48f046229917192572d078cceaf62f0a6/slurmgen-3.14.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f69da9e6df71137245c6c03d2167f52fe6b64a9ee0689e56c962b30e3c5a454c",
"md5": "562edd1da106e8c77eaee5051aac2e3c",
"sha256": "8d763783b181ac06fef4618d299bc996a2e367ebca2ea9b75ada424d7f267966"
},
"downloads": -1,
"filename": "slurmgen-3.14.0.tar.gz",
"has_sig": false,
"md5_digest": "562edd1da106e8c77eaee5051aac2e3c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 11516,
"upload_time": "2024-12-19T21:36:23",
"upload_time_iso_8601": "2024-12-19T21:36:23.452608Z",
"url": "https://files.pythonhosted.org/packages/f6/9d/a9e6df71137245c6c03d2167f52fe6b64a9ee0689e56c962b30e3c5a454c/slurmgen-3.14.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 21:36:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "otvam",
"github_project": "slurmgen",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "slurmgen"
}
