# pyslurm

**Repository Path**: leopard/pyslurm

## Basic Information

- **Project Name**: pyslurm
- **Description**: mirror https://github.com/PySlurm/pyslurm.git
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: 15.08.0
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-24
- **Last Updated**: 2022-01-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

***********************************
PySlurm: Slurm interface for Python
***********************************

:Authors: Mark Roberts <mark@gingergeeks.co.uk> and Giovanni Torres <giovanni.torres@gmail.com>

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.

This release is based on the Slurm 15.08.0 API.

Pre-requistes
*************

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

This release has been tested with :

	* Slurm 15.08.0-0rc1, Cython 0.22.1 and Python 2.7.4
	* Slurm 15.08.0-0rc1, Cython 0.23.1 and Python 2.7.4
	* Slurm 15.08.1, Cython 0.23.4 and Python 2.7.5

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 :

#. Slurm default directory (/usr):

	* python setup.py build

	* python setup.py install

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

	* --bgl or --bgp or --bgq

#. Slurm root directory (Alternate installation directory):

	* python setup.py build --slurm=PATH_TO_SLURM_DIR

	* python setup.py install

#. 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

#. 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 <http://www.sphinx-doc.org>`_ (needs to be installed) 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

Download
********

The source code is available on `GitHub <http://github.com/gingergeeks/pyslurm>`_.