From 5a955d0ec35edc0227af55a6d4b30f904b984faf Mon Sep 17 00:00:00 2001
From: "Patrick L.S. Connor" <connorpa@mail.desy.de>
Date: Wed, 28 Feb 2024 13:35:03 +0100
Subject: [PATCH] improving README and setup after seeing repeating
misunderstandings from newcomers
---
README.md | 9 ++++++---
setup | 8 ++++----
2 files changed, 10 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 5805958..dc44490 100644
--- a/README.md
+++ b/README.md
@@ -13,12 +13,15 @@ The `Campaigns` subgroup contains actual repos corresponding to different analys
## Installation
-### From scratch with the default installer
+In the following, we provide two alternative methods to install the framework.
+
+### Method #1: From scratch with the default installer
In general, it is recommended that you install the software on a fast disk to ensure fast compilation (e.g. AFS), but that you process the heavy n-tuples on a dedicated area (e.g. NFS at DESY, EOS at CERN). Keeping the software neat and clean is important for reproducibility.
1. Clone the `Installer` in a directory (we propose `DasAnalysisSystem`). Then source the minimal environment for CMSSW, CRAB, and RUCIO from that directory:
```
+git clone https://gitlab.cern.ch/cms-analysis/general/DasAnalysisSystem/gitlab-profile.git DasAnalysisSystem
cd DasAnalysisSystem
source ./setup
```
@@ -33,9 +36,9 @@ It is currently working at CERN (CH), at DESY (DE), at IIHE (BE), and for GitLab
cmsenv
scram b -j$(nproc)
```
-4. After a few minutes, you're all set. You may have to rerun `cmsenv` to actually see the commands in the shell.
+4. After a few minutes, you get back to the prompt. You have to rerun `cmsenv` to actually see the commands in the shell. Then you're all set.
-### By hand, step by step
+### Method #2: By hand, step by step
In the following, we explain the installation of the framework step by step. A few packages external to CMSSW are necessary (e.g. TUnfold), which you will need to tell CMSSW how to find them with `scram setup`.
diff --git a/setup b/setup
index 4492ff8..9f22c47 100644
--- a/setup
+++ b/setup
@@ -1,7 +1,7 @@
case "$(hostname)" in
*desy.de)
tput setaf 2
- echo "Environment set up for DESY."
+ echo "Setting up environment for DESY (naf)."
tput op
module use -a /afs/desy.de/group/cms/modulefiles/
module load cmssw
@@ -9,17 +9,17 @@ case "$(hostname)" in
;;
*cern.ch)
tput setaf 2
- echo "Nothing to be done on lxplus. You may proceed safely."
+ echo "Setting up environment for CERN (lxplus)."
tput op
;;
*iihe.ac.be)
tput setaf 2
- echo "Environment set up for IIHE T2B cluster."
+ echo "Setting up environment for IIHE T2B cluster."
tput op
;;
*)
tput setaf 3
- echo "Nothing planned for this environment. Proceed at your own risks."
+ echo "Unknown facility. Proceed at your own risks."
tput op
;;
esac
--
GitLab