Both sides previous revision Previous revision Next revision | Previous revision |
public:lle [2011-09-27 11:27] – Arno Schoenmakers | public:lle [2020-11-04 15:49] (current) – Bernard Asabere |
---|
====== The Lofar Login Environment (LLE) ====== | ====== The Lofar Login Environment (LLE) ====== |
| |
This page describes the standard login environment for new users on the LOFAR cluster nodes. | This page describes the standard login environment for new users on the LOFAR cluster nodes like [[:cep3:start|CEP3]]. Existing accounts can be easily modified; see below for a manual to do this. |
Existing accounts can be easily modified; see below for a manual to do this. | |
| |
===== General ===== | ===== General ===== |
| |
To be able to use the LLE environment you must either use a ''(t)csh'' or ''bash'' login shell. We do not support scripts for any other shells. | To be able to use the LLE environment you must either use a ''(t)csh'' or ''bash'' login shell. We do not support scripts for any other shells. |
| |
| |
===== What to do when you get an account ===== | ===== What to do when you get an account ===== |
| |
==== (t)csh ==== | The CEP3 user creation system has been setup such that new accounts will have all needed files and links in ''$HOME'' in place already. So you do not have to chnage anything to work with the LLE. |
| |
If you have chosen for the ''(t)csh'' shell, you do as follows: | |
* Log in and go to your (empty) ''$HOME'' directory | |
* ''> ln -s /opt/login/cshrc .cshrc'' (Note: on lioffen you should refer to ''/app/login/cshrc'' !) | |
* Log out and login again; you should see a welcome message. | |
| |
==== bash ==== | |
| |
If you have chosen for the ''bash'' shell, you do as follows: | |
* Log in and go to your (empty) ''$HOME'' directory | |
* ''> ln -s /opt/login/bashrc .bashrc'' (Note: on lioffen you should refer to ''/app/login/cshrc'' !) | |
* Log out and login again; you should see a welcome message. | |
| |
===== How to transform existing accounts? ===== | ===== How to transform existing accounts? ===== |
| |
To use the LLE in an existing account, rename your existing ''.cshrc'' or ''.bashrc'' in your ''$HOME'' and follow the instructions given above. | To use the LLE in an existing account and ''$HOME'' dir, rename your existing ''.cshrc'', or ''.profile'' and ''.bashrc'', in your ''$HOME'' and follow the instructions given above. |
| |
Make sure that possibly existing files ''$HOME/.login'', ''$HOME/.setenv'' and ''$HOME/.alias'' that you still want to use at login time are renamed to ''$HOME/.mylogin'', ''$HOME/.mysetenv'', ''$HOME/.myalias''. | |
| |
| |
| |
===== The LLE scripts ===== | ===== The LLE scripts ===== |
| |
Some of the details are presented here. | Some of the details are presented here. |
| |
==== What is $APS_LOCAL ? ==== | |
| |
The root directory for the scripts is provided in environment variable ''$APS_LOCAL'', whose value is set in the ''.cshrc'' and ''.bashrc'' scripts. The actual value is: | |
* New CEP processing cluster: ''/opt'' | |
| |
| |
| |
==== Login scripts ==== | ==== Login scripts ==== |
| |
In directory ''${APS_LOCAL}/login'' are a number of default login scripts. The scripts ending with ''.bash'' are for the ''bash'' shell, the others for the ''(t)csh'' shell: \\ | In directory ''/opt/cep/login'' are a number of default login scripts. The scripts ending with ''.bash'' are for the ''bash'' shell, the others for the ''(t)csh'' shell: |
* ''cshrc'' -> sets APS_LOCAL and calls the other scripts | |
* ''login'' -> Displays welcome message; no settings | |
* ''setenv'' -> adds some items to $PATH, sets your prompt, etc. | |
* ''alias'' -> some default aliases to make life easy | |
* ''setpackages'' -> script to define packages to initialize at login-time | |
\\ | |
| |
Users should **NEVER** modify these default scripts at this location! | * ''cshrc'' → login settings for (t)csh environments. |
| * ''bashrc'' → login settings for non-interactive logins. |
| * ''profile'' → login settings for interactive logins. |
| * ''login'' → Displays welcome message; no settings. |
| * ''setpackages'' → script to define packages to initialize at login-time. |
| |
| Users should **NEVER** modify these default scripts. In their ''$HOME'' these should be symlinks to the versions in ''/opt/cep/login''. Personalization of your login is possible through other scripts like ''.myalias'' and ''.mysetenv'' (see below). |
| |
| If you like to read more on the files that play a role in the bash login, [[https://stackoverflow.com/questions/415403/whats-the-difference-between-bashrc-bash-profile-and-environment|here is a nice link]]. |
| |
==== Personal command aliasses: .myalias ==== | ==== Personal command aliasses: .myalias ==== |
| |
Personal command aliases can be added to a file ''$HOME/.myalias''. When this file exists, the ''.cshrc'' or ''.bashrc'' script will read this file after reading the default ''${APS_LOCAL}/login/alias(.bash)''. | Personal command aliases can be added to a file ''$HOME/.myalias''. When this file exists, the ''.cshrc'' or ''.bashrc'' script will read this file. |
| |
==== Personal environment settings: .mysetenv ==== | ==== Personal environment settings: .mysetenv ==== |
| |
Personal extensions to ''$PATH'', personal environment variables, personal prompt setting, or overloaded existing environment variables should be done in a file ''$HOME/.mysetenv''. If this file exists, the cshrc or bashrc script will read this file. | Personal extensions to ''$PATH'', personal environment variables, personal prompt setting, or overloaded existing environment variables should be done in a file ''$HOME/.mysetenv''. If this file exists, the cshrc or bashrc script will read this file. |
| |
| |
===== Package initialisation ===== | ===== Package initialisation ===== |
| |
Many packages are available from the distribution of the Operating System. Several packages are added lateron. To activate these, environment variables like ''PATH'', ''LD_LIBRARY_PATH'', ''PYTHONPATH'' must be set correctly. To help you, we have created package initialization scripts that you can call to set these parameters correctly. | Many packages are available from the distribution of the Operating System. Several packages are added lateron, see [[:cep3:usersoftware|this page for CEP3 packages]]. To activate these, environment variables like ''PATH'', ''LD_LIBRARY_PATH'', ''PYTHONPATH'' must be set correctly. To help you, we have installed the environment module software (see [[:cep3:usersoftware#using_packages_with_environment_modules|this section in the CEP3 user documentation]]). |
| |
A list of packages available on the offline processing cluster can be found [[public:lofar_packages|on this page]]. | ==== .mypackages ==== |
| |
==== On the commandline ==== | To initialize the use of installed packages at login time you must create a file ''$HOME/.mypackages''. If this file exists, it is used by the LLE script ''setpackages''. |
| |
To initialize a package, you must know the name of the initialization file. These can be found in directory ''${APS_LOCAL}/scripts''. An example of such a filename is ''doLofIm''. This file initializes the ''LofIm'' package. You can execute it by typing: | The file ''$HOME/.mypackages'' can look like this example: |
> use LofIm | <code> |
| |
It can be quite cumbersome to have to initialize all your required packages each time in each shell window you open. Therefore we have made available an option to initialize a list of packages at login time. | casa |
| lofim |
| |
==== .mypackages ===== | </code> |
| |
To initialize the use of installed packages at login time you must create a file ''$HOME/.mypackages''. If this file exists, it is used by the LLE script ''setpackages''. | Provide only one package name per line. For packages that are build daily and that have a version available for all days of the week (LUS, LofIm), you can also specify a day of week in the ''.mypackages'' file: |
| |
In the directory ''${APS_LOCAL}/scripts'' you will find available package initialization scripts, named like ''do<package>'' (e.g., ''doCasa'', ''doLofIm''). Whenever you add a package to the file ''$HOME/.mypackages'', the associated script in ''$APS_LOCAL/scripts'' will be ''source'''d. | |
| |
The file ''$HOME/.mypackages'' can look like this example: | |
<code> | <code> |
Casa | lofim Tue |
LofIm | |
</code> | |
| |
The packages can be on one line or on multiple lines. Also note the use of ''<package>'' and ''do<package>''; both are accepted. If an initialization script for a package cannot be found, it will be reported to the user. | |
| |
For packages that are build daily and that have a version available for all days of the week (LUS, LofIm), you can also specify a day of week on the commandline: | |
<code> | |
> use LofIm Tue | |
</code> | |
or in the ''.mypackages'' file: | |
<code> | |
LofIm Tue | |
</code> | </code> |
| |
==== How to add a personal package ==== | ==== How to add a personal package ==== |
| |
Apart from the systemwide ''do<package>'' files provided in directory ''$APS_LOCAL/scripts'', users can add their personal ''do<package>'' files in their ''$HOME'' and have these run at login time. If there is a ''do<package>'' file both in ''$HOME'' and in ''$APS_LOCAL/scripts'', the version in ''$HOME'' has preference and will be executed. This can be used to test a different version of a package, etc... To add a new, personal, package, act as follows: | Apart from the systemwide module initialization files provided in directory ''$APS_LOCAL/modulefiles'', users can add their personal modulefiles in their ''$HOME/modulefiles'' and have these run at login time. To add a new, personal, modulefile, act as follows: |
* Install the package | * Install the package |
* Create a ''$HOME/do<package>'' initialization script (e.g., adding the installation directory to your ''$PATH'') | * Create a ''$HOME/modulefiles/<package>/<modulefile>'' environment module script (e.g., adding the installation directory to your ''$PATH''). See [[http://modules.sourceforge.net/man/modulefile.html|this manual for writing modulefiles yourself]]. |
* Add <package> to the list of packages in file ''$HOME/.mypackages'' | * Add <package> to the list of packages in file ''$HOME/.mypackages'' |
| |
| ===== Starting X environment ===== |
| |
| To start up an X environment you have to make sure that |
| |
| * The files ''$HOME/.xinitrc'' and ''$HOME/.xsession'' are removed |
| |
| Determine the colordepth that you need (8, 16, 24 bit display) and type: |
| <code> |
| |
| startx -- :1 -depth <colordepth> |
| |
| </code> |
| |
===== Starting X environment ===== | This should start your X environment at the proper colordepth. This will create an additional X Server next to the one you are already running. You can access this with Alt-F8 or Cntl-Alt-F8. The F7 variant will give you back your normal X. |
| |
To start up an X environment you have to make sure that | Due to the large latency and largte bandwidth required for X-traffic, it is advisable to connect to the CEP systems with the ''NX''-client on your system. See [[:public:freenx-windows-client|this page for more info]]. |
* The files ''$HOME/.xinitrc'' and ''$HOME/.xsession'' are removed | |
| |
Determine the colordepth that you need (8, 16, 24 bit display) and type:<code> | ===== Help! ===== |
startx -- :1 -depth <colordepth> | |
</code> | |
This should start your X environment at the proper colordepth. | |
This will create an additional X Server next to the one you are already running. You can access this with Alt-F8 or Cntl-Alt-F8. The F7 variant will give you back your normal X. | |
| |
===== Help! ===== | If you need help, or have questions, or want to give any other comments, contact Arno Schoenmakers or Jasmin Klipic. |
| |
If you need help, or have questions, or want to give any other comments, contact Arno Schoenmakers or Adriaan Renting. | New module-files can be added at any time if you have a new package that should be available systemwide. Contact Arno Schoenmakers or Jasmin Klipic in this case. |
| |
New ''do<xxxx>''-files can be added at any time if you have a new package that should be available systemwide. Contact Arno Schoenmakers or Adriaan Renting in this case. | |
| |