summaryrefslogtreecommitdiff
path: root/doc/drmaa.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/drmaa.texi')
-rw-r--r--doc/drmaa.texi87
1 files changed, 87 insertions, 0 deletions
diff --git a/doc/drmaa.texi b/doc/drmaa.texi
new file mode 100644
index 0000000..494adc1
--- /dev/null
+++ b/doc/drmaa.texi
@@ -0,0 +1,87 @@
+
+\input texinfo
+@c -*-texinfo-*-
+
+@c %**start of header
+@setfilename guile-drmaa.info
+@documentencoding UTF-8
+@settitle Guile DRMAA Reference Manual
+@c %**end of header
+
+@include version.texi
+
+@copying
+Copyright @copyright{} 2020 Ricardo Wurmus
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
+copy of the license is included in the section entitled ``GNU Free
+Documentation License''.
+@end copying
+
+@dircategory The Algorithmic Language Scheme
+@direntry
+* Guile DRMAA: (guile-drmaa).
+@end direntry
+
+@titlepage
+@title The Guile DRMAA Manual
+@author Ricardo Wurmus
+
+@page
+@vskip 0pt plus 1filll
+Edition @value{EDITION} @*
+@value{UPDATED} @*
+
+@insertcopying
+@end titlepage
+
+@contents
+
+@c *********************************************************************
+@node Top
+@top Guile DRMAA
+
+This document describes Guile DRMAA version @value{VERSION}.
+
+@menu
+* Introduction:: Why Guile DRMAA?
+* Installation:: How do I install it?
+@end menu
+
+@c *********************************************************************
+@node Introduction
+@chapter Introduction
+
+DRMAA stands for @dfn{Distributed Resource Management Application
+API}; it's a common specification implemented in different HPC cluster
+schedulers to allow for programmatic submission and management of
+compute jobs.
+
+There are two versions of the DRMAA specifications: most cluster
+scheduler systems support the old version 1.0; the more recent version
+2.0 has only few implementations.
+
+Guile DRMAA currently only provides bindings for version 1.0, allowing
+you to manage jobs on most cluster schedulers with Guile Scheme.
+
+@c *********************************************************************
+@node Installation
+@chapter Installation
+
+Guile DRMAA uses the GNU build system. To install Guile DRMAA from
+a release tarball just unpack it and run the usual commands:
+
+@example
+./configure
+make
+make install
+@end example
+
+If you want to build the sources from the source repository you need to
+bootstrap the build system first. Run the @code{bootstrap.sh} script
+first and then perform the above steps.
+
+@bye