Installation¶
The softwares are already available for LEGOS colleagues on summit2.
For new users, we recommend the installation and use through a container images.
For advanced user and developpers, you can install the software from sources.
On summit2 (LEGOS cluster)¶
The last version of the software is available for direct use on this cluster with the following commands (you can add them to your ~/.bash_profile file):
module use /ecola/share/modulefiles/
module load sirocco-gnu/latest
From containers images¶
Docker and Apptainer/Singularity images are available upon request to Simon Barbot. A proper upload will be made available in the future.
Running containers require specific steps and privileges, so make sure you contacted the user service maintaining your computer/cluster, get the privilege to run containers and get the documentation of your cluster eventually.
WARNING: A container is mounting the working directory (where you run the job) so you cannot access to the files that are in upper directories. Make sure to run a command pointing at files that are in this current directory or below.
Install and command use with a Docker image¶
Apptainer/Singularity image does not need to be added to your system before using it (but may need to be in a dedicated directory for clusters). Copy the image into your system:
#Unpack and load image into your system
VERSION=5803
tar -xvf sirocco-tools.$VERSION.docker.tar.gz
docker image load -i sirocco-tools.$VERSION.docker.tar
rm sirocco-tools.$VERSION.docker.tar
#List the available images
docker images
Then, to use the command from SIROCCO tools (anywhere):
docker run -e LOCAL_UID=$(id -u) -e LOCAL_GID=$(id -g) <image_name:$VERSION> <command> <args>
It will ask to run the <command> from the image <image_name:version>, mounting your directory from where you run this job.
Install and command use with a Apptainer/Singularity image¶
Apptainer/Singularity image does not need to be added to your system before using it (but may need to be in a dedicated directory for clusters). Copy the image into your system:
containerDIR=/your/conteneurs/directory/
VERSION=5803
mv sirocco-tools.$VERSION.sif $containerDIR/
Then, to use the command from SIROCCO tools (anywhere):
singularity run -i --containall --env LOCAL_UID=$(id -u) --env LOCAL_GID=$(id -g) --bind $(pwd):/mnt $containerDIR/sirocco-tools.$VERSION.sif <command> <args>
It will ask to run the <command> from the container file $containerDIR/sirocco-tools.$VERSION.sif, mounting your directory from where you run this job.