├── .github └── workflows │ ├── python-format-ruff.yml │ ├── python-publish-pypi.yml │ └── python-run-tests.yml ├── .gitignore ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── conda └── meta.yaml ├── setup.py ├── simple_slurm ├── __about__.py ├── __init__.py ├── arguments.txt ├── arguments_help.txt ├── cli.py ├── core.py ├── filename_patterns.txt ├── output_env_vars.txt ├── scancel.py └── squeue.py └── test ├── __init__.py ├── test_cli.py └── test_core.py /.github/workflows/python-format-ruff.yml: -------------------------------------------------------------------------------- 1 | name: Format with Ruff 2 | on: 3 | push: 4 | branches: 5 | - master 6 | pull_request: 7 | branches: 8 | - master 9 | 10 | jobs: 11 | ruff: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - name: Checkout repository 15 | uses: actions/checkout@v4 16 | with: 17 | ref: ${{ github.head_ref || github.ref_name }} # Ensures the correct branch is checked out 18 | - name: Set up Python 19 | uses: actions/setup-python@v5 20 | with: 21 | python-version: "3.10" 22 | - name: Install Ruff 23 | run: pip install ruff 24 | - name: Run Ruff 25 | uses: astral-sh/ruff-action@v3 26 | with: 27 | args: "format" 28 | - name: Commit fixes (if any) 29 | if: success() 30 | run: | 31 | git config --global user.name "github-actions[bot]" 32 | git config --global user.email "github-actions[bot]@users.noreply.github.com" 33 | git add . 34 | git commit -m "Apply ruff fixes" || echo "No fixes to commit" 35 | git push origin HEAD:${{ github.head_ref || github.ref_name }} 36 | -------------------------------------------------------------------------------- /.github/workflows/python-publish-pypi.yml: -------------------------------------------------------------------------------- 1 | name: Publish to PyPI 2 | 3 | on: 4 | release: 5 | types: [published] 6 | 7 | jobs: 8 | publish: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/checkout@v4 12 | - name: Set up Python 13 | uses: actions/setup-python@v4 14 | with: 15 | python-version: '3.x' 16 | - name: Install dependencies 17 | run: | 18 | python -m pip install --upgrade pip 19 | pip install build 20 | - name: Build package 21 | run: python -m build 22 | - name: Publish package 23 | uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29 24 | with: 25 | user: __token__ 26 | password: ${{ secrets.PYPI_API_TOKEN }} 27 | -------------------------------------------------------------------------------- /.github/workflows/python-run-tests.yml: -------------------------------------------------------------------------------- 1 | name: Run Python Tests 2 | on: 3 | push: 4 | branches: 5 | - master 6 | pull_request: 7 | branches: 8 | - master 9 | 10 | jobs: 11 | build: 12 | runs-on: ubuntu-latest 13 | services: 14 | mysql: 15 | image: mysql:8.0 16 | env: 17 | MYSQL_ROOT_PASSWORD: root 18 | ports: 19 | - "8888:3306" 20 | options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3 21 | 22 | steps: 23 | - name: Checkout repository 24 | uses: actions/checkout@v4 25 | 26 | - name: Set up SLURM 27 | uses: koesterlab/setup-slurm-action@v1 28 | 29 | - name: Set up Python 30 | uses: actions/setup-python@v4 31 | with: 32 | python-version: '3.x' 33 | 34 | - name: Install dependencies 35 | run: | 36 | python -m pip install --upgrade pip 37 | pip install build 38 | 39 | - name: Copy files to SLURM node 40 | run: | 41 | mkdir -p $HOME/slurm_workspace 42 | rsync -av --progress . $HOME/slurm_workspace/ 43 | ls -lah $HOME/slurm_workspace # Debugging step 44 | 45 | - name: Run tests with unittest 46 | run: | 47 | cd $HOME/slurm_workspace 48 | python -m unittest -v 49 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Local Settings for Visual Studio Code 2 | .vscode/* 3 | # !.vscode/settings.json 4 | # !.vscode/tasks.json 5 | # !.vscode/launch.json 6 | # !.vscode/extensions.json 7 | *.code-workspace 8 | 9 | # Local History for Visual Studio Code 10 | .history/ 11 | 12 | # Byte-compiled / optimized / DLL files 13 | __pycache__/ 14 | *.py[cod] 15 | *$py.class 16 | 17 | # C extensions 18 | *.so 19 | 20 | # Distribution / packaging 21 | .Python 22 | build/ 23 | develop-eggs/ 24 | dist/ 25 | downloads/ 26 | eggs/ 27 | .eggs/ 28 | lib/ 29 | lib64/ 30 | parts/ 31 | sdist/ 32 | var/ 33 | wheels/ 34 | pip-wheel-metadata/ 35 | share/python-wheels/ 36 | *.egg-info/ 37 | .installed.cfg 38 | *.egg 39 | MANIFEST 40 | 41 | # PyInstaller 42 | # Usually these files are written by a python script from a template 43 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 44 | *.manifest 45 | *.spec 46 | 47 | # Installer logs 48 | pip-log.txt 49 | pip-delete-this-directory.txt 50 | 51 | # Unit test / coverage reports 52 | htmlcov/ 53 | .tox/ 54 | .nox/ 55 | .coverage 56 | .coverage.* 57 | .cache 58 | nosetests.xml 59 | coverage.xml 60 | *.cover 61 | *.py,cover 62 | .hypothesis/ 63 | .pytest_cache/ 64 | 65 | # Translations 66 | *.mo 67 | *.pot 68 | 69 | # Django stuff: 70 | *.log 71 | local_settings.py 72 | db.sqlite3 73 | db.sqlite3-journal 74 | 75 | # Flask stuff: 76 | instance/ 77 | .webassets-cache 78 | 79 | # Scrapy stuff: 80 | .scrapy 81 | 82 | # Sphinx documentation 83 | docs/_build/ 84 | 85 | # PyBuilder 86 | target/ 87 | 88 | # Jupyter Notebook 89 | .ipynb_checkpoints 90 | 91 | # IPython 92 | profile_default/ 93 | ipython_config.py 94 | 95 | # pyenv 96 | .python-version 97 | 98 | # pipenv 99 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 100 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 101 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 102 | # install all needed dependencies. 103 | #Pipfile.lock 104 | 105 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 106 | __pypackages__/ 107 | 108 | # Celery stuff 109 | celerybeat-schedule 110 | celerybeat.pid 111 | 112 | # SageMath parsed files 113 | *.sage.py 114 | 115 | # Environments 116 | .env 117 | .venv 118 | env/ 119 | venv/ 120 | ENV/ 121 | env.bak/ 122 | venv.bak/ 123 | 124 | # Spyder project settings 125 | .spyderproject 126 | .spyproject 127 | 128 | # Rope project settings 129 | .ropeproject 130 | 131 | # mkdocs documentation 132 | /site 133 | 134 | # mypy 135 | .mypy_cache/ 136 | .dmypy.json 137 | dmypy.json 138 | 139 | # Pyre type checker 140 | .pyre/ 141 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to Simple Slurm 2 | 3 | We welcome contributions! Before submitting changes, please follow these guidelines: 4 | 5 | ## Reporting Issues 6 | - Check existing issues to avoid duplicates. 7 | - Include a **minimal reproducible example** for bugs. 8 | - If possible specify your Slurm cluster setup (*e.g.*, Slurm version, Linux distro). 9 | 10 | ## Submitting Pull Requests 11 | 1. **Fork the repository** and create a feature branch. 12 | ```bash 13 | git checkout -b my-feature 14 | ``` 15 | 3. Ensure code passes: 16 | ```bash 17 | ruff check . # Linting 18 | ruff format . # Formatting 19 | python -m unittest -v # Run unit tests 20 | ``` 21 | 4. Test/validate changes (see [Testing](#testing)). 22 | 5. Update documentation if needed. 23 | 6. Open a Pull Request with a clear description of changes and test results. 24 | 25 | ## Code Style 26 | - Format code with [`ruff`](https://docs.astral.sh/ruff/). 27 | - Add type hints for new functions/methods. 28 | - Keep docstrings consistent with existing code. 29 | 30 | ## Testing 31 | - Add unit tests to validate any change in functionality. 32 | - Testing on a real Slurm cluster is **highly desired**. 33 | - A simple Slurm cluster is setup as an automatic action for any Pull Request. 34 | 35 | ## Questions? 36 | - Open a GitHub issue. 37 | - Tag [`@amq92`](https://github.com/amq92) in the discussion. 38 | 39 | Thank you for helping improve Simple Slurm! 🚀 40 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

Simple Slurm

2 |

A simple Python wrapper for Slurm with flexibility in mind

3 |

4 | Run Tests 5 | PyPI Downloads 6 | PyPI Version 7 | Conda Version 8 |

9 | 10 | 11 | ```python 12 | import datetime 13 | 14 | from simple_slurm import Slurm 15 | 16 | slurm = Slurm( 17 | array=range(3, 12), 18 | cpus_per_task=15, 19 | dependency=dict(after=65541, afterok=34987), 20 | gres=["gpu:kepler:2", "gpu:tesla:2", "mps:400"], 21 | ignore_pbs=True, 22 | job_name="name", 23 | output=f"{Slurm.JOB_ARRAY_MASTER_ID}_{Slurm.JOB_ARRAY_ID}.out", 24 | time=datetime.timedelta(days=1, hours=2, minutes=3, seconds=4), 25 | ) 26 | slurm.add_cmd("module load python") 27 | slurm.sbatch("python demo.py", Slurm.SLURM_ARRAY_TASK_ID) 28 | ``` 29 | The above snippet is equivalent to running the following command: 30 | 31 | ```bash 32 | sbatch << EOF 33 | #!/bin/sh 34 | 35 | #SBATCH --array 3-11 36 | #SBATCH --cpus-per-task 15 37 | #SBATCH --dependency after:65541,afterok:34987 38 | #SBATCH --gres gpu:kepler:2,gpu:tesla:2,mps:400 39 | #SBATCH --ignore-pbs 40 | #SBATCH --job-name name 41 | #SBATCH --output %A_%a.out 42 | #SBATCH --time 1-02:03:04 43 | 44 | module load python 45 | python demo.py \$SLURM_ARRAY_TASK_ID 46 | 47 | EOF 48 | ``` 49 | 50 | ## Contents 51 | 52 | + [Installation](#installation) 53 | + [Introduction](#introduction) 54 | + [Core Features](#core-features) 55 | - [Pythonic Slurm Syntax](#pythonic-slurm-syntax) *(was "Many syntaxes available")* 56 | - [Adding Commands with `add_cmd`](#adding-commands-with-add_cmd) 57 | - [Job Dependencies](#job-dependencies) 58 | + [Advanced Features](#advanced-features) 59 | - [Command-Line Interface (CLI)](#command-line-interface-cli) 60 | - [Using Configuration Files](#using-configuration-files) 61 | - [Filename Patterns and Environment Variables](#filename-patterns-and-environment-variables) 62 | - [Change execution shell](#change-execution-shell) 63 | + [Job Management](#job-management) 64 | - [Monitoring Jobs with `squeue`](#monitoring-jobs-with-squeue) 65 | - [Canceling Jobs with `scancel`](#canceling-jobs-with-scancel) 66 | + [Error Handling](#error-handling) 67 | + [Project Growth](#project-growth) 68 | 69 | 70 | ## Installation 71 | 72 | The source code is currently hosted : [https://github.com/amq92/simple_slurm](https://github.com/amq92/simple_slurm) 73 | 74 | Install the latest `simple_slurm` version with: 75 | 76 | ```bash 77 | pip install simple_slurm 78 | ``` 79 | or using `conda` 80 | ```bash 81 | conda install -c conda-forge simple_slurm 82 | ``` 83 | 84 | ## Introduction 85 | 86 | The [`sbatch`](https://slurm.schedmd.com/sbatch.html) and [`srun`](https://slurm.schedmd.com/srun.html) commands in [Slurm](https://slurm.schedmd.com/overview.html) allow submitting parallel jobs into a Linux cluster in the form of batch scripts that follow a certain structure. 87 | 88 | The goal of this library is to provide a simple wrapper for these core functions so that Python code can be used for constructing and launching the aforementioned batch script. 89 | 90 | Indeed, the generated batch script can be shown by printing the `Slurm` object: 91 | 92 | ```python 93 | from simple_slurm import Slurm 94 | 95 | slurm = Slurm(array=range(3, 12), job_name="name") 96 | print(slurm) 97 | ``` 98 | ```bash 99 | >> #!/bin/sh 100 | >> 101 | >> #SBATCH --array 3-11 102 | >> #SBATCH --job-name name 103 | ``` 104 | 105 | Then, the job can be launched with either command: 106 | ```python 107 | slurm.srun("echo hello!") 108 | slurm.sbatch("echo hello!") 109 | ``` 110 | ```bash 111 | >> Submitted batch job 34987 112 | ``` 113 | 114 | While both commands are quite similar, [`srun`](https://slurm.schedmd.com/srun.html) will wait for the job completion, while [`sbatch`](https://slurm.schedmd.com/sbatch.html) will launch and disconnect from the jobs. 115 | > More information can be found in [Slurm's Quick Start Guide](https://slurm.schedmd.com/quickstart.html) and in [here](https://stackoverflow.com/questions/43767866/slurm-srun-vs-sbatch-and-their-parameters). 116 | 117 | 118 | 119 | ## Core Features 120 | 121 | ### Pythonic Slurm Syntax 122 | 123 | ```python 124 | slurm = Slurm("-a", "3-11") 125 | slurm = Slurm("--array", "3-11") 126 | slurm = Slurm("array", "3-11") 127 | slurm = Slurm(array="3-11") 128 | slurm = Slurm(array=range(3, 12)) 129 | slurm.add_arguments(array=range(3, 12)) 130 | slurm.set_array(range(3, 12)) 131 | ``` 132 | 133 | All these arguments are equivalent! 134 | It's up to you to choose the one(s) that best suits you needs. 135 | 136 | > *"With great flexibility comes great responsability"* 137 | 138 | You can either keep a command-line-like syntax or a more Python-like one. 139 | 140 | ```python 141 | slurm = Slurm() 142 | slurm.set_dependency("after:65541,afterok:34987") 143 | slurm.set_dependency(["after:65541", "afterok:34987"]) 144 | slurm.set_dependency(dict(after=65541, afterok=34987)) 145 | ``` 146 | 147 | All the possible arguments have their own setter methods 148 | (ex. `set_array`, `set_dependency`, `set_job_name`). 149 | 150 | Please note that hyphenated arguments, such as `--job-name`, need to be underscored 151 | (so to comply with Python syntax and be coherent). 152 | 153 | ```python 154 | slurm = Slurm("--job_name", "name") 155 | slurm = Slurm(job_name="name") 156 | 157 | # slurm = Slurm("--job-name", "name") # NOT VALID 158 | # slurm = Slurm(job-name="name") # NOT VALID 159 | ``` 160 | 161 | Moreover, boolean arguments such as `--contiguous`, `--ignore_pbs` or `--overcommit` 162 | can be activated with `True` or an empty string. 163 | 164 | ```python 165 | slurm = Slurm("--contiguous", True) 166 | slurm.add_arguments(ignore_pbs="") 167 | slurm.set_wait(False) 168 | print(slurm) 169 | ``` 170 | ```bash 171 | #!/bin/sh 172 | 173 | #SBATCH --contiguous 174 | #SBATCH --ignore-pbs 175 | ``` 176 | 177 | 178 | ### Adding Commands with `add_cmd` 179 | 180 | The `add_cmd` method allows you to add multiple commands to the Slurm job script. These commands will be executed in the order they are added before the main command specified in `sbatch` or `srun` directive. 181 | 182 | ```python 183 | from simple_slurm import Slurm 184 | 185 | slurm = Slurm(job_name="my_job", output="output.log") 186 | 187 | # Add multiple commands 188 | slurm.add_cmd("module load python") 189 | slurm.add_cmd("export PYTHONPATH=/path/to/my/module") 190 | slurm.add_cmd('echo "Environment setup complete"') 191 | 192 | # Submit the job with the main command 193 | slurm.sbatch("python my_script.py") 194 | ``` 195 | 196 | This will generate a Slurm job script like: 197 | 198 | ```bash 199 | #!/bin/sh 200 | 201 | #SBATCH --job-name my_job 202 | #SBATCH --output output.log 203 | 204 | module load python 205 | export PYTHONPATH=/path/to/my/module 206 | echo "Environment setup complete" 207 | python my_script.py 208 | ``` 209 | 210 | You can reset the list of commands using the `reset_cmd` method: 211 | 212 | ```python 213 | slurm.reset_cmd() # Clears all previously added commands 214 | ``` 215 | 216 | 217 | ### Job dependencies 218 | 219 | The `sbatch` call prints a message if successful and returns the corresponding `job_id` 220 | 221 | ```python 222 | job_id = slurm.sbatch("python demo.py " + Slurm.SLURM_ARRAY_TAKSK_ID) 223 | ``` 224 | 225 | If the job submission was successful, it prints: 226 | 227 | ``` 228 | Submitted batch job 34987 229 | ``` 230 | 231 | And returns the variable `job_id = 34987`, which can be used for setting dependencies on subsequent jobs 232 | 233 | ```python 234 | slurm_after = Slurm(dependency=dict(afterok=job_id))) 235 | ``` 236 | 237 | 238 | ## Advanced Features 239 | 240 | ### Command-Line Interface (CLI) 241 | 242 | For simpler dispatch jobs, a command line entry point is also made available. 243 | 244 | ```bash 245 | simple_slurm [OPTIONS] "COMMAND_TO_RUN_WITH_SBATCH" 246 | ``` 247 | 248 | As such, both of these `python` and `bash` calls are equivalent. 249 | 250 | ```python 251 | slurm = Slurm(partition="compute.p", output="slurm.log", ignore_pbs=True) 252 | slurm.sbatch("echo \$HOSTNAME") 253 | ``` 254 | ```bash 255 | simple_slurm --partition=compute.p --output slurm.log --ignore_pbs "echo \$HOSTNAME" 256 | ``` 257 | 258 | 259 | ### Using Configuration Files 260 | 261 | Let's define the *static* components of a job definition in a YAML file `slurm_default.yml` 262 | 263 | ```yaml 264 | cpus_per_task: 15 265 | job_name: "name" 266 | output: "%A_%a.out" 267 | ``` 268 | 269 | Including these options with the using the `yaml` package is very *simple* 270 | 271 | ```python 272 | import yaml 273 | 274 | from simple_slurm import Slurm 275 | 276 | slurm = Slurm(**yaml.load(open("slurm_default.yml", "r"))) 277 | 278 | ... 279 | 280 | slurm.set_array(range(NUMBER_OF_SIMULATIONS)) 281 | ``` 282 | 283 | The job can be updated according to the *dynamic* project needs (ex. `NUMBER_OF_SIMULATIONS`). 284 | 285 | 286 | 287 | 288 | ### Filename Patterns and Environment Variables 289 | 290 | For convenience, Filename Patterns and Output Environment Variables are available as attributes of the Simple Slurm object. 291 | 292 | See [https://slurm.schedmd.com/sbatch.html](https://slurm.schedmd.com/sbatch.html#lbAH) for details on the commands. 293 | 294 | ```python 295 | from slurm import Slurm 296 | 297 | slurm = Slurm(output=('{}_{}.out'.format( 298 | Slurm.JOB_ARRAY_MASTER_ID, 299 | Slurm.JOB_ARRAY_ID)) 300 | slurm.sbatch('python demo.py ' + slurm.SLURM_ARRAY_JOB_ID) 301 | ``` 302 | 303 | This example would result in output files of the form `65541_15.out`. 304 | Here the job submission ID is `65541`, and this output file corresponds to the submission number `15` in the job array. Moreover, this index is passed to the Python code `demo.py` as an argument. 305 | 306 | 307 | `sbatch` allows for a filename pattern to contain one or more replacement symbols. They can be accessed with `Slurm.` 308 | 309 | name | value | description 310 | :-------------------|------:|:----------- 311 | JOB_ARRAY_MASTER_ID | %A | job array's master job allocation number 312 | JOB_ARRAY_ID | %a | job array id (index) number 313 | JOB_ID_STEP_ID | %J | jobid.stepid of the running job. (e.g. "128.0") 314 | JOB_ID | %j | jobid of the running job 315 | HOSTNAME | %N | short hostname. this will create a separate io file per node 316 | NODE_IDENTIFIER | %n | node identifier relative to current job (e.g. "0" is the first node of the running job) this will create a separate io file per node 317 | STEP_ID | %s | stepid of the running job 318 | TASK_IDENTIFIER | %t | task identifier (rank) relative to current job. this will create a separate io file per task 319 | USER_NAME | %u | user name 320 | JOB_NAME | %x | job name 321 | PERCENTAGE | %% | the character "%" 322 | DO_NOT_PROCESS | \\\\ | do not process any of the replacement symbols 323 | 324 | 325 | 326 | The Slurm controller will set the following variables in the environment of the batch script. They can be accessed with `Slurm.`. 327 | 328 | name | description 329 | :----------------------|:----------- 330 | SLURM_ARRAY_TASK_COUNT | total number of tasks in a job array 331 | SLURM_ARRAY_TASK_ID | job array id (index) number 332 | SLURM_ARRAY_TASK_MAX | job array's maximum id (index) number 333 | SLURM_ARRAY_TASK_MIN | job array's minimum id (index) number 334 | SLURM_ARRAY_TASK_STEP | job array's index step size 335 | SLURM_ARRAY_JOB_ID | job array's master job id number 336 | ... | ... 337 | 338 | 339 | ### Change execution shell 340 | 341 | `/bin/sh` is the default shell path used in the script's first line. 342 | It can be modified with : 343 | ```python 344 | slurm.set_shell("/bin/sh") 345 | slurm.sbatch("/bin/sh") 346 | ``` 347 | In both cases, the default shell is modified in the Slurm object (*i.e.* applicable to successive `sbatch` calls). 348 | 349 | ## Job Management 350 | 351 | Simple Slurm provides a simple interface to Slurm's job management tools (`squeue` and `scance`l) to let you monitor and control running jobs. 352 | 353 | ### Monitoring Jobs with `squeue` 354 | 355 | Retrieve and display job information for the current user: 356 | 357 | ```python 358 | from simple_slurm import Slurm 359 | 360 | slurm = Slurm() 361 | slurm.squeue.update_squeue() # Fetch latest job data 362 | slurm.squeue.display_jobs() 363 | 364 | # Get the jobs as a dictionary 365 | jobs = slurm.squeue.jobs 366 | 367 | for job_id, job in jobs.items(): 368 | print(job) 369 | ``` 370 | 371 | 372 | ### Canceling Jobs with `scancel` 373 | 374 | Cancel single jobs or entire job arrays: 375 | 376 | ```python 377 | from simple_slurm import Slurm 378 | 379 | slurm = Slurm() 380 | 381 | # Cancel a specific job 382 | slurm.scancel.cancel_job(34987) 383 | 384 | # Cancel multiple jobs 385 | for job_id in [34987, 34988, 34989]: 386 | slurm.scancel.cancel_job(job_id) 387 | 388 | # Send SIGTERM before canceling (graceful termination) 389 | slurm.scancel.signal_job(34987) 390 | slurm.scancel.cancel_job(34987) 391 | ``` 392 | 393 | 394 | ## Error Handling 395 | The library does not raise specific exceptions for invalid Slurm arguments or job submission failures. Instead, it relies on the underlying Slurm commands (`sbatch`, `srun`, etc.) to handle errors. If a job submission fails, the error message from Slurm will be printed to the console. 396 | 397 | Additionally, if invalid arguments are passed to the Slurm object, the library uses `argparse` to validate them. If an argument is invalid, `argparse` will raise an error and print a helpful message. 398 | 399 | For example: 400 | 401 | ```bash 402 | simple_slurm --invalid_argument=value "echo \$HOSTNAME" 403 | ``` 404 | 405 | This will result in an error like: 406 | 407 | ```bash 408 | usage: simple_slurm [OPTIONS] "COMMAND_TO_RUN_WITH_SBATCH" 409 | simple_slurm: error: unrecognized arguments: --invalid_argument=value 410 | ``` 411 | 412 | 413 | ## Project growth 414 | [![Star History Chart](https://api.star-history.com/svg?repos=amq92/simple_slurm&type=Date)](https://star-history.com/#amq92/simple_slurm&Date) 415 | -------------------------------------------------------------------------------- /conda/meta.yaml: -------------------------------------------------------------------------------- 1 | {% set data = load_setup_py_data() %} 2 | package: 3 | name: simple_slurm 4 | version: {{ data['version'] }} 5 | source: 6 | path: .. 7 | build: 8 | number: 0 9 | script: python setup.py install --single-version-externally-managed --record=record.txt 10 | requirements: 11 | run: 12 | - python 13 | test: 14 | imports: 15 | - simple_slurm 16 | about: 17 | home: {{ data['url'] }} 18 | license: {{ data['license'] }} 19 | summary: {{ data['description'] }} 20 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import find_packages, setup 2 | 3 | with open("README.md", "r") as fid: 4 | long_description = fid.read() 5 | 6 | with open("simple_slurm/__about__.py", "r") as fid: 7 | __version__ = None 8 | exec(fid.read()) # loads __version__ 9 | 10 | setup( 11 | name="simple_slurm", 12 | version=__version__, 13 | author="Arturo Mendoza", 14 | description="A simple Python wrapper for Slurm with flexibility in mind.", 15 | long_description=long_description, 16 | long_description_content_type="text/markdown", 17 | url="https://github.com/amq92/simple_slurm", 18 | packages=find_packages(), 19 | package_data={"": ["*.txt"]}, 20 | include_package_data=True, 21 | classifiers=[ 22 | "Programming Language :: Python :: 3", 23 | "License :: OSI Approved :: GNU Affero General Public License v3", 24 | "Operating System :: OS Independent", 25 | "Development Status :: 5 - Production/Stable", 26 | ], 27 | python_requires=">=3.6", 28 | license="GNU Affero General Public License v3", 29 | entry_points=dict(console_scripts=["simple_slurm=simple_slurm.cli:cli"]), 30 | ) 31 | -------------------------------------------------------------------------------- /simple_slurm/__about__.py: -------------------------------------------------------------------------------- 1 | __version__ = "0.3.6" 2 | -------------------------------------------------------------------------------- /simple_slurm/__init__.py: -------------------------------------------------------------------------------- 1 | from .__about__ import __version__ 2 | 3 | from .core import Slurm 4 | 5 | # create a dummy Slurm object, this forces the creation of attributes for 6 | # file patterns and output environment variables 7 | _ = Slurm() 8 | 9 | __all__ = [ 10 | "__version__", 11 | ] 12 | -------------------------------------------------------------------------------- /simple_slurm/arguments.txt: -------------------------------------------------------------------------------- 1 | account,A 2 | acctg_freq 3 | array,a 4 | batch 5 | bb 6 | bbf 7 | begin,b 8 | chdir,D 9 | cluster_constraint 10 | clusters,M 11 | comment 12 | constraint,C 13 | container 14 | container_id 15 | contiguous 16 | core_spec,S 17 | cores_per_socket 18 | cpu_freq 19 | cpus_per_gpu 20 | cpus_per_task,c 21 | deadline 22 | delay_boot 23 | dependency,d 24 | distribution,m 25 | error,e 26 | exclude,x 27 | exclusive 28 | export 29 | export_file 30 | extra 31 | extra_node_info,B 32 | get_user_env 33 | gid 34 | gpu_bind 35 | gpu_freq 36 | gpus_per_node 37 | gpus_per_socket 38 | gpus_per_task 39 | gpus,G 40 | gres 41 | gres_flags 42 | hint 43 | hold,H 44 | ignore_pbs 45 | input,i 46 | job_name,J 47 | kill_on_invalid_dep 48 | licenses,L 49 | mail_type 50 | mail_user 51 | mcs_label 52 | mem 53 | mem_bind 54 | mem_per_cpu 55 | mem_per_gpu 56 | mincpus 57 | network 58 | nice 59 | no_kill,k 60 | no_requeue 61 | nodefile,F 62 | nodelist,w 63 | nodes,N 64 | ntasks_per_core 65 | ntasks_per_gpu 66 | ntasks_per_node 67 | ntasks_per_socket 68 | ntasks,n 69 | open_mode 70 | output,o 71 | overcommit,O 72 | oversubscribe,s 73 | parsable 74 | partition,p 75 | power 76 | prefer 77 | priority 78 | profile 79 | propagate 80 | qos,q 81 | quiet,Q 82 | reboot 83 | requeue 84 | reservation 85 | signal 86 | sockets_per_node 87 | spread_job 88 | switches 89 | test_only 90 | thread_spec 91 | threads_per_core 92 | time_min 93 | time,t 94 | tmp 95 | tres_per_task 96 | uid 97 | use_min_nodes 98 | verbose,v 99 | wait_all_nodes 100 | wait,W 101 | wckey 102 | wrap -------------------------------------------------------------------------------- /simple_slurm/arguments_help.txt: -------------------------------------------------------------------------------- 1 | 2 | [,...] 3 | 4 | 5 | 6 | 7 |