Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 2.5 KB

index.rst

File metadata and controls

65 lines (46 loc) · 2.5 KB

Welcome to lmodule documentation!

Documentation Status codecov version license pypi python

lmodule is a Python API for Lmod module system. lmodule was originally part of buildtest and we decided that it could benefit the entire community for folks interested in using the API but not relying on buildtest. The documentation is built for version version on

What is lmodule?

Lmodule is a Python 3 API that allows you to interact with the module command provided by Lmod in a programmatic way. The API comes with three classes:

  • Module: This class emulates the module command
  • Spider: This class runs the Lmod spider command to retrieve all module records in json
  • ModuleLoadTest: This class automates module load of one or more module trees

Why use lmodule?

Here are few reasons why you would want to use lmodule

  1. Currently, there is no Python API for Lmod, however there is a python interface LMOD_CMD python by Lmod that requires parsing and output is cryptic.
  2. Automates module load test for each module in one or more module trees (Software Stack). This can be used to spot faulty modules in a large software stack. This type of test is meant to run using CI tool for continuous testing of module stack.

installation.rst module.rst spider.rst moduleloadtest.rst examples.rst api.rst

Indices and tables

  • genindex
  • modindex
  • search