Template:Catalog Header Modules: Difference between revisions

From CNM Wiki
Jump to navigation Jump to search
(removed "Software" page hierarchy level)
mNo edit summary
Line 1: Line 1:
== Catalog Introduction ==
== Introduction ==
[[HPC/Module Setup | ''Carbon'' software provisioning]] is based on
This is the catalog for HPC applications on ''Carbon''.
the [http://modules.sourceforge.net/ Environment Modules] package.
Access to applications is managed using the [http://modules.sourceforge.net/ Environment Modules] package.
The current page contains a catalog of the available modules.
An application may be referred to as a ''module'', even though the underlying ''modulefile'' merely contains some metadata and setup items.
You can access this catalog also on ''Carbon'' itself using the following shell commands:
 
You, the user, must select ("load") the modules that you wish to use, possibly down to a specific version.
An exception to this are a handful of basic modules that are pre-loaded when you log in.
 
You can access this catalog on ''Carbon'' itself, using the following commands to show all available modules, one-line summaries, and longer descriptions (usually with copyrights and links), respectively:
  module avail [''name'']
  module avail [''name'']
  module whatis ''name''
  module whatis [''name'']
  module help ''name''
  module help ''name''


; See also:
; See also:
* [[HPC/Module Setup | '''Module setup instructions''']]
* [[HPC/Module Setup | '''Module setup instructions''']]
* The man page for the module command (<code>man module</code>).


== Table of Contents ==
=== Table of Contents ===
; [[#Index|Index]]: A compact list of packages, grouped by function.
; [[#Index|Index]]: A compact list of packages, grouped by function.
; [[#Summaries|Summaries]]: Package names, one-line summaries, and all available versions. The version shown in '''bold''' is the default.
; [[#Summaries|Summaries]]: Package names, one-line summaries, and all available versions. The version shown in '''bold''' is the default (the version that is loaded when no specific version is given in the command line).
; [[#Descriptions|Descriptions]]: Long descriptions and package home URLs.  Versions are listed separately if the descriptions differ.
; [[#Descriptions|Descriptions]]: Long descriptions and package home URLs.  Versions are listed separately if the descriptions differ.
: [[HPC/Modules/atk|'''package names in blue''']] lead to additional instructions.
: [[HPC/Modules/atk|'''package names in blue''']] lead to additional instructions.
: [[HPC/Modules/__no_name__|'''package names in red''']] means no additional instructions are available.  Inspect the [[HPC/Module Setup#Package home directories | package home directory]] after loading the module.
: [[HPC/Modules/__no_name__|'''package names in red''']] means no additional instructions are available.  Inspect the [[HPC/Module Setup#Package home directories | package home directory]] after loading the module.

Revision as of 21:17, November 1, 2012

Introduction

This is the catalog for HPC applications on Carbon. Access to applications is managed using the Environment Modules package. An application may be referred to as a module, even though the underlying modulefile merely contains some metadata and setup items.

You, the user, must select ("load") the modules that you wish to use, possibly down to a specific version. An exception to this are a handful of basic modules that are pre-loaded when you log in.

You can access this catalog on Carbon itself, using the following commands to show all available modules, one-line summaries, and longer descriptions (usually with copyrights and links), respectively:

module avail [name]
module whatis [name]
module help name
See also

Table of Contents

Index
A compact list of packages, grouped by function.
Summaries
Package names, one-line summaries, and all available versions. The version shown in bold is the default (the version that is loaded when no specific version is given in the command line).
Descriptions
Long descriptions and package home URLs. Versions are listed separately if the descriptions differ.
package names in blue lead to additional instructions.
package names in red means no additional instructions are available. Inspect the package home directory after loading the module.