Welcome to lmodule documentation!

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 0.1.0 on Mar 31, 2021

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

Indices and tables