HPC/Module naming scheme 2016: Difference between revisions
mNo edit summary |
|||
Line 17: | Line 17: | ||
|} | |} | ||
=== | == Configuration steps == | ||
To switch over to hierarchical names on both CentOS releases it's easiest to place all choices in <code>~/.bashrc</code>. | === CentOS-independent module selection (recommended) === | ||
To switch over to hierarchical names on both CentOS releases it's easiest to place all your choices in <code>~/.bashrc</code>. | |||
# Create a customization file for new names, but leave it empty (you'll configure your choices in the next step). Use the command: <source lang="bash">touch ~/.modules-carbon-2</source> | # Create a customization file for new names, but leave it empty (you'll configure your choices in the next step). Use the command: <source lang="bash">touch ~/.modules-carbon-2</source> | ||
Line 25: | Line 26: | ||
#* To insist on a specific version using new-style names, append <code>…''/mpiname/compilername/version''</code> as needed. To see available flavors and versions, separately run the command <code>module avail ''name''</code>. | #* To insist on a specific version using new-style names, append <code>…''/mpiname/compilername/version''</code> as needed. To see available flavors and versions, separately run the command <code>module avail ''name''</code>. | ||
=== | === CentOS-dependent module selection === | ||
If you encounter difficulties with making your module selection work in both CentOS-5 and CentOS-6, use separate configurations: | If you encounter difficulties with making your module selection work in both CentOS-5 and CentOS-6, use separate configurations: | ||
# Move all your previous module commands from <code>.bashrc</code> to <code>~/.modules-carbon-1</code>, where they apply only | # Move all your previous module commands from <code>.bashrc</code> to <code>~/.modules-carbon-1</code>, where they will apply only on CentOS-5. | ||
# Place all your module | # Place all your module selections for CentOS-6 in <code>~/.modules-carbon-2</code>. Copy and edit from the .*-1 file. | ||
== Hints == | |||
=== Module Dependencies === | === Module Dependencies === | ||
New-style modules are less implicit (less automatic) in loading | New-style modules are less implicit (less automatic) in loading modules that they depend on. This means prior to loading a more advanced module you must load all its prerequisites, chosen from the same MPI and (usually) compiler flavor as the advanced module. A missing prerequisite will give errors of the form | ||
… ERROR:151: '''Module''' 'troubled_name' '''depends on one of the module(s)''' 'other_name1 other_name2' … | … ERROR:151: '''Module''' 'troubled_name' '''depends on one of the module(s)''' 'other_name1 other_name2' … | ||
To resolve this error, edit your <code>~/.bashrc</code> or <code>.modules-carbon-2</code> file and add <code>module load …</code> commands for the needed module(s) ''other_names'' before loading "troubled_name". | To resolve this error, edit your <code>~/.bashrc</code> or <code>.modules-carbon-2</code> file and add <code>module load …</code> commands for the needed module(s) ''other_names'' before loading "troubled_name". | ||
=== System defaults === | |||
By default, on Carbon the Intel compilers and the OpenMPI flavor of MPI continue to be pre-loaded for you. In other words, without any module customization, you'd see from the <code>module list</code> command: | |||
<source lang="bash"> | |||
module list | |||
</source> | |||
Currently Loaded Modulefiles: | |||
1) intel/15/15.0.2 2) openmpi/1.4/INTEL/1.4.5-intel12-2 | |||
You can now safely use the command | |||
<source lang="bash"> | |||
module purge | |||
</source> | |||
=== Name Completion === | === Name Completion === |
Revision as of 19:53, August 10, 2015
You have files | Remark | CentOS-5 uses | CentOS-6 uses | |||
---|---|---|---|---|---|---|
names | files | names | files | |||
– | – | current situation | old | .bashrc only | new | .bashrc only |
.modules-carbon-1 | – | avoid | old | .modules-carbon-1 and .bashrc | .bashrc only (.*-1 file is ignored) | |
– | .modules-carbon-2 | switch over, recommended | new | .modules-carbon-2 and .bashrc | .modules-carbon-2 and .bashrc | |
.modules-carbon-1 | .modules-carbon-2 | for advanced cases | old | .modules-carbon-1 and .bashrc | .modules-carbon-2 and .bashrc |
Configuration steps
CentOS-independent module selection (recommended)
To switch over to hierarchical names on both CentOS releases it's easiest to place all your choices in ~/.bashrc
.
- Create a customization file for new names, but leave it empty (you'll configure your choices in the next step). Use the command:
touch ~/.modules-carbon-2
- Edit your
.bashrc
file and update your module selections as follows:- Remove version numbers from module names of the old-style
name/version
, leaving onlyname
. This is the recommended approach, as you will automatically benefit from future upgrades. - To insist on a specific version using new-style names, append
…/mpiname/compilername/version
as needed. To see available flavors and versions, separately run the commandmodule avail name
.
- Remove version numbers from module names of the old-style
CentOS-dependent module selection
If you encounter difficulties with making your module selection work in both CentOS-5 and CentOS-6, use separate configurations:
- Move all your previous module commands from
.bashrc
to~/.modules-carbon-1
, where they will apply only on CentOS-5. - Place all your module selections for CentOS-6 in
~/.modules-carbon-2
. Copy and edit from the .*-1 file.
Hints
Module Dependencies
New-style modules are less implicit (less automatic) in loading modules that they depend on. This means prior to loading a more advanced module you must load all its prerequisites, chosen from the same MPI and (usually) compiler flavor as the advanced module. A missing prerequisite will give errors of the form
… ERROR:151: Module 'troubled_name' depends on one of the module(s) 'other_name1 other_name2' …
To resolve this error, edit your ~/.bashrc
or .modules-carbon-2
file and add module load …
commands for the needed module(s) other_names before loading "troubled_name".
System defaults
By default, on Carbon the Intel compilers and the OpenMPI flavor of MPI continue to be pre-loaded for you. In other words, without any module customization, you'd see from the module list
command:
module list
Currently Loaded Modulefiles: 1) intel/15/15.0.2 2) openmpi/1.4/INTEL/1.4.5-intel12-2
You can now safely use the command
module purge
Name Completion
When working interactively in a terminal, you can use a "completion" feature of the Bash shell to complete a partially typed module name and show all names available for the name typed so far. For example:
At a shell prompt (shown as "$"), type:
$ module load fft
Press the <TAB>
key and the name will be expanded to fftw3/
and you'll see two possible completing names, with the cursor waiting at the end of the longest common substring:
$ module load fftw3/_ fftw3/INTEL/3.3.2-1 fftw3/OPENMPI-1.4/INTEL/3.3.2-4
Type the letter O
, hit the <TAB>
key again, and the now single complete name will be completed, with the cursor waiting after an additional space character:
$ module load fftw3/O<TAB> $ module module load fftw3/OPENMPI-1.4/INTEL/3.3.2-4 _