1namespace Avogadro { 2 3/** 4 5@mainpage MoleQueue API Documentation 6 7@section molequeue Introduction 8 9The MoleQueue project is developed to support execution of command line 10executables, such as computational chemistry and simulation codes, both locally 11and remotely interacting with batch schedulers. These are provided as liberally 12BSD-licensed, open-source reuable components and an extensible system tray 13resident Qt application. 14 15@subsection main Main Classes 16 17The main bulk of the MoleQueue code implements a system tray resident Qt 4 18application. If you are interested in extending MoleQueue to support new 19queue types, transports and/or authentication mechanisms these classes will be 20of most interest. For applications looking to use the local socket JSON-RPC 2.0 21based API the client library will be of most interest. 22 23- MoleQueue::Queue : Abstract interface class for queues. 24 - MoleQueue::QueueLocal : Implementation of a local queue. 25 - MoleQueue::QueueRemote : Common API for remote queues. 26- MoleQueue::SshConnection : Interface for Ssh execution and transfer. 27- MoleQueue::LocalSocketConnectionListener : Listen for local connections. 28- The main two classes for client connections: 29 - MoleQueue::Client : Qt client class that can be used to manage jobs. 30 - MoleQueue::JsonRpcClient : General JSON-RPC 2.0 client. 31 32@section resources Resources 33 34This project is developed as part of the <a href="http://openchemistry.org/"> 35Open Chemistry project</a>. Please see the 36<a href="http://wiki.openchemistry.org/Development">development guide</a> if 37you would like to contribute to the project. Some key resources include: 38 39- Wiki : http://wiki.openchemistry.org/ 40- Bug tracker : http://projects.openchemistry.org/ 41- Dashboard : http://cdash.openchemistry.org/index.php?project=MoleQueue 42- Mailing lists: http://www.openchemistry.org/OpenChemistry/help/mailing.html 43 44 */ 45 46} 47