1MoleQueue 2========= 3![MoleQueue][MoleQueueLogo] 4 5Introduction 6------------ 7 8MoleQueue is an open-source, cross-platform, system-tray resident desktop 9application for abstracting, managing, and coordinating the execution of tasks 10both locally and on remote computational resources. Users can set up local and 11remote queues that describe where the task will be executed. Each queue can 12have programs, with templates to facilitate the execution of the program. Input 13files can be staged, and output files collected using a standard interface. 14Some highlights: 15 16* Open source distributed under the liberal 3-clause BSD license 17* Cross platform with nightly builds on Linux, Mac OS X and Windows 18* Intuitive interface designed to be useful to whole community 19* Support for local executation and remote schedulers (SGE, PBS, SLURM) 20* System tray resident application managing queue of queues and job lifetime 21* Simple, lightweight JSON-RPC 2.0 based communication over local sockets 22* Qt 5 client library for simple integration in Qt applications 23 24![Open Chemistry project][OpenChemistryLogo] 25![Kitware, Inc.][KitwareLogo] 26 27MoleQueue is being developed as part of the [Open Chemistry][OpenChemistry] 28project at [Kitware][Kitware], along with companion tools and libraries to 29support the work. 30 31Installing 32---------- 33 34We provide nightly binaries built by our [dashboards][Dashboard] for Mac OS 35X and Windows. If you would like to build from source we recommend that you 36follow our [building Open Chemistry][Build] guide that will take care of 37building most dependencies. 38 39Contributing 40------------ 41 42Our project uses the standard GitHub pull request process for code review 43and integration. Please check our [development][Development] guide for more 44details on developing and contributing to the project. The GitHub issue 45tracker can be used to report bugs, make feature requests, etc. 46 47Our [wiki][Wiki] is used to document features, flesh out designs and host other 48documentation. Our API is [documented using Doxygen][Doxygen] with updated 49documentation generated nightly. We have several [mailing lists][MailingLists] 50to coordinate development and to provide support. 51 52 [MoleQueueLogo]: http://openchemistry.org/files/logos/molequeue.png "MoleQueue" 53 [OpenChemistry]: http://openchemistry.org/ "Open Chemistry Project" 54 [OpenChemistryLogo]: http://openchemistry.org/files/logos/openchem128.png "Open Chemistry" 55 [Kitware]: http://kitware.com/ "Kitware, Inc." 56 [KitwareLogo]: http://www.kitware.com/img/small_logo_over.png "Kitware" 57 [Dashboard]: http://cdash.openchemistry.org/index.php?project=MoleQueue "MoleQueue Dashboard" 58 [Build]: http://wiki.openchemistry.org/Build "Building MoleQueue" 59 [Development]: http://wiki.openchemistry.org/Development "Development guide" 60 [Wiki]: http://wiki.openchemistry.org/ "Open Chemistry wiki" 61 [Doxygen]: http://doc.openchemistry.org/molequeue/api/ "API documentation" 62 [MailingLists]: http://openchemistry.org/mailing-lists "Mailing Lists" 63