6.2. Environment Modules

Environment Modulesの概要#

本サービスでは、利用可能なソフトウェア一覧に記載したコンパイラ、MPI、一部のプリインストールアプリケーションを「モジュール」として、組み合わせて利用できます。
Environment Modulesは、これらのモジュールを利用するのに必要な環境設定を柔軟かつ動的に行う機能を提供します。

利用方法#

利用者はmoduleコマンドを用いて環境の設定を行えます。

$ module [options] <sub-command> [sub-command options]

以下にサブコマンドを示します。

サブコマンド 説明
list ロード済みのモジュールの一覧表示
avail 利用可能なモジュールの一覧表示
show module module の設定内容の表示
load module module のロード
unload module module のアンロード
purge ロード済みのすべてのモジュールをアンロード(初期化)
help module module の使用方法の表示

利用例#

  • モジュールの一覧表示
$ module avail
---------------------------------------------------------- /fefs1/app/x86/intel/modulefiles ----------------------------------------------------------
advisor/2022.1.0        compiler/latest         dnnl-cpu-iomp/2023.0.0  icc32/2022.1.0              intel_ippcp_ia32/latest       oclfpga/2023.0.0
advisor/2023.0.0        compiler32/2022.1.0     dnnl-cpu-iomp/latest    icc32/2023.0.0              intel_ippcp_intel64/2021.6.0  oclfpga/latest
advisor/latest          compiler32/2023.0.0     dnnl-cpu-tbb/2022.1.0   icc32/latest                intel_ippcp_intel64/2021.6.3  tbb/2021.6.0
ccl/2021.6.0            compiler32/latest       dnnl-cpu-tbb/2023.0.0   init_opencl/2022.1.0        intel_ippcp_intel64/latest    tbb/2021.8.0
ccl/2021.8.0            dal/2021.6.0            dnnl-cpu-tbb/latest     init_opencl/2023.0.0        itac/2021.6.0                 tbb/latest
ccl/latest              dal/2023.0.0            dnnl/2022.1.0           init_opencl/latest          itac/2021.8.0                 tbb32/2021.6.0
clck/2021.6.0           dal/latest              dnnl/2023.0.0           inspector/2022.1.0          itac/latest                   tbb32/2021.8.0
clck/2021.7.2           debugger/2021.6.0       dnnl/latest             inspector/2023.0.0          mkl/2022.1.0                  tbb32/latest
clck/latest             debugger/2023.0.0       dpct/2022.1.0           inspector/latest            mkl/2023.0.0                  vpl/2022.1.0
compiler-rt/2022.1.0    debugger/latest         dpct/2023.0.0           intel_ipp_ia32/2021.6.0     mkl/latest                    vpl/2023.0.0
compiler-rt/2023.0.0    dev-utilities/2021.6.0  dpct/latest             intel_ipp_ia32/2021.7.0     mkl32/2022.1.0                vpl/latest
compiler-rt/latest      dev-utilities/2021.8.0  dpl/2021.7.0            intel_ipp_ia32/latest       mkl32/2023.0.0                vtune/2022.2.0
compiler-rt32/2022.1.0  dev-utilities/latest    dpl/2022.0.0            intel_ipp_intel64/2021.6.0  mkl32/latest                  vtune/2023.0.0
compiler-rt32/2023.0.0  dnnl-cpu-gomp/2022.1.0  dpl/latest              intel_ipp_intel64/2021.7.0  mpi/2021.6.0                  vtune/latest
compiler-rt32/latest    dnnl-cpu-gomp/2023.0.0  icc/2022.1.0            intel_ipp_intel64/latest    mpi/2021.8.0
compiler/2022.1.0       dnnl-cpu-gomp/latest    icc/2023.0.0            intel_ippcp_ia32/2021.6.0   mpi/latest
compiler/2023.0.0       dnnl-cpu-iomp/2022.1.0  icc/latest              intel_ippcp_ia32/2021.6.3   oclfpga/2022.1.0

---------------------------------------------------------- /fefs1/app/gpu/nvhpc/modulefiles ----------------------------------------------------------
nvhpc-byo-compiler/22.5  nvhpc-hpcx-cuda11/23.5  nvhpc-hpcx/23.5   nvhpc-nompi/23.5  nvhpc/23.5
nvhpc-byo-compiler/23.5  nvhpc-hpcx-cuda12/23.5  nvhpc-nompi/22.5  nvhpc/22.5

------------------------------------------------------------- /fefs1/app/arm/modulefiles -------------------------------------------------------------
development-studio/1.2.35  development-studio/1.2.37  development-studio/1.2.38  development-studio/1.2.39  gromacs/2021

------------------------------------------------------------- /fefs1/app/x86/modulefiles -------------------------------------------------------------
openfoam/v2212  openmpi/4.1.4/icc-2023.0.0  python/3.9.19

------------------------------------------------------------- /fefs1/app/gpu/modulefiles -------------------------------------------------------------
openmpi/5.0.2  python/3.9.19  quantum-espresso/7.0

モジュールの表示内容に関する留意事項

利用可能なモジュールは更新・変更される場合があります。最新の情報はログインノードにおいてmodule availコマンドを実行し、ご確認ください。

  • モジュールのロード
$ module load compiler/2023.0.0
Loading compiler version 2023.0.0
Loading tbb version 2021.8.0
Loading compiler-rt version 2023.0.0
Loading oclfpga version 2023.0.0
  Load "debugger" to debug DPC++ applications with the gdb-oneapi debugger.
  Load "dpl" for additional DPC++ APIs: https://github.com/oneapi-src/oneDPL
  
Loading compiler/2023.0.0
  Loading requirement: tbb/latest compiler-rt/latest oclfpga/latest
  • ロード済みモジュールの一覧表示
$ module list
Currently Loaded Modulefiles:
1) tbb/latest   2) compiler-rt/latest   3) oclfpga/latest   4) compiler/2023.0.0
  • モジュールの設定内容の表示
$ module show compiler/2023.0.0
-------------------------------------------------------------------
/fefs1/app/x86/intel/modulefiles/compiler/2023.0.0:
  
conflict        compiler32
conflict        compiler
module-whatis   {Configure for use with Intel 64-bit compiler(s).}
unsetenv        INTEL_TARGET_ARCH_IA32
setenv          CMPLR_ROOT /fefs1/app/x86/intel/oneapi/compiler/2023.0.0
  Load "debugger" to debug DPC++ applications with the gdb-oneapi debugger.
  Load "dpl" for additional DPC++ APIs: https://github.com/oneapi-src/oneDPL
append-path     OCL_ICD_FILENAMES /fefs1/app/x86/intel/oneapi/compiler/2023.0.0/linux/lib/x64/libintelocl.so
prepend-path    PATH /fefs1/app/x86/intel/oneapi/compiler/2023.0.0/linux/bin
prepend-path    PATH /fefs1/app/x86/intel/oneapi/compiler/2023.0.0/linux/bin/intel64
append-path     MANPATH /fefs1/app/x86/intel/oneapi/compiler/2023.0.0/documentation/en/man/common
prepend-path    CMAKE_PREFIX_PATH /fefs1/app/x86/intel/oneapi/compiler/2023.0.0/linux/IntelDPCPP
prepend-path    NLSPATH /fefs1/app/x86/intel/oneapi/compiler/2023.0.0/linux/compiler/lib/intel64_lin/locale/%l_%t/%N
prepend-path    DIAGUTIL_PATH /fefs1/app/x86/intel/oneapi/compiler/2023.0.0/sys_check/sys_check.sh
-------------------------------------------------------------------
  • ロード済みのすべてのモジュールをアンロード(初期化)
$ module purge
Removing compiler version 2023.0.0
Use `module list` to view any remaining dependent modules.
  Load "debugger" to debug DPC++ applications with the gdb-oneapi debugger.
  Load "dpl" for additional DPC++ APIs: https://github.com/oneapi-src/oneDPL
Removing oclfpga version 2023.0.0
Use `module list` to view any remaining dependent modules.
Removing compiler-rt version 2023.0.0
Use `module list` to view any remaining dependent modules.
Removing tbb version 2021.8.0
Use `module list` to view any remaining dependent modules.