PySlurm: Slurm interface for Python

Authors:	Mark Roberts <[email protected]> and Stephan Gorget <[email protected]>

Overview

Currently PySlurm is under development to move from it's thin layer on top of the Slurm C API to an object orientated interface.

The current branch is based on the Slurm 2.6.0 API

Prerequistes

This version has been tested with Slurm 2.6.0, Cython 0.15.1 and Python 2.7

• [Slurm] http://www.schedmd.com
• [Python] http://www.python.org
• [Cython] http://www.cython.org

Installation

You will need to instruct the setup.py script where either the Slurm install root directory or where the Slurm libraries and Slurm include files are :

1. Slurm default directory (/usr):

   • python setup.py build
   • python setup.py install

2. Indicate Blue Gene type (L/P/Q) on build line:

   • --bgl or --bgp or --bgq

3. Slurm root directory (Alternate installation directory):

   • python setup.py build --slurm=PATH_TO_SLURM_DIR
   • python setup.py install

4. Separate Slurm library and include directory paths:

   • python setup.py build --slurm-lib=PATH_TO_SLURM_LIB --slurm-inc=PATH_TO_SLURM_INC
   • python setup.py install

5. The build will automatically call a cleanup procedure to remove temporary build files but this can be called directly if needed as well with :

   • python setup.py clean

Documentation

Sphinx (needs to be installe) is currently used to generate the documentation from the reStructuredText based doc strings from the module once it is built and can be regenerated at any time :

• cd doc
• make clean
• make html

Prebuilt documentation for the module can be reviewed online, and the source code is available on GitHub.