Skip to main content
https://gitlab.com/myqueue/myqueue/badges/master/coverage.svg https://badge.fury.io/py/myqueue.svg https://joss.theoj.org/papers/10.21105/joss.01844/status.svg Documentation Status

MyQueue

MyQueue is a tool for submitting and keeping track of tasks running on a cluster of computers. It uses SLURM, PBS or LSF as a backend and makes handling of tasks easy. It has a command-line interface called mq with a number of sub-commands and a Python interface for managing workflows. Simple to set up: no system administrator or database required.

Quick links:

Examples

Submit Python script to 32 cores for 2 hours:

$ mq submit script.py -R 32:2h

Submit Python module abc.run in two folders:

$ mq submit abc.run F1/ F2/ -R 16:30m

Check results of tasks in current folder and its sub-folders:

$ mq list  # or mq ls
id  folder name      res.   age     state   time    error
--- ------ --------- ------ ------- ------- ------- ------
117 ./     script.py 32:2h  5:28:43 TIMEOUT 2:00:03
118 ./F1/  abc.run   16:30m 5:22:16 done      12:12
119 ./F2/  abc.run   16:30m 5:22:16 done      17:50
--- ------ --------- ------ ------- ------- ------- ------
done: 2, TIMEOUT: 1, total: 3

Resubmit with more resources (1 day):

$ mq resubmit -i 117 -R 32:1d

See more examples of use here:

Installation

MyQueue needs Python version 3.8 or later.

Install MyQueue from PyPI with pip:

$ python3 -m pip install myqueue

This will also install the rich and networkx packages that MyQueue depends on.

Enable bash tab-completion for future terminal sessions like this:

$ mq completion >> ~/.profile

Now, configure your system as described here.

Release notes

See the release notes for a history of notable changes to MyQueue.

Help, support and feedback

If you need help, want to report a bug or suggest a new feature then you are welcome to get in touch via MyQueue’s issue tracker or the #myqueue room on Matrix.

Contributing

We welcome contributions to the code and documentation, preferably as merge-requests. More information here.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

myqueue-24.5.0.tar.gz (132.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

myqueue-24.5.0-py3-none-any.whl (106.9 kB view details)

Uploaded Python 3

File details

Details for the file myqueue-24.5.0.tar.gz.

File metadata

  • Download URL: myqueue-24.5.0.tar.gz
  • Upload date:
  • Size: 132.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.6

File hashes

Hashes for myqueue-24.5.0.tar.gz
Algorithm Hash digest
SHA256 7ece5e50a401d6c5902e55c5de6deca41d3e6bbdf80706dfc2ff9c60529187c8
MD5 5b3ed6d37d09c9fa5eba2a659537c6b4
BLAKE2b-256 503c57fb384036b8d61cd51824311a8aed3b2783648d239283d319c720aa643b

See more details on using hashes here.

File details

Details for the file myqueue-24.5.0-py3-none-any.whl.

File metadata

  • Download URL: myqueue-24.5.0-py3-none-any.whl
  • Upload date:
  • Size: 106.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.6

File hashes

Hashes for myqueue-24.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd6c0188501c17156dadede518a70edb7b5a5cde8b9ca21d27f7f3839cb86ee3
MD5 7fcc8dca11de118b0318fd973094ca33
BLAKE2b-256 84f683e1fc67ec39e736734bc8e62336560479d3a7d8e026e11211e91554df9d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page