Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Modules documentation
Light Logo Dark Logo

Basics

  • Installing Modules on Unix
  • Installing Modules on Windows
  • New features
  • Release notes
  • Frequently Asked Questions
  • Changes between versions
  • Other module implementations

Examples

  • Cookbook
    • Handling Compiler and other Package Dependencies
    • Ensure user fully qualify the modules they use
    • Expose procedures and variables to modulefiles
    • Hide and forbid modules
    • Inhibit output of informative messages
    • Log module command
    • Handle man pages search path
    • Return file basename on module-info name for full path modulefile
    • Version control your Modulefiles using Git
    • Make defined modulepaths persist over sudo
    • Use new features without breaking old module command
    • Reduce I/O load
    • Source shell script in modulefile
    • Sticky modules
    • Testing Modulefiles
    • Tips for Code Reuse in Modulefiles
    • Top priority environment variable values
    • Unload firstly loaded module matching name

Reference

  • ml
  • module
  • modulefile
  • modulecmd
  • envml

Development

  • Contributing
  • Developer HowTos
    • Add new configuration option
    • Add a new maintainer
    • Add new module sub-command
    • Create new Modules release
    • Maintainer guide
    • Organize TSC meeting
    • Plan next release content
  • Design notes
    • Advanced module version specifiers
    • Conflict unload
    • Control mode behaviors
    • Default and latest version specifiers
    • Adding Environment Modules support to EESSI
    • Evaluation errors
    • Extended default
    • Extra match search
    • Hide or forbid modulefile
    • Initial environment
    • Insensitive case
    • lint sub-command
    • Lmod Tcl modulefile compatibility
    • Module magic cookie check
    • mod-to-sh sub-command
    • Mode select: irreversible module actions
    • Module cache
    • Module selection contexts
    • Module tags
    • module-warn modulefile command
    • --modulepath option
    • Output configuration
    • provide modulefile command
    • Require via
    • Shell completion
    • Source shell script in modulefile
    • spider sub-command
    • Stashing environment
    • Sticky modules
    • Variants
  • Modules Technical Charter
  • Modules Governance
  • Acknowledgments
Back to top
View this page

Developer HowTosΒΆ

Developer guides to implement new command, option, etc or draft a new release of Modules.

  • Add new configuration option
  • Add a new maintainer
  • Add new module sub-command
  • Create new Modules release
  • Maintainer guide
  • Organize TSC meeting
  • Plan next release content
Next
Add new configuration option
Previous
Contributing
Copyright © 1996-2026, Modules Contributors
Made with Sphinx and @pradyunsg's Furo