| Both sides previous revision Previous revision Next revision | Previous revisionLast revisionBoth sides next revision |
| abstract:darwin:app_dev:compute_env [2021-04-27 15:44] – [Startup and logout scripts] anita | abstract:darwin:app_dev:compute_env [2021-06-22 11:41] – anita |
|---|
| |
| ===== Environment variables ===== | ===== Environment variables ===== |
| |
| ==== Introduction ==== | |
| |
| Environment variables store dynamic system values that affect the user environment. For example, the ''PATH'' environment variable tells the operating system where to look for executables. Many UNIX commands and tools, such as the compilers, debuggers, profilers, editors, and applications with graphical user interfaces, often look at environment variables for information they need to function. The man pages for these programs typically have an ENVIRONMENT VARIABLES section with a list of variable names which tells how the program uses the values. | Environment variables store dynamic system values that affect the user environment. For example, the ''PATH'' environment variable tells the operating system where to look for executables. Many UNIX commands and tools, such as the compilers, debuggers, profilers, editors, and applications with graphical user interfaces, often look at environment variables for information they need to function. The man pages for these programs typically have an ENVIRONMENT VARIABLES section with a list of variable names which tells how the program uses the values. |
| |
| <code bash> | <code bash> |
| cp /etc/skel/.bash* $HOME | cp /opt/shared/templates/homedir/.bash* $HOME |
| </code> | </code> |
| |
| * set your workgroup (allocation group //allocation_group// name) with the **workgroup** command, | * set your workgroup (allocation group //allocation_group// name) with the **workgroup** command, |
| * change to your project directory with the **cd** command, | * change to your project directory with the **cd** command, |
| * connect to the compute node resources with **salloc** (or **sbatch**) command. | * connect to the compute node resources with **salloc** (or **sbatch**) command specifying a single partition your allocation workgroup has access based on resources requested for your allocation. |
| |
| === Connecting to login node === | === Connecting to login node === |
| </note> | </note> |
| <note important>Clusters may be configured to have multiple login nodes, with one common name for connecting. For example, on the DARWIN cluster, the hostname may be set to ''login00'' or ''login01'', and the standard prompt and window title bar will indicate which login node on //darwin//. </note> | <note important>Clusters may be configured to have multiple login nodes, with one common name for connecting. For example, on the DARWIN cluster, the hostname may be set to ''login00'' or ''login01'', and the standard prompt and window title bar will indicate which login node on //darwin//. </note> |
| | |
| === Setting workgroup === | === Setting workgroup === |
| |
| |
| ^ Variable ^ Example Value ^ Description ^ | ^ Variable ^ Example Value ^ Description ^ |
| | ''WORKDIR'' | ''/lustre/it_css'' | Allocation group directory, this is not writeable | | | ''WORKDIR'' | ''/lustre/it_css'' | Allocation workgroup directory, this is not writeable | |
| | ''WORKGROUP'' | ''it_css'' | Current allocation workgroup name | | | ''WORKGROUP'' | ''it_css'' | Current allocation workgroup name | |
| | ''WORKDIR_USER'' | ''/lustre/it_css/users/<<//uid//>>'' | Allocation group user directory | | | ''WORKDIR_USER'' | ''/lustre/it_css/users/<<//uid//>>'' | Allocation workgroup user directory | |
| | ''WORKDIR_SW'' | ''/lustre/it_css/sw'' | Allocation group software workgroup directory | | | ''WORKDIR_SW'' | ''/lustre/it_css/sw'' | Allocation workgroup software directory | |
| |
| <note tip>Use ''$WORKDIR'' when you refer to your allocation group directory. This will improve portability. </note> | <note tip>Use specific environment variables such as ''$WORKDIR_USERS'' when referring to your allocation workgroup user directory and ''$WORKDIR_SW'' when referring to your allocation workgroup software directory. This will improve portability. </note> |
| <note tip> | <note tip> |
| It is always important to be aware of your current allocation workgroup name. The standard prompt includes the workgroup name, added to your username and host. You must have a workgroup name in your prompt to use that allocation group's compute node resources to submit jobs using [[[[abstract/darwin/runjobs/schedule_jobs#batch-jobs-qsub|sbatch]] or salloc. An example prompt after the **workgroup** command, | It is always important to be aware of your current allocation workgroup name. The standard prompt includes the allocation workgroup name, added to your username and host. You must have an allocation workgroup name in your prompt to use that allocation group's compute node resources to [[abstract/darwin/runjobs/schedule_jobs|submit jobs]] using ''sbatch'' or ''salloc''. An example prompt after the **workgroup** command, |
| |
| ''[(it_css:traine)@login01.darwin ~]$ '' | ''[(it_css:traine)@login01.darwin ~]$ '' |
| === Changing directory === | === Changing directory === |
| |
| When you first connect to the login node, all your commands are executed from your home directory (''~''). Most of your work will be done in your allocation group work directory. The **workgroup** command has an option to start you in the allocation workgroup work directory. For example, | When you first connect to the login node, all your commands are executed from your home directory (''~''). Most of your work will be done in your allocation workgroup directory. The **workgroup** command has an option to start you in the allocation workgroup work directory. For example, |
| <code bash> | <code bash> |
| workgroup -cg it_css | workgroup -cg it_css |
| |
| <note important>Before submitting jobs you **must** first use the **workgroup** command. Type ''workgroup -h'' for additional information. | <note important>Before submitting jobs you **must** first use the **workgroup** command. Type ''workgroup -h'' for additional information. |
| | Both **sbatch** and **salloc** will start in the same project directory you set on the login node and will require a single [[abstract:darwin:runjobs:queues|partition]] to be specified to be able to submit a batch or interactive session. |
| Every time you connect to the login node, you should use **workgroup** to set the allocation workgroup you will being working in, and then **cd** to change to the directory for the project you will working on. Both **sbatch** and **salloc** will start in the same project directory you set on the login node. | |
| </note> | </note> |
| |