Difference between revisions of "Software:Frontenac"
(Created page with "The Frontenac cluster includes a wide variety of software and compilers. There are several new ways of accessing and using software, which are documented here. For a list of s...") |
|||
| Line 1: | Line 1: | ||
The Frontenac cluster includes a wide variety of software and compilers. There are several new ways of accessing and using software, which are documented here. For a list of software available on the SW cluster, please see [[Software:Application|our SW software page]]. | The Frontenac cluster includes a wide variety of software and compilers. There are several new ways of accessing and using software, which are documented here. For a list of software available on the SW cluster, please see [[Software:Application|our SW software page]]. | ||
| + | |||
| + | = The "module" system = | ||
| + | |||
| + | Frontenac uses a new method of loading software compared to the SW cluster, the Lmod modules system. We have switched to this system to ensure consistency with other Compute Canada systems and provide a better user interface to our software. The modules system uses more or less the same concepts as the "use" system in use on the SW cluster. | ||
| + | |||
| + | On a large compute cluster, it is impossible to have all sets of software loaded all the time by default. Some software has multiple versions, some packages conflict with each other, and some pieces of software need to be configured separately for different use cases. Environment modules are designed to solve this problem, by treating each software package and all of its associated files as a distinct package to be loaded on demand. Modules also handle the loading of dependencies. For instance, loading the R programming language would be done by loading the "r" module - any dependencies would be handled behind the scenes by the module system without any user intervention. | ||
| + | |||
| + | == Common commands == | ||
| + | |||
| + | {| class="wikitable" style="text align: left"; | ||
| + | ! What you want to do !! Lmod command (Frontenac cluster) !! "Use" command (SW cluster) | ||
| + | |- | ||
| + | | See all available software || module avail || use -l | ||
| + | |- | ||
| + | | See a short description of what each package does || module spider || <no equivalent> | ||
| + | |- | ||
| + | | Load the software package "packageName" || module load packageName || use packageName | ||
| + | |- | ||
| + | | Use a specific version of a software package || module load packageName/version || use packageName-version | ||
| + | |- | ||
| + | | View currently loaded packages || module list || <no equivalent> | ||
| + | |- | ||
| + | | Unload a package || module unload packageName || <no equivalent> | ||
| + | |- | ||
| + | | Unload all packages || module purge || use none | ||
| + | |- | ||
| + | |} | ||
| + | |||
| + | Please note that all commands are ''case-sensitive''. | ||
| + | |||
| + | For an extremely comprehensive set of documenation on using the module system (such as how to write your own modules), you can refer to the official Lmod documentation here: [http://lmod.readthedocs.io/en/latest/ http://lmod.readthedocs.io/en/latest/] | ||
| + | |||
| + | = Local vs. Compute Canada software = | ||
| + | |||
| + | Software on the Frontenac cluster can come from two locations: locally or from Compute Canada's centralized software stack. The Compute Canada software stack is standardized, and contains a set of software that is identically compiled and setup across every cluster it is installed on. This is a fantastic tool for reproducibility and scaling your work across multiple clusters: the same software will work the same way, regardless of where you are using it. There is also a large amount of locally installed software as well. This is how most software requiring licensing or other special local considerations is installed. Using both sets of software is identical- just run <code>module load softwareName<code>. | ||
| + | |||
| + | Please note that if you are the first user to use a software package, or it | ||
| + | |||
| + | = List of all installed software = | ||
| + | |||
| + | This is a comprehensive list of software installed on the Frontenac cluster. Note that some software is loaded by default. | ||
| + | |||
| + | {| class="wikitable" style="text-align: left; | ||
| + | ! Software Name !! Version !! Package Name !! Usage Notes | ||
| + | |- | ||
| + | | rowspan=1 | Abaqus || default || abaqus || rowspan=1 | [[Software:abaqus|Info]]; restricted to Queen's University. | ||
| + | |- | ||
| + | | tophat || 2.1.1 || tophat/2.1.1 || | ||
| + | |- | ||
| + | |} | ||
Revision as of 15:04, 10 May 2017
The Frontenac cluster includes a wide variety of software and compilers. There are several new ways of accessing and using software, which are documented here. For a list of software available on the SW cluster, please see our SW software page.
Contents
The "module" system
Frontenac uses a new method of loading software compared to the SW cluster, the Lmod modules system. We have switched to this system to ensure consistency with other Compute Canada systems and provide a better user interface to our software. The modules system uses more or less the same concepts as the "use" system in use on the SW cluster.
On a large compute cluster, it is impossible to have all sets of software loaded all the time by default. Some software has multiple versions, some packages conflict with each other, and some pieces of software need to be configured separately for different use cases. Environment modules are designed to solve this problem, by treating each software package and all of its associated files as a distinct package to be loaded on demand. Modules also handle the loading of dependencies. For instance, loading the R programming language would be done by loading the "r" module - any dependencies would be handled behind the scenes by the module system without any user intervention.
Common commands
| What you want to do | Lmod command (Frontenac cluster) | "Use" command (SW cluster) |
|---|---|---|
| See all available software | module avail | use -l |
| See a short description of what each package does | module spider | <no equivalent> |
| Load the software package "packageName" | module load packageName | use packageName |
| Use a specific version of a software package | module load packageName/version | use packageName-version |
| View currently loaded packages | module list | <no equivalent> |
| Unload a package | module unload packageName | <no equivalent> |
| Unload all packages | module purge | use none |
Please note that all commands are case-sensitive.
For an extremely comprehensive set of documenation on using the module system (such as how to write your own modules), you can refer to the official Lmod documentation here: http://lmod.readthedocs.io/en/latest/
Local vs. Compute Canada software
Software on the Frontenac cluster can come from two locations: locally or from Compute Canada's centralized software stack. The Compute Canada software stack is standardized, and contains a set of software that is identically compiled and setup across every cluster it is installed on. This is a fantastic tool for reproducibility and scaling your work across multiple clusters: the same software will work the same way, regardless of where you are using it. There is also a large amount of locally installed software as well. This is how most software requiring licensing or other special local considerations is installed. Using both sets of software is identical- just run module load softwareName<code>.
Please note that if you are the first user to use a software package, or it
List of all installed software
This is a comprehensive list of software installed on the Frontenac cluster. Note that some software is loaded by default.
| Software Name | Version | Package Name | Usage Notes |
|---|---|---|---|
| Abaqus | default | abaqus | Info; restricted to Queen's University. |
| tophat | 2.1.1 | tophat/2.1.1 |
