Debian Codegraph @

README.md

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