= Job scheduler extension =

This package is an extension package to BASE that adds support
for interacting with Open Grid Scheduler and Slurm clusters. This package is
of no use on it's own. It has been designed to let other extensions
submit and monitor jobs on Open Grid and Slurm clusters. This package
provides:

 * Simple configuration for accessing one or more clusters.
 * An API for programmatic submission of jobs to the clusters. 
 * A service that monitor the status and progress of submitted jobs.
 * BASE jobs are used as proxies and can provide full progress reporting (with some help from the job scripts).
 * Asynchronous callback methods are used to notify the extension when submitted jobs have been completed.

== Documentation ==

 * BASE 3.19 and Java 11 or higher is required.
 * [source:/extensions/net.sf.basedb.opengrid/tags/1.7/README README]
 * [wiki:net.sf.basedb.opengrid/install Installation and configuration instructions]
 * [wiki:net.sf.basedb.opengrid/using How to use the Job scheduler package API]
 * [/chrome/site/net.sf.basedb.opengrid/api/index.html Javadoc API documentation]


== License ==

 * [http://www.gnu.org/licenses/agpl-3.0.html GNU Affero General Public License version 3].


== Download ==

|| '''Version''' || '''Revision''' || '''Date'''       || '''Binary (tar.gz)''' || '''BASE Version''' || '''Special notes''' || || 
|| 1.9           || 7039           || February 13, 2023    || [attachment:wiki:net.sf.basedb.opengrid:opengrid-1.9.tar.gz?format=raw opengrid-1.9.tar.gz] (888kb) || 3.19 or later || - || [query:"groupdesc=1&group=type&milestone=Job scheduler extension v1.9&order=priority" changelog] ||
|| 1.8           || 6984           || January 17, 2023    || [attachment:wiki:net.sf.basedb.opengrid:opengrid-1.8.tar.gz?format=raw opengrid-1.8.tar.gz] (889kb) || 3.19 or later || - || [query:"groupdesc=1&group=type&milestone=Job scheduler extension v1.8&order=priority" changelog] ||
|| 1.7           || 6843           || September 9, 2022    || [attachment:wiki:net.sf.basedb.opengrid:opengrid-1.7.tar.gz?format=raw opengrid-1.7.tar.gz] (889kb) || 3.19 or later || - || [query:"groupdesc=1&group=type&milestone=Job scheduler extension v1.7&order=priority" changelog] ||
|| 1.6           || 6707           || April 27, 2022    || [attachment:wiki:net.sf.basedb.opengrid:opengrid-1.6.tar.gz?format=raw opengrid-1.6.tar.gz] (883kb) || 3.19 or later || - || [query:"groupdesc=1&group=type&milestone=Job scheduler extension v1.6&order=priority" changelog] ||
|| 1.5           || 6690           || April 21, 2022    || [attachment:wiki:net.sf.basedb.opengrid:opengrid-1.5.tar.gz?format=raw opengrid-1.5.tar.gz] (883kb) || 3.19 or later || Added support for Singularity || [query:"groupdesc=1&group=type&milestone=Job scheduler extension v1.5&order=priority" changelog] ||
|| 1.4           || 6319           || June 11, 2021    || [attachment:wiki:net.sf.basedb.opengrid:opengrid-1.4.tar.gz?format=raw opengrid-1.4.tar.gz] (833kb) || 3.18 or later || Added support for Slurm || [query:"groupdesc=1&group=type&milestone=Job scheduler extension v1.4&order=priority" changelog] ||
|| 1.3           || 5565           || August 14, 2019  || [attachment:wiki:net.sf.basedb.opengrid:opengrid-1.3.tar.gz?format=raw opengrid-1.3.tar.gz] (1.0MB) || 3.15 or later || Java 11 || [query:"groupdesc=1&group=type&milestone=Open Grid Scheduler service v1.3&order=priority" changelog] ||
|| 1.2           || 4935           || August 23, 2018  || [attachment:wiki:net.sf.basedb.opengrid:opengrid-1.2.tar.gz?format=raw opengrid-1.2.tar.gz] (632kB) || 3.13 or later || - || [query:"groupdesc=1&group=type&milestone=Open Grid Scheduler service v1.2&order=priority" changelog] ||
|| 1.1           || 4502           || May 10, 2017     || [attachment:wiki:net.sf.basedb.opengrid:opengrid-1.1.tar.gz?format=raw opengrid-1.1.tar.gz] (4.0MB) || 3.11 or later || - || [query:"groupdesc=1&group=type&milestone=Open Grid Scheduler service v1.1&order=priority" changelog] ||
|| 1.0           || 4327           || February 1, 2017 || [attachment:wiki:net.sf.basedb.opengrid:opengrid-1.0.tar.gz?format=raw opengrid-1.0.tar.gz] (3.9MB) || 3.10 or later || - || [query:"groupdesc=1&group=type&milestone=Open Grid Scheduler service v1.0&order=priority" changelog] ||

'''Source code''' can be downloaded from the subversion repository. Use the following command to get source code for the 1.6 version:

 `svn co https://baseplugins.thep.lu.se/svn/extensions/net.sf.basedb.opengrid/tags/1.6 opengrid-1.6`


The latest development (''maybe unstable; do not use on a production server'') revision can be checked out from the repository using the following command:

 `svn co https://baseplugins.thep.lu.se/svn/extensions/net.sf.basedb.opengrid/trunk opengrid-dev`



== Contribute ==

After making modifications to the source code, compose a clear and concise log message to describe those changes and the reasons for them. Then, send an email to the developers list containing your log message and the output of svn diff (from the top of your subversion working copy). If the community members consider your changes acceptable, someone who has commit privileges will add your changes to the public source code tree. Recall that permission to directly commit changes to the repository is granted on merit - if you demonstrate comprehension of subversion, programming competency, and a ''team spirit'', you will likely be awarded that permission.


== Todo ==
[[TicketQuery(status!=closed&component=net.sf.basedb.opengrid)]]