ATLASLocalRootBase (v2)

WARNING: This page is obsolete.

Please look at https://atlas-software.docs.cern.ch/analysis/analysis_tutorial/basicSetup/alrb/.

Brief description and usage of the ATLASLocalRootBase package

ATLASLocalRootBase is a consistent "look and feel" user interface for ATLAS users on any platform or site where it is installed. It is installed with the manageTier3SW package and is available on cvmfs and on all grid sites, Tier3s as well as on CernVM.

From the user perspective, all one has to do is the following:

(CernVM users, or sites with cvmfs, replace below <path to> with /cvmfs/atlas.cern.ch/repo and see the section below for overrides.)

export ATLAS_LOCAL_ROOT_BASE=/<path to>/ATLASLocalRootBase # use your path
alias setupATLAS='source ${ATLAS_LOCAL_ROOT_BASE}/user/atlasLocalSetup.sh'
setupATLAS

The user can also add this in ~/.bashrc or ~/.zshrc and simply type setupATLAS when needed.

export ATLAS_LOCAL_ROOT_BASE=/<path to>/ATLASLocalRootBase # use your path
alias setupATLAS='source ${ATLAS_LOCAL_ROOT_BASE}/user/atlasLocalSetup.sh'

If you do not like the reverse highlight menu, you can disable it: export ALRB_userMenuFmtSkip=true.

Container (setupATLAS -c)

If you are want to run in a (Apptainer/Docker/Podman/Shifter) container, please see this section.

After setupATLAS is done, there is a tool queryC which is available to find containers or list details about them. Do queryC -h for details.

CernVM users or using ATLASLocalRootBase from cvmfs

Non-CernVM users, you can also use ATLASLocalRootBase from cvmfs if you have cvmfs installed - almost all sites have it.

You should have the following lines in ~/.bashrc or ~/.zshrc:

export ATLAS_LOCAL_ROOT_BASE=/cvmfs/atlas.cern.ch/repo/ATLASLocalRootBase
alias setupATLAS='source ${ATLAS_LOCAL_ROOT_BASE}/user/atlasLocalSetup.sh'
export ALRB_localConfigDir=$HOME/localConfig

See the next section on "Local Overrides" for what to insert in $HOME/localConfig.

Local Overrides

Note that you can override some settings by creating a local directory.

For example, do the following:

mkdir $HOME/localConfig
cp $ATLAS_LOCAL_ROOT_BASE/exampleLocalConfig/* $HOME/localConfig/

Next edit the files in $HOME/localConfig and then insert the following line into ~/.bashrc or ~/.zshrc:

export ALRB_localConfigDir=$HOME/localConfig

This will setup the appropriate local overrides for Frontier-squid and Containers. Usually you need not do this as site admins will have done it for you globally. Examples can be found in $ATLAS_LOCAL_ROOT_BASE/exampleLocalConfig.

MacOS

ATLASLocalRootBase is also available for MacOS users.

• Please install cvmfs as described here.
• Then define these:

export ATLAS_LOCAL_ROOT_BASE=/cvmfs/atlas.cern.ch/repo/ATLASLocalRootBase
alias setupATLAS='source ${ATLAS_LOCAL_ROOT_BASE}/user/atlasLocalSetup.sh'

• This is mainly meant for users to run containers on MacOS.
• Note that you can install only ATLASLocalRootBase on your Mac and use standalone containers without cvmfs. (or use both local and cvmfs ATLASLocalRootBase depending if you have network. See this link.

What do you want to do ?

Note about when to do voms-proxy-init

If you setup any tool and you see emi (or grid middleware) setup, and this at the end of the setup:

>>>>>>>>>>>>>>>>>>>>>>>>> Information for user <<<<<<<<<<<<<<<<<<<<<<<<<
 emi:
   No valid proxy present.  Type "voms-proxy-init -voms atlas"
************************************************************************

or this:

>>>>>>>>>>>>>>>>>>>>>>>>> Information for user <<<<<<<<<<<<<<<<<<<<<<<<<
 emi:
   Your proxy has 0h:29m:54s remaining
     Renew by typing "voms-proxy-init -voms atlas"
************************************************************************

or even this (only if you want to extend your proxy beyond the time listed below):

>>>>>>>>>>>>>>>>>>>>>>>>> Information for user <<<<<<<<<<<<<<<<<<<<<<<<<
 emi:
   Your proxy has 10h:59m:55s remaining
************************************************************************

Then you should do the voms-proxy-init -voms atlas explicitly. Otherwise you do not.

The idea is that everything needed is already setup and you should not need to explicitly setup grid middleware through rucio or other ways.

Help

• setupATLAS -c -h to show container help
• setupATLAS -h to show setupATLAS help options
• setupATLAS followed by helpMe for links to documentation
• lsetup -h for lsetup help
• lsetup -h <tool> for lsetup help on a tool

Versions

• setupATLAS -c --showVersions to show list of containers in /cvmfs/unpacked.cern.ch
• setupATLAS and then showVersions athena to show available ATLAS releases
• setupATLAS and then showVersions root to show ROOT versions (or any tool)

Using Rucio Clients

• setupATLAS
• lsetup rucio
• get a proxy if needed (notice I do not setup grid middleware - it is automatically done):
  • voms-proxy-init --voms atlas
• do the usual rucio commands. For details, refer to the links in helpMe
• You should setup rucio in a terminal session of its own if possible.
• However, if you need to setup rucio in the same setup as an ATLAS release, use the wrapper version:
  • lsetup "rucio -w"
  • you can set it all up on one line; e.g.: lsetup "rucio -w" "asetup <release>"

Using PandaClient

• setupATLAS (you can do this anytime - when you need it, or type printMenu)
• lsetup panda
• If you need an ATLAS release, you can set it up as follows (do not run pbook with an ATLAS release; set panda up in a new terminal to run that alone):
  • lsetup "asetup <athena version>" panda
• use the pathena / prun / pbook tools as usual.
  • Notice that I did not setup grid-middleware anywhere and you should not either - Panda clients do it for you.
  • if a proxy is missing or invalid, the Panda clients will ask your password to generate it.

Advanced Users

• setupATLAS followed by advancedTools shows more tools
• For lcgenv or views, look at this page for details.
• Note also the tools installPip and installRpm available from the advancedTools menu that allows you to install and reuse missing software for containers or bare-metal. Type -h for details.

xcache

xcache allows for the caching of datafiles on a local disk; eg if you are accessing a file at a remote site through the root protocol, it can be cached at a specified location so that subsequent accesses will be very fast. For details, please click on the link.

Tutorials

This is for tutorial conveners who want to ask users to test that their computer is ready to be used for tutorials. Please refer to this page for details.

Diagnostics

Diagnostic tools offer a way for users and user support to understand issues; these are described in more detail here.

How-to

Batch Jobs

Bash does not expand aliases and so this is what you can do if you need to use the menu options in ATLASLocalRootBase. Do one of these to overcome this:

• Either do this in your script:

if [ -z $ATLAS_LOCAL_ROOT_BASE ]; then
  export ATLAS_LOCAL_ROOT_BASE=/cvmfs/atlas.cern.ch/repo/ATLASLocalRootBase
fi
source $ATLAS_LOCAL_ROOT_BASE/user/atlasLocalSetup.sh
# and the menu options will then be available

• Or insert in your script:

#!/bin/bash

if [ -z $ATLAS_LOCAL_ROOT_BASE ]; then
  export ATLAS_LOCAL_ROOT_BASE=/cvmfs/atlas.cern.ch/repo/ATLASLocalRootBase
fi

shopt -s expand_aliases

alias setupATLAS='source ${ATLAS_LOCAL_ROOT_BASE}/user/atlasLocalSetup.sh'

setupATLAS

#(the rest of your code should now work with the menu commands)

SLURM

Submit with the following option to prevent the local environment from being set on the batch job environment.

sbatch --export=NONE ...

LSF

Submit with the following option to prevent the local environment from being set on the batch job environment.

bsub -L /bin/bash ...

-- AsokaDeSilva - 24 Jun 2008</verbatim>