Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/envmodules/modules

Environment Modules: provides dynamic modification of a user's environment
https://github.com/envmodules/modules

environment environment-modules hacktoberfest hpc module modulefiles shell tcl

Last synced: about 1 month ago
JSON representation

Environment Modules: provides dynamic modification of a user's environment

Host: GitHub
URL: https://github.com/envmodules/modules
Owner: envmodules
License: gpl-2.0
Created: 2017-03-14T05:10:41.000Z (almost 8 years ago)
Default Branch: main
Last Pushed: 2024-12-13T20:39:38.000Z (about 1 month ago)
Last Synced: 2024-12-13T21:19:50.007Z (about 1 month ago)
Topics: environment, environment-modules, hacktoberfest, hpc, module, modulefiles, shell, tcl
Language: Tcl
Homepage: https://envmodules.github.io/modules/
Size: 20.5 MB
Stars: 720
Watchers: 37
Forks: 110
Open Issues: 24
Metadata Files:
- Readme: README.md
- Changelog: NEWS.rst
- Contributing: CONTRIBUTING.rst
- License: COPYING.GPLv2
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # 

[![Linux Build Status](https://github.com/envmodules/modules/workflows/linux-tests/badge.svg)](https://github.com/envmodules/modules/actions?query=workflow:linux-tests)

[![Windows Build Status](https://github.com/envmodules/modules/workflows/windows-tests/badge.svg)](https://github.com/envmodules/modules/actions?query=workflow:windows-tests)

[![FreeBSD/OS X/Linux Build Status](https://api.cirrus-ci.com/github/envmodules/modules.svg)](https://cirrus-ci.com/github/envmodules/modules)

[![Coverage Status](https://codecov.io/gh/envmodules/modules/branch/main/graph/badge.svg)](https://codecov.io/gh/envmodules/modules)

[![Documentation Status](https://readthedocs.org/projects/modules/badge/?version=latest)](https://modules.readthedocs.io/en/latest/?badge=latest)

[![Packaging status](https://repology.org/badge/tiny-repos/environment-modules.svg)](https://repology.org/metapackage/environment-modules/versions)

[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/EnvModules.svg?style=social&label=Follow)](https://twitter.com/EnvModules)

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/9.4.0

    $ which gcc

    $ /usr/local/gcc/9.4.0/linux-x86_64/bin/gcc

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

    $ module switch gcc gcc/10

    $ which gcc

    /usr/local/gcc/10.3.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/10.3

    % which gcc

    /usr/local/gcc/10.3.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

License

-------

Modules is distributed under the GNU General Public License, either version 2

or (at your option) any later version (GPL v2+). Read the file `COPYING.GPLv2`

for details.

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), 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: http://modules.sourceforge.net

* Online documentation: https://modules.readthedocs.io

* GitHub source repository: https://github.com/envmodules/modules

* GitHub Issue tracking system: https://github.com/envmodules/modules/issues

* SourceForge project page: http://sourceforge.net/projects/modules/

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].

The project is also present on several social media platforms:

* X/Twitter: [@EnvModules][7]

* Mastodon: [@[email protected]][8]

* Bluesky: [@EnvModules.bsky.social][9]

Code of conduct

---------------

Please note that Modules has a [Code of conduct][10]. By participating in the

Modules community, you agree to abide by its rules.

Authors

-------

Modules current core developer and maintainer is Xavier Delaruelle,

[email protected]

Many thanks go to the [contributors][11] of the Modules project.

Acknowledgments

---------------

We would like to express our gratitude to [CEA][12] 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://x.com/EnvModules

[8]: https://mast.hpc.social/@EnvModules

[9]: https://bsky.app/profile/envmodules.bsky.social

[10]: CODE_OF_CONDUCT.md

[11]: https://github.com/envmodules/modules/graphs/contributors

[12]: https://www.cea.fr/english