« Back

moduleexamples

Example Startup File for the Modules Environment

The XSEDE Common User Environment (CUE) uses the Modules system to manage login shell environment variables and settings.

To load preferred modules automatically upon login shell startup, you may specify the corresponding

module load

commands in a file named .modules in your home directory, where refers to the name of the module to be loaded.

  • To see what modules have been loaded by default, use the module list command.
  • To see a list of available modules, use the module avail command.

All new user accounts will be provided an example .modules file in their home directory (see example below). To enable loading of CUE modules listed in the example file, remove the leading # in front of the desired commands. You may also add other module commands to load preferred modules upon login shell startup.

Some XSEDE systems currently provide SoftEnv as the default shell environment management system. You may continue to use SoftEnv on these systems. To use Modules instead of SoftEnv, you should create an empty file in your home directory named .nosoft. For example, cd ; touch .nosoft. Subsequent login shells will start with Modules enabled instead of SoftEnv.

For more information on available Modules settings, see the Modules page and the Common Environment Variables page.

Example CUE Configuration Files

Example .modules File

# ${HOME}/.modules # # This file is sourced by the modules initialization script when a login # shell is started. # # To have your preferred modules loaded upon login shell execution, add # the required module commands to this file. # # Note that the system you run this on may already load some local default # modules for you; these are visible using the "module list" command. # To load the Common User Environment (CUE) modules, uncomment (i.e. remove # the leading '# ') for the following 'module load' commands: # # module load cue-login-env # CUE login environment variables # module load cue-build # CUE build environment, loads cue-compiler # module load cue-math # CUE math libraries # module load cue-comm # CUE MPI libraries # module load cue-tg # CUE legacy XSEDE environment variables

SSH Client Host Aliases for XSEDE

## Common User Environment SSH client Host aliases for XSEDE ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## ## Indiana University Login Hosts # Big Red - IU - IBM e1350 Linux Cluster Host bigred Hostname login.bigred.iu.xsede.org ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## ## Louisiana State University (LONI) Login Hosts # Queen Bee - LONI - Dell Intel 64 Linux Cluster Host qb Hostname queenbee.loni-lsu.xsede.org Host queenbee Hostname queenbee.loni-lsu.xsede.org ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## ## National Center for Atmospheric Research (NCAR) Login Hosts # Frost - NCAR - IBM BlueGene/L Host frost Hostname tg-login.frost.ncar.xsede.org ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## ## National Center for Supercomputing Applications (NCSA) Login Hosts # Abe - NCSA - Dell Intel 64 Linux Cluster Host abe Hostname login-abe.ncsa.xsede.org # Cobalt - NCSA - SGI Altix Host cobalt Hostname login-co.ncsa.xsede.org # Ember - NCSA - SGI UV Host ember Hostname login-ember.ncsa.xsede.org # Lincoln - NCSA - Dell Intel 64 Tesla Linux Cluster Host lincoln Hostname login-lincoln.ncsa.xsede.org ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## ## National Institute for Computational Science (NICS) at UTK Login Hosts # Kraken - Cray XT5 - AMD Opteron 64 / Cray Linux Environment Host kraken-gsi Hostname kraken-gsi.nics.xsede.org Host kraken Hostname kraken.nics.xsede.org # Athena - Cray XT4 - AMD Opteron 64 / Cray Linux Environment Host athena-gsi Hostname athena-gsi.nics.xsede.org Host athena Hostname athena.nics.xsede.org # Nautilus - SGI Altix UV 1000 - Intel Nehalem EX - Linux (SUSE v11) Host nautilus Hostname nautilus.nics.xsede.org ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ## "ssh-config-tg" 76L, 3108C Host ranger Hostname ranger.tacc.xsede.org # Spur - TACC - Sun Visualization Cluster Host spur Hostname spur.tacc.utexas.edu ## - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ##

Standard Shell Prompt for sh-style Shells

# cue-shell-prompt.sh: set CUE standard shell prompt for sh-style shells # (e.g. bash) # # use this by sourcing it in your shell, e.g. # # $ . ${CUE_EXAMPLES}/cue-shell-prompt.sh # # where CUE_EXAMPLES is an environment variable set to the directory path # in which this file resides # Set the PS1 environment variable to show username@system:cwd> # where username is your local account name on this system, # system is the short name of thie system, e.g., pople for # pople.psc.xsede.org and cwd is the current working directory # module cue-login-env defines CUE_HOST_PROMPT with the system's short name if [ -z $CUE_HOST_PROMPT ]; then module load cue-login-env fi PS1="\u@${CUE_HOST_PROMPT}:\w$ " export PS1

Standard Shell Prompt for csh-style Shells

# cue-shell-prompt.csh: set CUE standard shell prompt for csh-style shells # (e.g, tcsh) # # use this by sourcing it in your shell, e.g. # # % source ${CUE_EXAMPLES}/cue-shell-prompt.csh # # where CUE_EXAMPLES is an environment variable set to the directory path # in which this file resides # module cue-login-env defines CUE_HOST_PROMPT with the system's short name set cue_defined = `printenv | grep -c -E '^CUE_HOST_PROMPT=\w+'` if ( ! $cue_defined ) then module load cue-login-env endif # Set the csh-style shell prompt variable to show username@system:cwd> # where username is your local account name on this system, # system is the short name of this system, e.g., pople for # pople.psc.xsede.org and cwd is the current working directory if ( $?prompt ) then set prompt="%n@${CUE_HOST_PROMPT}:%~% " endif