admgc / lsf-python-api

Location for the LSF Python wrapper for controlling all things LSF

platform-python-lsf-api

These python wrappers allow customers to submit and control jobs and obtain status of queues, hosts and other LSF attributes from Python directly. They work with various versions of LSF and are maintained by LSF developement, though we take contributions from the Open Source community.

If you plan or would like to contribute to the library, you must follow the DCO process in the attached DCO Readme file in the root of this repository. It essentially requires you to provide a Sign Off line in the notes of your pull request stating that the work is clear of infinging work by others. Again, for more details, please see the DCO Readme file.

Release Information

• IBM Spectrum LSF Python Wrappers
• Supporting LSF Release: 10.1
• Wrapper Version: 1.0.4
• Publication date: 16 October 2013
• Last modified: 6 January 2017

Contents

• Introduction
• Installation
• Release Notes
• Community Contribution
• Copyright

Introduction

This library allows you to call the LSF APIs directly through Python. You can find more information and usage notes here. The wrapper is created using Pythons SWIG interface and links directly to LSF's shared libraries.

You are encouraged to contribute your own Python wrappers to the Open Source LSF APIs for Python, and you may find some examples in IBM Platform LSF Wiki.

IBM provides formal support for this software to entitled clients via the normal IBM support channels.

This software is Licensed under the Eclipse Public License.

Please note you must use lsf.lsb_init before any other LSBLIB library routine in your application.

Installation

Before compiling the library, set the LSF environment variables.

To compile and install the library, go to the main source directory and type:

$ python setup.py build

$ sudo python setup.py install

Release Notes

Release 1.0.4

• Fixed a bug for using lsf.lsb_readstream()
• Added a new example, readstream.py

Release 1.0.3

• Added 2 extra routines below :
  • lsb_fseek()
  • lsb_ftell()

Release 1.0.2

• Fix a compliation error

Release 1.0.1

• This is the first release from IBM Platform Computing.
• Tested with LSF 9.1.2 on Linux 2.6.
• In addition to the wrapper for LSF APIs, the following routines were added:
  • get_load_of_hosts() - Returns a list of hostLoad objects.
  • get_host_names() - Returns the name of the hosts in the cluster.
  • get_host_info() - Returns a list of hostInfo objects.
  • get_host_load() - Returns the current values for the resources of a host.

Community Contribution Requirements

Community contributions to this repository must follow the IBM Developer's Certificate of Origin (DCO) process and only through GitHub Pull Requests:

1. Contributor proposes new code to community.

2. Contributor signs off on contributions (i.e. attachs the DCO to ensure contributor is either the code originator or has rights to publish. The template of the DCO is included in this package).

3. IBM Spectrum LSF development reviews contribution to check for: i) Applicability and relevancy of functional content ii) Any obvious issues

4. If accepted, posts contribution. If rejected, work goes back to contributor and is not merged.

Copyright

(C) Copyright IBM Corporation 2016-2017

U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

IBM(R), the IBM logo and ibm.com(R) are trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.