JobQueues

Welcome to JobQueues’s documentation!

• Installation
  • Downloading miniconda
  • Create a conda environment
  • Install jobqueues with conda
• API
  • Subpackages
    • jobqueues.celeryfiles package
      • Submodules
        • jobqueues.celeryfiles.celery module
        • jobqueues.celeryfiles.tasks module
          • execute_cpu_job()
          • execute_gpu_job()
          • kill()
      • Module contents
  • Submodules
    • jobqueues.celeryqueue module
      • CeleryQueue
        • CeleryQueue.inprogress()
        • CeleryQueue.memory
        • CeleryQueue.ncpu
        • CeleryQueue.ngpu
        • CeleryQueue.retrieve()
        • CeleryQueue.stop()
        • CeleryQueue.submit()
    • jobqueues.config module
      • config()
      • loadConfig()
    • jobqueues.home module
      • home()
    • jobqueues.localqueue module
      • LocalCPUQueue
        • LocalCPUQueue.memory
        • LocalCPUQueue.ncpu
        • LocalCPUQueue.ngpu
      • LocalGPUQueue
        • LocalGPUQueue.memory
        • LocalGPUQueue.ncpu
        • LocalGPUQueue.ngpu
    • jobqueues.lsfqueue module
      • LsfQueue
        • LsfQueue.inprogress()
        • LsfQueue.memory
        • LsfQueue.ncpu
        • LsfQueue.ngpu
        • LsfQueue.retrieve()
        • LsfQueue.stop()
        • LsfQueue.submit()
    • jobqueues.pbsqueue module
      • PBSQueue
        • PBSQueue.inprogress()
        • PBSQueue.memory
        • PBSQueue.ncpu
        • PBSQueue.ngpu
        • PBSQueue.retrieve()
        • PBSQueue.stop()
        • PBSQueue.submit()
    • jobqueues.playqueue module
      • PlayQueue
        • PlayQueue.inprogress()
        • PlayQueue.memory
        • PlayQueue.ncpu
        • PlayQueue.ngpu
        • PlayQueue.retrieve()
        • PlayQueue.stop()
        • PlayQueue.submit()
    • jobqueues.sgequeue module
      • SgeQueue
        • SgeQueue.inprogress()
        • SgeQueue.memory
        • SgeQueue.ncpu
        • SgeQueue.ngpu
        • SgeQueue.retrieve()
        • SgeQueue.stop()
        • SgeQueue.submit()
    • jobqueues.simqueue module
      • InProgressError
      • ProjectNotExistError
      • QueueJobStatus
        • QueueJobStatus.CANCELLED
        • QueueJobStatus.COMPLETED
        • QueueJobStatus.FAILED
        • QueueJobStatus.OUT_OF_MEMORY
        • QueueJobStatus.PENDING
        • QueueJobStatus.RUNNING
        • QueueJobStatus.TIMEOUT
        • QueueJobStatus.describe()
      • RetrieveError
      • SimQueue
        • SimQueue.inprogress()
        • SimQueue.memory
        • SimQueue.ncpu
        • SimQueue.ngpu
        • SimQueue.notcompleted()
        • SimQueue.retrieve()
        • SimQueue.stop()
        • SimQueue.submit()
        • SimQueue.wait()
      • SubmitError
    • jobqueues.slurmqueue module
      • SlurmQueue
        • SlurmQueue.inprogress()
        • SlurmQueue.jobInfo()
        • SlurmQueue.memory
        • SlurmQueue.ncpu
        • SlurmQueue.ngpu
        • SlurmQueue.retrieve()
        • SlurmQueue.stop()
        • SlurmQueue.submit()
    • jobqueues.util module
      • ensurelist()
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page