{"payload":{"allShortcutsEnabled":false,"fileTree":{"":{"items":[{"name":".github","path":".github","contentType":"directory"},{"name":"contrib","path":"contrib","contentType":"directory"},{"name":"doc","path":"doc","contentType":"directory"},{"name":"init","path":"init","contentType":"directory"},{"name":"lib","path":"lib","contentType":"directory"},{"name":"script","path":"script","contentType":"directory"},{"name":"tcl","path":"tcl","contentType":"directory"},{"name":"testsuite","path":"testsuite","contentType":"directory"},{"name":".cirrus.yml","path":".cirrus.yml","contentType":"file"},{"name":".codespellrc","path":".codespellrc","contentType":"file"},{"name":".gitattributes","path":".gitattributes","contentType":"file"},{"name":".gitignore","path":".gitignore","contentType":"file"},{"name":".globalrc","path":".globalrc","contentType":"file"},{"name":".hunspell.en.dic","path":".hunspell.en.dic","contentType":"file"},{"name":".readthedocs.yaml","path":".readthedocs.yaml","contentType":"file"},{"name":"CODE_OF_CONDUCT.md","path":"CODE_OF_CONDUCT.md","contentType":"file"},{"name":"CONTRIBUTING.rst","path":"CONTRIBUTING.rst","contentType":"file"},{"name":"COPYING.GPLv2","path":"COPYING.GPLv2","contentType":"file"},{"name":"INSTALL-win.rst","path":"INSTALL-win.rst","contentType":"file"},{"name":"INSTALL.rst","path":"INSTALL.rst","contentType":"file"},{"name":"MIGRATING.rst","path":"MIGRATING.rst","contentType":"file"},{"name":"Makefile","path":"Makefile","contentType":"file"},{"name":"Makefile.inc.in","path":"Makefile.inc.in","contentType":"file"},{"name":"NEWS.rst","path":"NEWS.rst","contentType":"file"},{"name":"README.md","path":"README.md","contentType":"file"},{"name":"codecov.yml","path":"codecov.yml","contentType":"file"},{"name":"configure","path":"configure","contentType":"file"},{"name":"site.exp.in","path":"site.exp.in","contentType":"file"},{"name":"siteconfig.tcl","path":"siteconfig.tcl","contentType":"file"},{"name":"version.inc.in","path":"version.inc.in","contentType":"file"}],"totalCount":30}},"fileTreeProcessingTime":4.554725,"foldersToFetch":[],"repo":{"id":84907885,"defaultBranch":"main","name":"modules","ownerLogin":"cea-hpc","currentUserCanPush":false,"isFork":false,"isEmpty":false,"createdAt":"2017-03-14T05:10:41.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/1496664?v=4","public":true,"private":false,"isOrgOwned":true},"symbolsExpanded":false,"treeExpanded":true,"refInfo":{"name":"main","listCacheKey":"v0:1708429447.0","canEdit":false,"refType":"branch","currentOid":"820c788d0f5eb31df38a19859eacae58b2fb74cc"},"path":"README.md","currentUser":null,"blob":{"rawLines":null,"stylingDirectives":null,"colorizedLines":null,"csv":null,"csvError":null,"dependabotInfo":{"showConfigurationBanner":false,"configFilePath":null,"networkDependabotPath":"/cea-hpc/modules/network/updates","dismissConfigurationNoticePath":"/settings/dismiss-notice/dependabot_configuration_notice","configurationNoticeDismissed":null},"displayName":"README.md","displayUrl":"https://github.com/cea-hpc/modules/blob/main/README.md?raw=true","headerInfo":{"blobSize":"5.72 KB","deleteTooltip":"You must be signed in to make or propose changes","editTooltip":"You must be signed in to make or propose changes","ghDesktopPath":"https://desktop.github.com","isGitLfs":false,"onBranch":true,"shortPath":"cbf254e","siteNavLoginPath":"/login?return_to=https%3A%2F%2Fgithub.com%2Fcea-hpc%2Fmodules%2Fblob%2Fmain%2FREADME.md","isCSV":false,"isRichtext":true,"toc":[{"level":1,"text":"","anchor":"","htmlText":""},{"level":1,"text":"Modules, provides dynamic modification of a user's environment","anchor":"modules-provides-dynamic-modification-of-a-users-environment","htmlText":"Modules, provides dynamic modification of a user's environment"},{"level":2,"text":"Quick examples","anchor":"quick-examples","htmlText":"Quick examples"},{"level":2,"text":"Getting things running","anchor":"getting-things-running","htmlText":"Getting things running"},{"level":2,"text":"Requirements","anchor":"requirements","htmlText":"Requirements"},{"level":2,"text":"License","anchor":"license","htmlText":"License"},{"level":2,"text":"Documentation","anchor":"documentation","htmlText":"Documentation"},{"level":2,"text":"Test suite","anchor":"test-suite","htmlText":"Test suite"},{"level":2,"text":"Links","anchor":"links","htmlText":"Links"},{"level":2,"text":"Code of conduct","anchor":"code-of-conduct","htmlText":"Code of conduct"},{"level":2,"text":"Authors","anchor":"authors","htmlText":"Authors"}],"lineInfo":{"truncatedLoc":"187","truncatedSloc":"124"},"mode":"file"},"image":false,"isCodeownersFile":null,"isPlain":false,"isValidLegacyIssueTemplate":false,"issueTemplate":null,"discussionTemplate":null,"language":"Markdown","languageID":222,"large":false,"planSupportInfo":{"repoIsFork":null,"repoOwnedByCurrentUser":null,"requestFullPath":"/cea-hpc/modules/blob/main/README.md","showFreeOrgGatedFeatureMessage":null,"showPlanSupportBanner":null,"upgradeDataAttributes":null,"upgradePath":null},"publishBannersInfo":{"dismissActionNoticePath":"/settings/dismiss-notice/publish_action_from_dockerfile","releasePath":"/cea-hpc/modules/releases/new?marketplace=true","showPublishActionBanner":false},"rawBlobUrl":"https://github.com/cea-hpc/modules/raw/main/README.md","renderImageOrRaw":false,"richText":"

\"Modules\"

\n

\"Linux\n\"Windows\n\"FreeBSD/OS\n\"Coverage\n\"Documentation\n\"Packaging\n\"Twitter\"

\n

Modules, provides dynamic modification of a user's environment

\n

The Modules package is a tool that simplify shell initialization and\nlets users easily modify their environment during the session with\nmodulefiles.

\n

Each modulefile contains the information needed to configure the shell for\nan application. Once the Modules package is initialized, the environment can\nbe modified on a per-module basis using the module command which interprets\nmodulefiles. Typically modulefiles instruct the module command to alter or\nset shell environment variables such as PATH, MANPATH, etc. modulefiles may\nbe shared by many users on a system and users may have their own collection\nto supplement or replace the shared modulefiles.

\n

Modules can be loaded and unloaded dynamically and atomically, in an clean\nfashion. All popular shells are supported, including bash, ksh, zsh, sh,\ncsh, tcsh, fish, cmd, as well as some scripting languages such as tcl, perl,\npython, ruby, cmake and r.

\n

Modules are useful in managing different versions of applications. Modules\ncan also be bundled into meta-modules that will load an entire suite of\ndifferent applications.

\n

Quick examples

\n

Here is an example of loading a module on a Linux machine under bash.

\n
$ module load gcc/9.4.0\n$ which gcc\n$ /usr/local/gcc/9.4.0/linux-x86_64/bin/gcc\n
\n

Now we'll switch to a different version of the module

\n
$ module switch gcc gcc/10\n$ which gcc\n/usr/local/gcc/10.3.0/linux-x86_64/bin/gcc\n
\n

And now we'll unload the module altogether

\n
$ module unload gcc\n$ which gcc\ngcc not found\n
\n

Now we'll log into a different machine, using a different shell (tcsh).

\n
% module load gcc/10.3\n% which gcc\n/usr/local/gcc/10.3.0/linux-aarch64/bin/gcc\n
\n

Note that the command line is exactly the same, but the path has\nautomatically configured to the correct architecture.

\n

Getting things running

\n

The simplest way to build and install Modules on a Unix system is:

\n
$ ./configure\n$ make\n$ make install\n
\n

To learn the details on how to install modules see INSTALL.txt for Unix\nsystem or INSTALL-win.txt for Windows.

\n

Requirements

\n\n

License

\n

Modules is distributed under the GNU General Public License, either version 2\nor (at your option) any later version (GPL v2+). Read the file COPYING.GPLv2\nfor details.

\n

Documentation

\n

See MIGRATING to get an overlook of the new functionalities introduced\nby each released versions. NEWS provides the full list of changes added\nin each version. The Changes document gives an in-depth view of the\nmodified behaviors and new features between major versions. You may also look\nat the ChangeLog for the technical development details.

\n

The doc directory contains both the paper and man pages describing the\nuser's and the module writer's usage. To generate the documentation files,\nlike the man pages (you need Sphinx >= 1.0 to build the documentation), just\ntype:

\n
$ ./configure\n$ make -C doc all\n
\n

The following man pages are provided:

\n
module(1), ml(1), modulefile(5)\n
\n

Test suite

\n

Regression testing scripts are available in the testsuite directory (you\nneed DejaGnu to run the test suite):

\n
$ ./configure\n$ make test\n
\n

Once modules is installed after running make install, you have the\nability to test this installation with:

\n
$ make testinstall\n
\n

Links

\n

Web site:

\n
\n

http://modules.sourceforge.net

\n
\n

Online documentation:

\n
\n

https://modules.readthedocs.io

\n
\n

GitHub source repository:

\n
\n

https://github.com/cea-hpc/modules

\n
\n

GitHub Issue tracking system:

\n
\n

https://github.com/cea-hpc/modules/issues

\n
\n

SourceForge project page:

\n
\n

http://sourceforge.net/projects/modules/

\n
\n

Code of conduct

\n

Please note that Modules has a Code of conduct. By participating in the\nModules community, you agree to abide by its rules.

\n

Authors

\n

Current core developer and maintainer is:

\n\n

The following people have notably contributed to Modules and Modules would\nnot be what it is without their contributions:

\n\n
","renderedFileInfo":null,"shortPath":null,"symbolsEnabled":true,"tabSize":8,"topBannersInfo":{"overridingGlobalFundingFile":false,"globalPreferredFundingPath":null,"showInvalidCitationWarning":false,"citationHelpUrl":"https://docs.github.com/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files","actionsOnboardingTip":null},"truncated":false,"viewable":true,"workflowRedirectUrl":null,"symbols":{"timed_out":false,"not_analyzed":false,"symbols":[{"name":"\"Modules\"/","kind":"section_1","ident_start":2,"ident_end":120,"extent_start":0,"extent_end":5861,"fully_qualified_name":"\"Modules\"/","ident_utf16":{"start":{"line_number":0,"utf16_col":2},"end":{"line_number":0,"utf16_col":120}},"extent_utf16":{"start":{"line_number":0,"utf16_col":0},"end":{"line_number":187,"utf16_col":0}}},{"name":"Modules, provides dynamic modification of a user's environment","kind":"section_1","ident_start":1153,"ident_end":1215,"extent_start":1153,"extent_end":1279,"fully_qualified_name":"Modules, provides dynamic modification of a user's environment","ident_utf16":{"start":{"line_number":10,"utf16_col":0},"end":{"line_number":10,"utf16_col":62}},"extent_utf16":{"start":{"line_number":10,"utf16_col":0},"end":{"line_number":12,"utf16_col":0}}},{"name":"Quick examples","kind":"section_2","ident_start":2361,"ident_end":2375,"extent_start":2361,"extent_end":2391,"fully_qualified_name":"Quick examples","ident_utf16":{"start":{"line_number":35,"utf16_col":0},"end":{"line_number":35,"utf16_col":14}},"extent_utf16":{"start":{"line_number":35,"utf16_col":0},"end":{"line_number":37,"utf16_col":0}}},{"name":"Getting things running","kind":"section_2","ident_start":3095,"ident_end":3117,"extent_start":3095,"extent_end":3141,"fully_qualified_name":"Getting things running","ident_utf16":{"start":{"line_number":66,"utf16_col":0},"end":{"line_number":66,"utf16_col":22}},"extent_utf16":{"start":{"line_number":66,"utf16_col":0},"end":{"line_number":68,"utf16_col":0}}},{"name":"Requirements","kind":"section_2","ident_start":3386,"ident_end":3398,"extent_start":3386,"extent_end":3412,"fully_qualified_name":"Requirements","ident_utf16":{"start":{"line_number":79,"utf16_col":0},"end":{"line_number":79,"utf16_col":12}},"extent_utf16":{"start":{"line_number":79,"utf16_col":0},"end":{"line_number":81,"utf16_col":0}}},{"name":"License","kind":"section_2","ident_start":3429,"ident_end":3436,"extent_start":3429,"extent_end":3445,"fully_qualified_name":"License","ident_utf16":{"start":{"line_number":85,"utf16_col":0},"end":{"line_number":85,"utf16_col":7}},"extent_utf16":{"start":{"line_number":85,"utf16_col":0},"end":{"line_number":87,"utf16_col":0}}},{"name":"Documentation","kind":"section_2","ident_start":3618,"ident_end":3631,"extent_start":3618,"extent_end":3646,"fully_qualified_name":"Documentation","ident_utf16":{"start":{"line_number":93,"utf16_col":0},"end":{"line_number":93,"utf16_col":13}},"extent_utf16":{"start":{"line_number":93,"utf16_col":0},"end":{"line_number":95,"utf16_col":0}}},{"name":"Test suite","kind":"section_2","ident_start":4366,"ident_end":4376,"extent_start":4366,"extent_end":4388,"fully_qualified_name":"Test suite","ident_utf16":{"start":{"line_number":115,"utf16_col":0},"end":{"line_number":115,"utf16_col":10}},"extent_utf16":{"start":{"line_number":115,"utf16_col":0},"end":{"line_number":117,"utf16_col":0}}},{"name":"Links","kind":"section_2","ident_start":4672,"ident_end":4677,"extent_start":4672,"extent_end":4684,"fully_qualified_name":"Links","ident_utf16":{"start":{"line_number":130,"utf16_col":0},"end":{"line_number":130,"utf16_col":5}},"extent_utf16":{"start":{"line_number":130,"utf16_col":0},"end":{"line_number":132,"utf16_col":0}}},{"name":"Code of conduct","kind":"section_2","ident_start":5000,"ident_end":5015,"extent_start":5000,"extent_end":5032,"fully_qualified_name":"Code of conduct","ident_utf16":{"start":{"line_number":154,"utf16_col":0},"end":{"line_number":154,"utf16_col":15}},"extent_utf16":{"start":{"line_number":154,"utf16_col":0},"end":{"line_number":156,"utf16_col":0}}},{"name":"Authors","kind":"section_2","ident_start":5164,"ident_end":5171,"extent_start":5164,"extent_end":5180,"fully_qualified_name":"Authors","ident_utf16":{"start":{"line_number":161,"utf16_col":0},"end":{"line_number":161,"utf16_col":7}},"extent_utf16":{"start":{"line_number":161,"utf16_col":0},"end":{"line_number":163,"utf16_col":0}}}]}},"copilotInfo":null,"copilotAccessAllowed":false,"csrf_tokens":{"/cea-hpc/modules/branches":{"post":"jk9i3B7t0D_kZqZ1dshTe_mocrvDofSMPK6NwA-40sKS_tEL5JDDuL6GIk5jPHDN8Egwgw2j4V9NFJ1a7FCGTg"},"/repos/preferences":{"post":"rDRMslPbt9NZHRIt7Xe7_sXqY214C5o9z3Pg-9Of4DUPN5unQQVyIgIucRCCSvIIDIOQtTGdN6HUHCfHJ2pSjg"}}},"title":"modules/README.md at main ยท cea-hpc/modules"}