| Name | pysqa JSON |
| Version |
0.1.19
JSON |
| download |
| home_page | None |
| Summary | Simple HPC queuing system adapter for Python on based jinja templates to automate the submission script creation. |
| upload_time | 2024-04-21 14:17:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.9 |
| license | BSD 3-Clause License Copyright (c) 2019, Jan Janssen All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
pyiron
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pysqa - a simple queue adapter for python
[](https://github.com/pyiron/pysqa/actions)
[](https://pysqa.readthedocs.io/en/latest/?badge=latest)
[](https://coveralls.io/github/pyiron/pysqa?branch=main)
High-performance computing (HPC) does not have to be hard. In this context the aim of `pysqa` is to simplify the submission of calculation to an HPC cluster as easy as starting another subprocess locally. This is achieved based on the assumption that even though modern HPC queuing systems offer a wide range of different configuration options, most users submit the majority of their jobs with very similar parameters.
Therefore, in `pysqa` users define submission script templates once and reuse them to submit many different calculations or workflows. These templates are defined in the [jinja2 template language](https://palletsprojects.com/p/jinja/), so current submission scripts can be easily extended to templates. In addition to the submission of new jobs to the queuing system `pysqa` also allows the users to track the progress of their jobs, delete them or enable reservations using the built-in functionality of the queuing system.
All this functionality is available from both a [Python interface](https://pysqa.readthedocs.io/en/latest/python.html) as well as a [command line interface](https://pysqa.readthedocs.io/en/latest/command.html).
# Features
The core feature of `pysqa` is the communication to an HPC queuing system ([Flux](https://pysqa.readthedocs.io/en/latest/queue.html#flux), [LFS](https://pysqa.readthedocs.io/en/latest/queue.html#lfs), [MOAB](https://pysqa.readthedocs.io/en/latest/queue.html#moab), [SGE](https://pysqa.readthedocs.io/en/latest/queue.html#sge), [SLURM](https://pysqa.readthedocs.io/en/latest/queue.html#slurm) and [TORQUE](https://pysqa.readthedocs.io/en/latest/queue.html#torque)). This includes:
* Submission of new calculation to the queuing system.
* List of calculation currently waiting or running on the queuing system.
* Deleting calculation which are currently waiting or running on the queuing system.
* List of available queue templates created by the user.
* Restriction of templates to a specific number of cores, run time or other computing resources. With integrated checks if a given calculation follows these restrictions.
In addition to these core features, `pysqa` is continuously extended to support more use cases for a larger group of users. These new features include the support for remote queuing systems:
* Remote connection via the secure shell protocol to access remote HPC clusters.
* Transfer of file to and from remote HPC clusters, based on a predefined mapping of the remote file system into the local file system.
* Support for both individual connections as well as continuous connections depending on the network availability.
Finally, there is current work in progress to support a combination of [multiple local and remote queuing systems](https://pysqa.readthedocs.io/en/latest/advanced.html) from within `pysqa`, which are represented to the user as a single resource.
# Documentation
* [Installation](https://pysqa.readthedocs.io/en/latest/installation.html)
* [pypi-based installation](https://pysqa.readthedocs.io/en/latest/installation.html#pypi-based-installation)
* [conda-based installation](https://pysqa.readthedocs.io/en/latest/installation.html#conda-based-installation)
* [Queuing Systems](https://pysqa.readthedocs.io/en/latest/queue.html)
* [Flux](https://pysqa.readthedocs.io/en/latest/queue.html#flux)
* [LFS](https://pysqa.readthedocs.io/en/latest/queue.html#lfs)
* [MOAB](https://pysqa.readthedocs.io/en/latest/queue.html#moab)
* [SGE](https://pysqa.readthedocs.io/en/latest/queue.html#sge)
* [SLURM](https://pysqa.readthedocs.io/en/latest/queue.html#slurm)
* [TORQUE](https://pysqa.readthedocs.io/en/latest/queue.html#torque)
* [Python Interface](https://pysqa.readthedocs.io/en/latest/python.html)
* [List available queues](https://pysqa.readthedocs.io/en/latest/python.html#list-available-queues)
* [Submit job to queue](https://pysqa.readthedocs.io/en/latest/python.html#submit-job-to-queue)
* [Show jobs in queue](https://pysqa.readthedocs.io/en/latest/python.html#show-jobs-in-queue)
* [Delete job from queue](https://pysqa.readthedocs.io/en/latest/python.html#delete-job-from-queue)
* [Command Line Interface](https://pysqa.readthedocs.io/en/latest/command.html)
* [Submit job](https://pysqa.readthedocs.io/en/latest/command.html#submit-job)
* [Enable reservation](https://pysqa.readthedocs.io/en/latest/command.html#enable-reservation)
* [List jobs](https://pysqa.readthedocs.io/en/latest/command.html#list-jobs)
* [Delete job](https://pysqa.readthedocs.io/en/latest/command.html#delete-job)
* [List files](https://pysqa.readthedocs.io/en/latest/command.html#list-files)
* [Help](https://pysqa.readthedocs.io/en/latest/command.html#help)
* [Advanced Configuration](https://pysqa.readthedocs.io/en/latest/advanced.html)
* [Remote HPC Configuration](https://pysqa.readthedocs.io/en/latest/advanced.html#remote-hpc-configuration)
* [Access to Multiple HPCs](https://pysqa.readthedocs.io/en/latest/advanced.html#access-to-multiple-hpcs)
* [Debugging](https://pysqa.readthedocs.io/en/latest/debug.html)
* [Local Queuing System](https://pysqa.readthedocs.io/en/latest/debug.html#local-queuing-system)
* [Remote HPC](https://pysqa.readthedocs.io/en/latest/debug.html#remote-hpc)
# License
`pysqa` is released under the BSD license https://github.com/pyiron/pysqa/blob/main/LICENSE . It is a spin-off of the `pyiron` project https://github.com/pyiron/pyiron therefore if you use `pysqa` for calculation which result in a scientific publication, please cite:
@article{pyiron-paper,
title = {pyiron: An integrated development environment for computational materials science},
journal = {Computational Materials Science},
volume = {163},
pages = {24 - 36},
year = {2019},
issn = {0927-0256},
doi = {https://doi.org/10.1016/j.commatsci.2018.07.043},
url = {http://www.sciencedirect.com/science/article/pii/S0927025618304786},
author = {Jan Janssen and Sudarsan Surendralal and Yury Lysogorskiy and Mira Todorova and Tilmann Hickel and Ralf Drautz and Jörg Neugebauer},
keywords = {Modelling workflow, Integrated development environment, Complex simulation protocols},
}
Raw data
{
"_id": null,
"home_page": null,
"name": "pysqa",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "pyiron",
"author": null,
"author_email": "Jan Janssen <janssen@mpie.de>",
"download_url": "https://files.pythonhosted.org/packages/c8/0f/9a311a99c622fe9484d7c1fd162bc65441884645ffef691520fb11eba6d6/pysqa-0.1.19.tar.gz",
"platform": null,
"description": "# pysqa - a simple queue adapter for python\n\n[](https://github.com/pyiron/pysqa/actions)\n[](https://pysqa.readthedocs.io/en/latest/?badge=latest)\n[](https://coveralls.io/github/pyiron/pysqa?branch=main)\n\nHigh-performance computing (HPC) does not have to be hard. In this context the aim of `pysqa` is to simplify the submission of calculation to an HPC cluster as easy as starting another subprocess locally. This is achieved based on the assumption that even though modern HPC queuing systems offer a wide range of different configuration options, most users submit the majority of their jobs with very similar parameters. \n\nTherefore, in `pysqa` users define submission script templates once and reuse them to submit many different calculations or workflows. These templates are defined in the [jinja2 template language](https://palletsprojects.com/p/jinja/), so current submission scripts can be easily extended to templates. In addition to the submission of new jobs to the queuing system `pysqa` also allows the users to track the progress of their jobs, delete them or enable reservations using the built-in functionality of the queuing system.\n\nAll this functionality is available from both a [Python interface](https://pysqa.readthedocs.io/en/latest/python.html) as well as a [command line interface](https://pysqa.readthedocs.io/en/latest/command.html). \n\n# Features\nThe core feature of `pysqa` is the communication to an HPC queuing system ([Flux](https://pysqa.readthedocs.io/en/latest/queue.html#flux), [LFS](https://pysqa.readthedocs.io/en/latest/queue.html#lfs), [MOAB](https://pysqa.readthedocs.io/en/latest/queue.html#moab), [SGE](https://pysqa.readthedocs.io/en/latest/queue.html#sge), [SLURM](https://pysqa.readthedocs.io/en/latest/queue.html#slurm) and [TORQUE](https://pysqa.readthedocs.io/en/latest/queue.html#torque)). This includes: \n\n* Submission of new calculation to the queuing system. \n* List of calculation currently waiting or running on the queuing system. \n* Deleting calculation which are currently waiting or running on the queuing system. \n* List of available queue templates created by the user.\n* Restriction of templates to a specific number of cores, run time or other computing resources. With integrated checks if a given calculation follows these restrictions. \n\nIn addition to these core features, `pysqa` is continuously extended to support more use cases for a larger group of users. These new features include the support for remote queuing systems: \n\n* Remote connection via the secure shell protocol to access remote HPC clusters.\n* Transfer of file to and from remote HPC clusters, based on a predefined mapping of the remote file system into the local file system. \n* Support for both individual connections as well as continuous connections depending on the network availability. \n\nFinally, there is current work in progress to support a combination of [multiple local and remote queuing systems](https://pysqa.readthedocs.io/en/latest/advanced.html) from within `pysqa`, which are represented to the user as a single resource. \n\n# Documentation\n\n* [Installation](https://pysqa.readthedocs.io/en/latest/installation.html)\n * [pypi-based installation](https://pysqa.readthedocs.io/en/latest/installation.html#pypi-based-installation)\n * [conda-based installation](https://pysqa.readthedocs.io/en/latest/installation.html#conda-based-installation)\n* [Queuing Systems](https://pysqa.readthedocs.io/en/latest/queue.html)\n * [Flux](https://pysqa.readthedocs.io/en/latest/queue.html#flux)\n * [LFS](https://pysqa.readthedocs.io/en/latest/queue.html#lfs)\n * [MOAB](https://pysqa.readthedocs.io/en/latest/queue.html#moab)\n * [SGE](https://pysqa.readthedocs.io/en/latest/queue.html#sge)\n * [SLURM](https://pysqa.readthedocs.io/en/latest/queue.html#slurm)\n * [TORQUE](https://pysqa.readthedocs.io/en/latest/queue.html#torque)\n* [Python Interface](https://pysqa.readthedocs.io/en/latest/python.html)\n * [List available queues](https://pysqa.readthedocs.io/en/latest/python.html#list-available-queues)\n * [Submit job to queue](https://pysqa.readthedocs.io/en/latest/python.html#submit-job-to-queue)\n * [Show jobs in queue](https://pysqa.readthedocs.io/en/latest/python.html#show-jobs-in-queue)\n * [Delete job from queue](https://pysqa.readthedocs.io/en/latest/python.html#delete-job-from-queue)\n* [Command Line Interface](https://pysqa.readthedocs.io/en/latest/command.html)\n * [Submit job](https://pysqa.readthedocs.io/en/latest/command.html#submit-job)\n * [Enable reservation](https://pysqa.readthedocs.io/en/latest/command.html#enable-reservation)\n * [List jobs](https://pysqa.readthedocs.io/en/latest/command.html#list-jobs)\n * [Delete job](https://pysqa.readthedocs.io/en/latest/command.html#delete-job)\n * [List files](https://pysqa.readthedocs.io/en/latest/command.html#list-files)\n * [Help](https://pysqa.readthedocs.io/en/latest/command.html#help)\n* [Advanced Configuration](https://pysqa.readthedocs.io/en/latest/advanced.html)\n * [Remote HPC Configuration](https://pysqa.readthedocs.io/en/latest/advanced.html#remote-hpc-configuration)\n * [Access to Multiple HPCs](https://pysqa.readthedocs.io/en/latest/advanced.html#access-to-multiple-hpcs)\n* [Debugging](https://pysqa.readthedocs.io/en/latest/debug.html)\n * [Local Queuing System](https://pysqa.readthedocs.io/en/latest/debug.html#local-queuing-system)\n * [Remote HPC](https://pysqa.readthedocs.io/en/latest/debug.html#remote-hpc)\n\n# License\n`pysqa` is released under the BSD license https://github.com/pyiron/pysqa/blob/main/LICENSE . It is a spin-off of the `pyiron` project https://github.com/pyiron/pyiron therefore if you use `pysqa` for calculation which result in a scientific publication, please cite: \n\n @article{pyiron-paper,\n title = {pyiron: An integrated development environment for computational materials science},\n journal = {Computational Materials Science},\n volume = {163},\n pages = {24 - 36},\n year = {2019},\n issn = {0927-0256},\n doi = {https://doi.org/10.1016/j.commatsci.2018.07.043},\n url = {http://www.sciencedirect.com/science/article/pii/S0927025618304786},\n author = {Jan Janssen and Sudarsan Surendralal and Yury Lysogorskiy and Mira Todorova and Tilmann Hickel and Ralf Drautz and J\u00f6rg Neugebauer},\n keywords = {Modelling workflow, Integrated development environment, Complex simulation protocols},\n }\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2019, Jan Janssen All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Simple HPC queuing system adapter for Python on based jinja templates to automate the submission script creation.",
"version": "0.1.19",
"project_urls": {
"Documentation": "https://pysqa.readthedocs.io",
"Homepage": "https://github.com/pyiron/pysqa",
"Repository": "https://github.com/pyiron/pysqa"
},
"split_keywords": [
"pyiron"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c516d7602493c053a3c747bf8cf0d81532fcb8b5091a9d7c23345bd4567c7bd4",
"md5": "ff522d206b5442e3c7f9986c4fd016a8",
"sha256": "61c33f5ce494483ad12932ed327360d912aa73a12554c14e70c074aefb12867d"
},
"downloads": -1,
"filename": "pysqa-0.1.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ff522d206b5442e3c7f9986c4fd016a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 38536,
"upload_time": "2024-04-21T14:17:25",
"upload_time_iso_8601": "2024-04-21T14:17:25.923485Z",
"url": "https://files.pythonhosted.org/packages/c5/16/d7602493c053a3c747bf8cf0d81532fcb8b5091a9d7c23345bd4567c7bd4/pysqa-0.1.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c80f9a311a99c622fe9484d7c1fd162bc65441884645ffef691520fb11eba6d6",
"md5": "6add04f70f684ae94fd16b4c6441e9e6",
"sha256": "3fda188ac46e5bab727522963c75c690f881766d4dc9602a662a27e224c6e060"
},
"downloads": -1,
"filename": "pysqa-0.1.19.tar.gz",
"has_sig": false,
"md5_digest": "6add04f70f684ae94fd16b4c6441e9e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 32530,
"upload_time": "2024-04-21T14:17:27",
"upload_time_iso_8601": "2024-04-21T14:17:27.994402Z",
"url": "https://files.pythonhosted.org/packages/c8/0f/9a311a99c622fe9484d7c1fd162bc65441884645ffef691520fb11eba6d6/pysqa-0.1.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-21 14:17:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyiron",
"github_project": "pysqa",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pysqa"
}
