Back to main "Getting Started" document

Customizing Your Environment With the Module Command

Each user can customize their environment using the module command. This command lets you select software and will source the appropriate paths and libraries. All the requested user applications are located under the /opt/apps directory.

To list what applications are available, use the spider sub command:

$ module spider

--------------------------------------------------------------------
The following is a list of the modules currently available:
--------------------------------------------------------------------
  4ti2: 4ti2/1.6.9
    A software package for algebraic, geometric and combinatorial problems on linear spaces

  ACTC: ACTC/1.1
    ACTC converts independent triangles into triangle strips or fans.

  AFNI: AFNI/20150603
    Free software for analysis and display of FMRI data - Homepage: http://afni.nimh.nih.gov

...
--------------------------------------------------------------------

To learn more about a package execute:

   $ module spider Foo

where "Foo" is the name of a module.

To find detailed information about a particular package you
must specify the version if there is more than one version:

   $ module spider Foo/11.1

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

To see a description of a specific package, use the spider sub command again:

$ module spider OpenMPI/4.1.1

-----------------------------------
  OpenMPI: OpenMPI/4.1.1
-----------------------------------
    Description:
      The Open MPI Project is an open source MPI-3 implementation.

    You will need to load all module(s) on any one of the lines below before the "OpenMPI/4.1.1" module is available to load.

      GCC/10.3.0

    Help:

      Description
      ===========

      The Open MPI Project is an open source MPI-3 implementation.      

      More information
      ================
       - Homepage: https://www.open-mpi.org/

To load the module for OpenMPI built with the GCC compilers, for example, use the load sub command:

$ module load GCC OpenMPI

To see a list of modules that you have loaded, use the list sub command:

$ module list

To change to the Intel compiler build of OpenMPI use the swap sub command:

$ module swap GCC icc

Due to MODULEPATH changes the following have been reloaded:
  1) OpenMPI/1.8.4

To unload all of your modules, use this command:

$ module purge

To make sure a set of modules are loaded automatically at login, use the module save sub command:

$ module load GCC OpenMPI
$ module save

$ module load Boost
Lmod has detected the following error:  These module(s) exist but cannot be loaded as requested: "Boost"
   Try: "module spider Boost" to see how to load the module(s).

$ module spider Boost

-------------------------------------------
  Boost:
---------------------------------------------
    Description:
      Boost provides free peer-reviewed portable C++ source libraries.

     Versions:
        Boost/1.58.0
        Boost/1.61.0
      Boost/1.63.0
        Boost/1.64.0
        Boost/1.66.0
        Boost/1.67.0
        Boost/1.68.0
        Boost/1.69.0
        Boost/1.70.0
        Boost/1.71.0
        Boost/1.72.0

-----------------------------------------
  For detailed information about a specific "Boost" module (including how to load the modules) use the module's full name.
  For example:

     $ module spider Boost/1.72.0
----------------------------------------

$ module load Boost/1.72.0
Lmod has detected the following error:  These module(s) exist but cannot be loaded as requested: "Boost/1.72.0"
   Try: "module spider Boost/1.72.0" to see how to load the module(s).

$ module spider Boost/1.72.0

---------------------------------------
  Boost: Boost/1.72.0
---------------------------------------
    Description:
      Boost provides free peer-reviewed portable C++ source libraries.

    You will need to load all module(s) on any one of the lines below before the "Boost/1.72.0" module is available to load.

      GCC/9.3.0  CUDA/11.0.182  OpenMPI/4.0.3
      GCC/9.3.0  OpenMPI/4.0.3
      iccifort/2020.1.217  CUDA/11.0.182  OpenMPI/4.0.3
      iccifort/2020.1.217  impi/2019.7.217 

    Help:

      Description
      ===========

      Boost provides free peer-reviewed portable C++ source libraries. 

      More information
      ================
       - Homepage: https://www.boost.org/

$ module load GCC/9.3.0  OpenMPI/4.0.3 

$ module load Boost/1.72.0

Anaconda Alternatives

Note that Anaconda modules are no longer installed on NOTS.  Alternative modules are:

• Miniforge3/24.1.2-0 - provides the same conda command as Anaconda, without the huge "base" environment
• Mamba/23.11.0-0 - provides the mamba command, which works identically to conda, but can be faster to calculate package dependencies

Both commands obtain packages from the conda-forge channel by default.  You can create Python environments with either module, using commands such as:

conda create -n myenvironment numpy pandas

or

mamba create -n myenvironment numpy pandas

If you have trouble porting your existing environments with these modules, please let us know.