Modules: Usage Example

Creating and Using Ecosystem

Flight Env provides quick setup methods to create a modules software ecosystem.

To install and use modules:

  • Activate the flight system

  • Create the modules installation for the user:

    [flight@gateway1 ~]$ flight env create modules
    Creating environment modules@default
       > ✅ Verifying prerequisites
       > ✅ Fetching prerequisite (modules)
       > ✅ Extracting prerequisite (modules)
       > ✅ Building prerequisite (modules)
       > ✅ Installing prerequisite (modules)
       > ✅ Creating environment (modules@default)
    Environment modules@default has been created
    
  • Activate the modules ecosystem:

    [flight@gateway1 ~]$ flight env activate modules
    <modules> [flight@gateway1 ~]$
    
  • Check that modules can be run:

    <modules> [flight@gateway1 ~]$ module --version
    Modules Release 4.3.0 (2019-07-26)
    

Installing Software - General Overview

Unlike the other package ecosystems, modules provides the ecosystem management tool but not any package management tools. Therefore, with the modules ecosystem, you are free to compile and install software in a module compatible manner.

Module files can be installed to ~/.local/share/flight/env/modules+default/modulefiles (for local modules ecosystems) or to /opt/apps/flight/env/modules+global/modulefiles (for global modules ecosystems).

Note

If the modules ecosystem has been installed with a custom ecosystem name then the path will not be modules+default/modules+global but instead modules+mycustomname

For more information on building software for modules, see the modulefile reference and build documentation for the chosen software.

Installing and Running Perl

Compile Perl from Source

  • Download perl 5.30.1 source:

    <modules> [flight@gateway1 ~]$ wget https://www.cpan.org/src/5.0/perl-5.30.1.tar.gz
    
  • Decompress the source files:

    <modules> [flight@gateway1 ~]$ tar -xzf perl-5.30.1.tar.gz
    
  • Configure the software to install to a localperl directory:

    <modules> [flight@gateway1 ~]$ cd perl-5.30.1
    <modules> [flight@gateway1 ~]$ ./Configure -des -Dprefix=$HOME/localperl
    
  • Compile and install perl:

    <modules> [flight@gateway1 ~]$ make
    <modules> [flight@gateway1 ~]$ make install
    

Create Modulefile and Test

  • Create the perl modulefile:

    <modules> [flight@gateway1 ~]$ cat << EOF > ~/.local/share/flight/env/modules+default/modulefiles/perl-5.30.1
    #%Module1.0
    proc ModulesHelp { } {
    global dotversion
    
    puts stderr "\tPerl 5.30.1"
    }
    
    module-whatis "Perl 5.30.1"
    conflict perl
    prepend-path PATH ~/localperl/bin
    prepend-path LD_LIBRARY_PATH ~/localperl/lib
    prepend-path LIBRARY_PATH ~/localperl/lib
    prepend-path MANPATH ~/localperl/man
    EOF
    
  • Check install location:

    <modules> [flight@gateway1 ~]$ module load perl-5.30.1
    <modules> [flight@gateway1 ~]$ which perl
    ~/localperl/bin/perl
    
  • Install perl library (this may prompt for initial cpan configuration, once configuration is complete then the library will be installed):

    <modules> [flight@gateway1 ~]$ cpan File::Slurp
    Loading internal logger. Log::Log4perl recommended for better logging
    Reading '/home/flight/.cpan/Metadata'
      Database was generated on Wed, 11 Mar 2020 15:29:03 GMT
    <-- snip -->
    Appending installation info to /home/flight/localperl/lib/5.30.1/x86_64-linux/perllocal.pod
      CAPOEIRAB/File-Slurp-9999.30.tar.gz
      /usr/bin/make install  -- OK
    
  • Check installation worked:

    <modules> [flight@gateway1 ~]$ cpan File::Slurp
    Loading internal logger. Log::Log4perl recommended for better logging
    Reading '/home/flight/.cpan/Metadata'
      Database was generated on Wed, 11 Mar 2020 15:29:03 GMT
    File::Slurp is up to date (9999.30).