1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
# <img src="https://raw.githubusercontent.com/envmodules/modules/main/share/logo/modules_logo_text.svg" height="180" alt="Modules"/>
[](https://github.com/envmodules/modules/actions?query=workflow:linux-tests)
[](https://github.com/envmodules/modules/actions?query=workflow:windows-tests)
[](https://cirrus-ci.com/github/envmodules/modules)
[](https://codecov.io/gh/envmodules/modules)
[](https://modules.readthedocs.io/en/latest/?badge=latest)
[](https://repology.org/metapackage/environment-modules/versions)
[](https://bsky.app/profile/envmodules.bsky.social)
[](https://matrix.to/#/#modules:matrix.org)
Modules, provides dynamic modification of a user's environment
==============================================================
The Modules package is a tool that simplify shell initialization and
lets users easily modify their environment during the session with
modulefiles.
Each modulefile contains the information needed to configure the shell for
an application. Once the Modules package is initialized, the environment can
be modified on a per-module basis using the module command which interprets
modulefiles. Typically modulefiles instruct the module command to alter or
set shell environment variables such as PATH, MANPATH, etc. modulefiles may
be shared by many users on a system and users may have their own collection
to supplement or replace the shared modulefiles.
Modules can be loaded and unloaded dynamically and atomically, in an clean
fashion. All popular shells are supported, including bash, ksh, zsh, sh,
csh, tcsh, fish, cmd, pwsh, as well as some scripting languages such as tcl,
perl, python, ruby, cmake and r.
Modules are useful in managing different versions of applications. Modules
can also be bundled into meta-modules that will load an entire suite of
different applications.
Quick examples
--------------
Here is an example of loading a module on a Linux machine under bash.
$ module load gcc/12.4.0
$ which gcc
$ /usr/local/gcc/12.4.0/linux-x86_64/bin/gcc
Now we'll switch to a different version of the module
$ module switch gcc/14
$ which gcc
/usr/local/gcc/14.2.0/linux-x86_64/bin/gcc
And now we'll unload the module altogether
$ module unload gcc
$ which gcc
gcc not found
Now we'll log into a different machine, using a different shell (tcsh).
% module load gcc/14.2
% which gcc
/usr/local/gcc/14.2.0/linux-aarch64/bin/gcc
Note that the command line is exactly the same, but the path has
automatically configured to the correct architecture.
Getting things running
----------------------
The simplest way to build and install Modules on a Unix system is:
$ ./configure
$ make
$ make install
To learn the details on how to install modules see [`INSTALL.txt`][1] for Unix
system or [`INSTALL-win.txt`][2] for Windows.
Requirements
------------
* Tcl >= 8.5
Documentation
-------------
See [`MIGRATING`][3] to get an overlook of the new functionalities introduced
by each released versions. [`NEWS`][4] provides the full list of changes added
in each version. The [`Changes`][5] document gives an in-depth view of the
modified behaviors and new features between major versions. You may also look
at the `ChangeLog` for the technical development details.
The `doc` directory contains both the paper and man pages describing the
user's and the module writer's usage. To generate the documentation files,
like the man pages (you need Sphinx >= 1.0 to build the documentation), just
type:
$ ./configure
$ make -C doc all
The following man pages are provided:
module(1), ml(1), envml(1), modulefile(5)
Test suite
----------
Regression testing scripts are available in the `testsuite` directory (you
need DejaGnu to run the test suite):
$ ./configure
$ make test
Once modules is installed after running `make install`, you have the
ability to test this installation with:
$ make testinstall
Links
-----
* Web site: https://envmodules.io
* Online documentation: https://modules.readthedocs.io
* GitHub source repository: https://github.com/envmodules/modules
* GitHub Issue tracking system: https://github.com/envmodules/modules/issues
Community
---------
Modules is an open source project. Questions, discussion, and contributions
are welcome. You can get in contact with the Modules community via:
* the [modules-interest mailing list][6]
(`modules-interest@lists.sourceforge.net`)
* the [Modules chat room][7] (`#modules:matrix.org`)
The project is also present on several social media platforms:
* X/Twitter: [@EnvModules][8]
* Mastodon: [@EnvModules@mast.hpc.social][9]
* Bluesky: [@EnvModules.bsky.social][10]
Contributing
------------
Modules project welcomes contributions of all kinds! Before submitting an
issue or pull request, please take a moment to review our [Contributing
guide][11]. It includes important information about issue reporting, coding
standards, etc.
Please note that Modules project has a [Code of conduct][12]. It ensures a
respectful and inclusive environment for all contributors. By participating in
the Modules community, you agree to abide by its rules.
Governance
----------
Modules is part of the [High Performance Software Foundation](https://hpsf.io)
within the [Linux Foundation](http://linuxfoundation.org).
This project adheres to a [Technical charter][13], which defines its
governance model, decision-making process, and long-term vision.
License
-------
Modules is distributed under the GNU General Public License, either version 2
or (at your option) any later version (`GPL-2.0-or-later`). Read the file
`COPYING.GPLv2` for details.
Authors
-------
Modules current core developer and maintainer is Xavier Delaruelle,
xavier.delaruelle@cea.fr
Many thanks go to the [contributors][14] of the Modules project.
Acknowledgments
---------------
We would like to express our gratitude to [CEA][15] for the resources and
funding provided to the project over the recent years.
The following people have notably contributed to Modules and Modules would not
be what it is without their contributions:
* R.K. Owen
* Kent Mein
* Mark Lakata
* Harlan Stenn
* Leo Butler
* Robert Minsk
* Jens Hamisch
* Peter W. Osel
* John L. Furlan
[1]: https://modules.readthedocs.io/en/stable/INSTALL.html
[2]: https://modules.readthedocs.io/en/stable/INSTALL-win.html
[3]: https://modules.readthedocs.io/en/stable/MIGRATING.html
[4]: https://modules.readthedocs.io/en/stable/NEWS.html
[5]: https://modules.readthedocs.io/en/stable/changes.html
[6]: https://sourceforge.net/projects/modules/lists/modules-interest
[7]: https://matrix.to/#/#modules:matrix.org
[8]: https://x.com/EnvModules
[9]: https://mast.hpc.social/@EnvModules
[10]: https://bsky.app/profile/envmodules.bsky.social
[11]: https://modules.readthedocs.io/en/latest/CONTRIBUTING.html
[12]: CODE_OF_CONDUCT.md
[13]: https://modules.readthedocs.io/en/latest/CHARTER.html
[14]: https://github.com/envmodules/modules/graphs/contributors
[15]: https://www.cea.fr/english
|
