254:
196:
74:
33:
133:
337:
The key advantage of
Environment Modules is that it is shell independent and supports all major shells such as bash, ksh, zsh, sh, tcsh, and csh. The second key advantage is that it allows to use multiple versions of the program or package from the same account by just loading proper module. Those
439:
The default modulefiles directory is empty initially. Copy the null module to the default modulefiles directory to have it shown by "module avail". The following uses the null and module-info modules to show use of a version file within a hierarchical organization and their effect on module avail
668:
directory that make modules initialization part of the default shell initialization. One of the advantages of
Environment Modules is a single modulefile that supports bash, ksh, zsh, sh as well as tcsh and csh shell users for environment setup and initialization. This makes managing complex
895:
Although installing from a Linux distributions repository using that distributions update manager is the easiest the software can be installed from source. Resolve dependencies is the most difficult task for an installation from source. The typical configure, make, install cycle can become
320:
Modules has been around since the early 1990s and is used at some of the largest computer centers to deploy multiple versions of different software tools to users. The
National Energy Research Scientific Computing Center (NERSC) reports that they use Environment Modules to manage nearly all
435:
The commands in this section require read/write/execute access to the /etc/modulefiles directory. The $ HOME/privatemodules or another directory can be used instead along with "module use --append" or modification of the configuration file specifying the default modules search path.
341:
modulefiles are created on per application per version basis. They can be dynamically loaded, unloaded, or switched. Along with the capability of using multiple versions of the same software it also can be used to implement site policies regarding the access and use of applications.
329:
The modules system is based on modulefiles, which specify groups of environment settings that need to be made together. Modulefiles can be installed in a central location for general use, or in a user directory for personal use. Environment
Modules modulefiles are written in the
321:
software. Environment
Modules is specified as a Baseline Configuration requirement of the DoD High Performance Computing Modernization Program (HPCMP) Project Baseline Configuration team for participating DoD Supercomputing Resource Centers (DSRCs).
338:
two advantages were instrumental in making
Environment Modules a part of most HPC cluster setups. It also inspired several alternative implementation such as lmod from University of Texas, which is written in Lua instead of TCL.
896:
painfully slow as each configure improvement reveals another dependency not available in your default environment. This section includes the steps to install the
Environment Modules package on source including compiling the
46:
1138:
1032:
1082:
923:
they do not include a development package with the configuration files required to build
Environment Modules on Linux from source. Building
861:
On
Scientific Linux, CentOS, and RHEL distributions Environment Modules is in the environment-modules package which can be installed with:
1283:
52:
175:
60:
143:
84:
1168:
1006:
233:
207:
381:
directory used by some distributions (or any other directory) can be used after a build from source by modifying the
1022:
656:
Environment
Modules on Scientific Linux, CentOS, and RHEL distributions in the environment-modules package include
281:
317:
shell environment, by allowing groups of related environment-variable settings to be made or removed dynamically.
1015:― The National Institute for Computational Sciences at Oak Ridge National Laboratory ― Department of Energy
1304:
848:
file in the 3.2.10 modules build directory can enable automatic modules initialization for these users.
1112:
1146:
1018:
1090:
904:
1288:
1012:
276:
264:
1145:. DoD High Performance Computing Modernization Program (HPCMP). 20 Mar 2008. Archived from
253:
195:
1009:. The Extreme Science and Engineering Discovery Environment ― National Science Foundation
1262:
1053:
350:
The default modules search path is in a hidden configuration file you can display with:
1266:
Proceedings of the Fifth Large Installation Systems Administration Conference (LISA V)
1061:
Proceedings of the Fifth Large Installation Systems Administration Conference (LISA V)
95:
1298:
1199:
802:
file from the 3.2.10 modules build directory to the system initialization directory:
1176:
1089:. Oak Ridge National Laboratory - Department of Energy. 22 May 2011. Archived from
17:
1291:- SNUB Boston 2001 - Erich Whitney, Axiowave Networks, Mark Sprague, ATI Research
1226:
931:
542:--------------------------- /home/user/privatemodules --------------------------
536:------------------------------- /etc/modulefiles -------------------------------
530:-------------------- /usr/local/Modules/3.2.10/modulefiles ---------------------
878:
On Ubuntu or systems using apt-get, Environment Modules can be installed with:
1289:
Drag your design environment kicking and screaming into the '90s with Modules!
1175:. DoD High Performance Computing Modernization Program (HPCMP). Archived from
1169:"DoD High Performance Computing Modernization Program Baseline Configuration"
672:
For a source build the automation for all users can be manually configured.
334:
and are interpreted by the modulecmd program via the module user interface.
269:
464:/modulefiles/module-info/etc/modulefiles/test/1.0 moduleavail moduleshow
521:
After the above following a fresh install from source you would see:
242:
813:
Add a version 3.2.10 symbolic link for the above generic addresses:
646:-------------------------------------------------------------------
571:-------------------------------------------------------------------
564:-------------------------------------------------------------------
555:-------------------------------------------------------------------
533:
dot module-git module-info modules null use.own
1277:
1268:, pp. 141–152, San Diego, CA, September 30 - October 3, 1991.
1255:
314:
292:
1200:"modulefile - files containing Tcl code for the Modules package"
1117:
The National Energy Research Scientific Computing Center (NERSC)
310:
1271:
1001:
924:
920:
912:
897:
331:
126:
67:
26:
514:>>/etc/modulefiles/test/.version moduleavail moduleshow
488:>>/etc/modulefiles/test/.version moduleavail moduleshow
1139:"Use of Modules for Accessing Multiple Versions of Software"
954:/usr/local/src/tcl8.6.1 unix/configure make sudomakeinstall
884:
Once installed the package information can be viewed with:
867:
Once installed the package information can be viewed with:
107:
874:
Installing Environment Modules on Linux using apt and dpkg
809:
sudocpetc/global/profile.modules/etc/profile.d/modules.sh
372:/usr/local/Modules/modulefiles # Build from source default
99:
970:/usr/local/src tar-xvzf~/Downloads/modules-3.2.10.tar.gz
857:
Installing Environment Modules on Linux using yum and rpm
1087:
The National Institute for Computational Sciences (NICS)
870:
rpm -qi environment-modules rpm -ql environment-modules
577:
module-whatis returns all various module-info values
103:
943:/usr/local/src tar-xvzf~/Downloads/tcl8.6.1-src.tar.gz
150:
91:
1119:. Office of Science - Department of Energy. 2014-02-07
1274:- alternative implementation using LUA instead of Tcl
539:
null test/1.0 test/2.0(default)
431:
Use a version file within a hierarchical organization
1028:
927:
from source will make the required files available.
1227:"module - command interface to the Modules package"
1052:Furlani, John L. (September 30 – October 3, 1991).
959:
3.2.10 version of modules built from /usr/local/src
919:Although the PCLinuxOS 64-bit repositories include
891:
Installing Environment Modules on Linux from source
676:
bash, ksh, zsh, sh automatic modules initialization
287:
275:
263:
232:
206:
1225:John L. Furlani & Peter W. Osel (July 2009).
1198:John L. Furlani & Peter W. Osel (July 2009).
496:Switch to the newer version as the default with:
369:/etc/modulefiles # CentOS, Scientific Linux, RHEL
1054:"Modules: Providing a Flexible User Environment"
1031:― Package Manager for HPC Software developed at
1258:- home page for the Environment Modules project
643:+++++++++++++++++++++++++++++++++++++++++++++++
628:library = /usr/local/lib/tcl8.6
616:+++ info ++++++++++++++++++++++++++++++++++++++
580:+++ module-info +++++++++++++++++++++++++++++++
1263:Modules: Providing a Flexible User Environment
1083:"NICS User Support Kraken Modules Description"
932:http://sourceforge.net/projects/tcl/files/Tcl/
454:/modulefiles/null/etc/modulefiles/test/2.0 cp
8:
687:file in the 3.2.10 modules build directory.
512:'set ModulesVersion "2.0"'
486:'set ModulesVersion "1.0"'
309:system is a tool to help users manage their
188:
61:Learn how and when to remove these messages
836:tcsh, csh automatic modules initialization
252:
194:
187:
1280:- alternative implementation using C only
881:sudo apt-get install environment-modules
561:module-whatis does absolutely nothing
400:module essentially performs these steps:
176:Learn how and when to remove this message
1284:PennState Environment Modules User Guide
1044:
85:instructions, advice, or how-to content
1033:Lawrence Livermore National Laboratory
471:Set the first version as the default:
864:sudo yum install environment-modules
733:./usr/local/Modules/default/init/bash
669:environments a bit less complicated.
7:
1113:"NERSC Modules Software Environment"
765:./usr/local/Modules/default/init/zsh
749:./usr/local/Modules/default/init/ksh
282:GNU General Public License#Version 2
213:5.4.0 / February 20, 2024
773:./usr/local/Modules/default/init/sh
619:hostname = localhost
507:>/etc/modulefiles/test/.version
481:>/etc/modulefiles/test/.version
94:so that it is more encyclopedic or
989:"-DUSE_INTERP_ERRORLINE"
604:user = advanced
601:version = test/1.0
592:specified = test/1.0
589:name = test/1.0
25:
991:./configure make sudomakeinstall
963:Extract source after downloading
936:Extract source after downloading
613:symbols = *undef*
586:mode = display
500:rm/etc/modulefiles/test/.version
422:/privatemodules moduleuse--append
383:$ {MODULESHOME}/init/.modulespath
153:and remove advice or instruction.
42:This article has multiple issues.
652:Automatic modules initialization
389:Add your own modules to the path
131:
72:
31:
1278:http://www.lysator.liu.se/cmod/
1256:http://modules.sourceforge.net/
640:patchlevel = 8.6.1
50:or discuss these issues on the
981:/usr/local/src/modules-3.2.10
905:Installing Environment Modules
595:shell = bash
1:
900:from source as a dependency.
637:tclversion = 8.6
634:sharedlibextension = .so
610:tracepat = -.*
444:mkdir/etc/modulefiles/test cp
346:Default modulefiles directory
887:dpkg -L environment-modules
598:shelltype = sh
395:$ {MODULESHOME}/modulefiles/
1272:http://lmod.sourceforge.net
1007:Xsede Software Environments
921:Tcl (Tool Command Language)
913:Tcl (Tool Command Language)
898:Tcl (Tool Command Language)
625:loaded null = 0
622:level = 1
607:trace = 0
583:flags = 2
332:Tcl (Tool Command Language)
1321:
846:etc/global/profile.modules
842:/etc/profile.d/modules.csh
800:etc/global/profile.modules
685:etc/global/profile.modules
574:/etc/modulefiles/test/1.0:
558:/etc/modulefiles/test/2.0:
974:Configure, make, install
947:Configure, make, install
915:built from /usr/local/src
681:/etc/profile.d/modules.sh
631:nameofexecutable =
228:
202:
193:
1063:. San Diego, CA: 141–152
1013:NICS Modules Description
976:
965:
949:
938:
815:
804:
689:
523:
498:
473:
442:
402:
352:
1173:Baseline Configuration
1143:Baseline Configuration
215:; 7 months ago
844:symbolic link to the
1025:-based module system
151:rewrite this article
1179:on 22 February 2014
1149:on 22 February 2014
1093:on 22 February 2014
852:Installing on Linux
823:/usr/local/Modules
569:moduleshowtest/1.0
492:moduleshowtest/2.0
367:/init/.modulespath
307:Environment Modules
190:
189:Environment Modules
92:rewrite the content
18:Modules Environment
505:'#%Module'
479:'#%Module'
408:/privatemodules cp
1261:John L. Furlani,
911:8.6.1 version of
440:and module show:
418:/modulefiles/null
303:
302:
186:
185:
178:
168:
167:
144:a manual or guide
125:
124:
65:
16:(Redirected from
1312:
1243:
1242:
1240:
1238:
1222:
1216:
1215:
1213:
1211:
1195:
1189:
1188:
1186:
1184:
1165:
1159:
1158:
1156:
1154:
1135:
1129:
1128:
1126:
1124:
1109:
1103:
1102:
1100:
1098:
1079:
1073:
1072:
1070:
1068:
1058:
1049:
990:
987:
984:
980:
969:
953:
942:
847:
843:
830:
826:
822:
819:
808:
801:
794:
791:
788:
785:
782:
779:
776:
772:
768:
764:
760:
756:
752:
748:
744:
740:
736:
732:
728:
724:
720:
717:
714:
711:
708:
705:
702:
699:
696:
693:
686:
682:
667:
664:scripts for the
663:
659:
647:
644:
641:
638:
635:
632:
629:
626:
623:
620:
617:
614:
611:
608:
605:
602:
599:
596:
593:
590:
587:
584:
581:
578:
575:
572:
568:
565:
562:
559:
556:
553:
549:
546:
543:
540:
537:
534:
531:
527:
517:
513:
510:
506:
503:
491:
487:
484:
480:
477:
467:
463:
460:
457:
453:
450:
447:
426:/privatemodules
425:
421:
417:
414:
411:
407:
399:
384:
380:
379:/etc/modulefiles
373:
370:
366:
363:
360:
356:
299:
296:
294:
265:Operating system
256:
251:
248:
246:
244:
223:
221:
216:
198:
191:
181:
174:
163:
160:
154:
142:is written like
135:
134:
127:
120:
117:
111:
76:
75:
68:
57:
35:
34:
27:
21:
1320:
1319:
1315:
1314:
1313:
1311:
1310:
1309:
1295:
1294:
1252:
1247:
1246:
1236:
1234:
1224:
1223:
1219:
1209:
1207:
1197:
1196:
1192:
1182:
1180:
1167:
1166:
1162:
1152:
1150:
1137:
1136:
1132:
1122:
1120:
1111:
1110:
1106:
1096:
1094:
1081:
1080:
1076:
1066:
1064:
1056:
1051:
1050:
1046:
1041:
998:
993:
992:
988:
985:
982:
978:
972:
971:
967:
961:
956:
955:
951:
945:
944:
940:
917:
893:
888:
882:
876:
871:
865:
859:
854:
845:
841:
838:
833:
832:
828:
824:
820:
817:
811:
810:
806:
799:
796:
795:
792:
789:
786:
783:
780:
777:
774:
770:
766:
762:
758:
754:
750:
746:
742:
738:
734:
730:
726:
722:
718:
715:
712:
709:
706:
703:
700:
697:
694:
691:
684:
680:
678:
665:
661:
657:
654:
649:
648:
645:
642:
639:
636:
633:
630:
627:
624:
621:
618:
615:
612:
609:
606:
603:
600:
597:
594:
591:
588:
585:
582:
579:
576:
573:
570:
566:
563:
560:
557:
554:
551:
547:
544:
541:
538:
535:
532:
529:
525:
519:
518:
515:
511:
508:
504:
501:
494:
493:
489:
485:
482:
478:
475:
469:
468:
465:
461:
458:
455:
451:
448:
445:
433:
428:
427:
423:
419:
415:
412:
409:
405:
394:
391:
382:
378:
375:
374:
371:
368:
364:
361:
358:
354:
348:
327:
291:
259:
241:
224:
219:
217:
214:
182:
171:
170:
169:
164:
158:
155:
148:
136:
132:
121:
115:
112:
89:
77:
73:
36:
32:
23:
22:
15:
12:
11:
5:
1318:
1316:
1308:
1307:
1297:
1296:
1293:
1292:
1286:
1281:
1275:
1269:
1259:
1251:
1250:External links
1248:
1245:
1244:
1217:
1190:
1160:
1130:
1104:
1074:
1043:
1042:
1040:
1037:
1036:
1035:
1026:
1016:
1010:
1004:
997:
994:
977:
966:
960:
957:
950:
939:
916:
909:
908:
907:
892:
889:
886:
880:
875:
872:
869:
863:
858:
855:
853:
850:
837:
834:
816:
805:
690:
677:
674:
666:/etc/profile.d
653:
650:
524:
499:
474:
443:
432:
429:
403:
390:
387:
353:
347:
344:
326:
323:
301:
300:
289:
285:
284:
279:
273:
272:
267:
261:
260:
258:
257:
238:
236:
230:
229:
226:
225:
212:
210:
208:Stable release
204:
203:
200:
199:
184:
183:
166:
165:
139:
137:
130:
123:
122:
80:
78:
71:
66:
40:
39:
37:
30:
24:
14:
13:
10:
9:
6:
4:
3:
2:
1317:
1306:
1305:Unix software
1303:
1302:
1300:
1290:
1287:
1285:
1282:
1279:
1276:
1273:
1270:
1267:
1264:
1260:
1257:
1254:
1253:
1249:
1232:
1228:
1221:
1218:
1205:
1201:
1194:
1191:
1178:
1174:
1170:
1164:
1161:
1148:
1144:
1140:
1134:
1131:
1118:
1114:
1108:
1105:
1092:
1088:
1084:
1078:
1075:
1062:
1055:
1048:
1045:
1038:
1034:
1030:
1027:
1024:
1020:
1017:
1014:
1011:
1008:
1005:
1003:
1000:
999:
995:
975:
964:
958:
948:
937:
934:
933:
928:
926:
922:
914:
910:
906:
903:
902:
901:
899:
890:
885:
879:
873:
868:
862:
856:
851:
849:
835:
831:.2.10default
814:
803:
688:
675:
673:
670:
651:
522:
497:
472:
441:
437:
430:
401:
398:
388:
386:
351:
345:
343:
339:
335:
333:
324:
322:
318:
316:
312:
308:
298:
290:
286:
283:
280:
278:
274:
271:
268:
266:
262:
255:
250:
240:
239:
237:
235:
231:
227:
211:
209:
205:
201:
197:
192:
180:
177:
162:
159:February 2015
152:
147:
145:
140:This article
138:
129:
128:
119:
116:February 2015
109:
105:
101:
97:
93:
87:
86:
81:This article
79:
70:
69:
64:
62:
55:
54:
49:
48:
43:
38:
29:
28:
19:
1265:
1235:. Retrieved
1230:
1220:
1208:. Retrieved
1203:
1193:
1181:. Retrieved
1177:the original
1172:
1163:
1151:. Retrieved
1147:the original
1142:
1133:
1121:. Retrieved
1116:
1107:
1095:. Retrieved
1091:the original
1086:
1077:
1065:. Retrieved
1060:
1047:
973:
962:
946:
935:
930:Tcl Source:
929:
918:
894:
883:
877:
866:
860:
839:
812:
797:
695:""
679:
671:
655:
528:moduleavail
520:
495:
470:
438:
434:
396:
392:
376:
349:
340:
336:
328:
319:
306:
304:
295:.sourceforge
172:
156:
149:Please help
141:
113:
90:Please help
82:
58:
51:
45:
44:Please help
41:
1231:SourceForge
1204:SourceForge
1123:19 February
658:modules.csh
459:MODULESHOME
449:MODULESHOME
413:MODULESHOME
362:MODULESHOME
325:modulefiles
100:Wikiversity
1237:9 February
1233:. man page
1210:9 February
1206:. man page
1183:9 February
1153:9 February
1097:9 February
1067:9 February
1039:References
662:modules.sh
550:moduleshow
234:Repository
220:2024-02-20
108:Wikivoyage
47:improve it
827:sudoln-sT
798:Copy the
778:# default
683:from the
270:Unix-like
104:Wikibooks
83:contains
53:talk page
1299:Category
996:See also
983:CPPFLAGS
249:/modules
247:/cea-hpc
397:use.own
293:modules
288:Website
277:License
218: (
729:*/bash
716:"
710:"
424:$ HOME
420:$ HOME
406:$ HOME
385:file.
243:github
98:it to
1057:(PDF)
1029:Spack
761:*/zsh
745:*/ksh
721:-bash
404:mkdir
315:Linux
106:, or
1239:2014
1212:2014
1185:2014
1155:2014
1125:2014
1099:2014
1069:2014
1019:Lmod
784:trap
781:esac
753:-zsh
737:-ksh
725:bash
707:case
692:trap
660:and
552:test
545:null
516:test
509:echo
502:echo
490:test
483:echo
476:echo
466:test
393:The
377:The
311:Unix
305:The
297:.net
245:.com
96:move
1023:Lua
1002:Tcl
925:Tcl
825:$
818:$
807:$
757:zsh
741:ksh
713:$ 0
567:$
548:$
526:$
456:$ {
446:$ {
410:$ {
359:$ {
357:cat
355:$
313:or
1301::
1229:.
1202:.
1171:.
1141:.
1115:.
1085:.
1059:.
1021:―
979:cd
968:cd
952:cd
941:cd
840:A
821:cd
775:;;
767:;;
751:;;
735:;;
719:in
102:,
56:.
1241:.
1214:.
1187:.
1157:.
1127:.
1101:.
1071:.
986:=
829:3
793:3
790:2
787:1
771:)
769:*
763:)
759:|
755:|
747:)
743:|
739:|
731:)
727:|
723:|
704:3
701:2
698:1
462:}
452:}
416:}
365:}
222:)
179:)
173:(
161:)
157:(
146:.
118:)
114:(
110:.
88:.
63:)
59:(
20:)
Text is available under the Creative Commons Attribution-ShareAlike License. Additional terms may apply.
