Introduction

Installation

The advanced package and environment management system, Anaconda, Miniconda or Mamba, is needed to be installed first.

The Mamba is recomended due to some (quite often occured) stucks at solving environment on Anaconda. Up to now Mamba works well.

Set up environment based on Mamba

Note

For more details see https://github.com/conda-forge/miniforge#mambaforge

curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-$(uname)-$(uname -m).sh"
bash Mambaforge-$(uname)-$(uname -m).sh

or

wget "https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-$(uname)-$(uname -m).sh"
bash Mambaforge-$(uname)-$(uname -m).sh

For users

  • download stable version of sst1mpipe (latest version = 0.4.1)

  • create and activate conda environment

  • install sst1mpipe

SST1MPIPE_VER=0.4.1

wget https://github.com/SST-1M-collaboration/sst1mpipe/archive/refs/tags/v$SST1MPIPE_VER.tar.gz
tar -xvf v$SST1MPIPE_VER.tar.gz
cd v$SST1MPIPE_VER
conda env create -n sst1m-$SST1MPIPE_VER -f environment.yml
conda activate sst1m-$SST1MPIPE_VER
pip install -e .

rm environment.yml

For developers

  • download latest development version from git repository

  • create and activate conda environment

  • install sst1mpipe

git clone git@github.com:SST-1M-collaboration/sst1mpipe.git
conda env create -f sst1mpipe/environment.yml
conda activate sst1m-dev
pip install -e sst1mpipe

Pre-installed conda environment on Calculus

If one prefers to work on Calculus, he/she may skip the pipeline installation completely and only activate preinstalled environment:

source /data/work/analysis/software/mambaforge/etc/profile.d/conda.sh
conda activate /data/work/analysis/software/mambaforge/envs/sst1m-$SST1MPIPE_VER

Analysis basics

TBD