From 29d916f57d10b89af51663abd7c1662674e1e737 Mon Sep 17 00:00:00 2001 From: Andrew Gilbert Date: Wed, 19 Jun 2024 13:19:58 +0200 Subject: [PATCH] update docs --- CombineTools/scripts/sparse-checkout-https.sh | 15 --------------- .../scripts/sparse-checkout-plotting-https.sh | 15 --------------- .../scripts/sparse-checkout-plotting-ssh.sh | 15 --------------- CombineTools/scripts/sparse-checkout-ssh.sh | 15 --------------- README.md | 16 ++++------------ docs/Main.md | 9 ++++----- 6 files changed, 8 insertions(+), 77 deletions(-) delete mode 100644 CombineTools/scripts/sparse-checkout-https.sh delete mode 100644 CombineTools/scripts/sparse-checkout-plotting-https.sh delete mode 100644 CombineTools/scripts/sparse-checkout-plotting-ssh.sh delete mode 100644 CombineTools/scripts/sparse-checkout-ssh.sh diff --git a/CombineTools/scripts/sparse-checkout-https.sh b/CombineTools/scripts/sparse-checkout-https.sh deleted file mode 100644 index bcc62cbca67..00000000000 --- a/CombineTools/scripts/sparse-checkout-https.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/bin/sh -set -x -set -e - -if [ -z ${CMSSW_BASE+x} ]; then - echo "CMSSW environment not set!"; -else - pushd $CMSSW_BASE/src - mkdir CombineHarvester; cd CombineHarvester - git init - git remote add origin https://github.com/cms-analysis/CombineHarvester.git - git config core.sparsecheckout true; echo CombineTools/ >> .git/info/sparse-checkout - git pull origin v2.0.0 - popd -fi diff --git a/CombineTools/scripts/sparse-checkout-plotting-https.sh b/CombineTools/scripts/sparse-checkout-plotting-https.sh deleted file mode 100644 index f824ba8c710..00000000000 --- a/CombineTools/scripts/sparse-checkout-plotting-https.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/bin/sh -set -x -set -e - -if [ -z ${CMSSW_BASE+x} ]; then - echo "CMSSW environment not set!"; -else - pushd $CMSSW_BASE/src - mkdir CombineHarvester; cd CombineHarvester - git init - git remote add origin https://github.com/cms-analysis/CombineHarvester.git - git config core.sparsecheckout true; echo CombineTools/python >> .git/info/sparse-checkout - git pull origin v2.0.0 - popd -fi diff --git a/CombineTools/scripts/sparse-checkout-plotting-ssh.sh b/CombineTools/scripts/sparse-checkout-plotting-ssh.sh deleted file mode 100644 index 8004bedb33e..00000000000 --- a/CombineTools/scripts/sparse-checkout-plotting-ssh.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/bin/sh -set -x -set -e - -if [ -z ${CMSSW_BASE+x} ]; then - echo "CMSSW environment not set!"; -else - pushd $CMSSW_BASE/src - mkdir CombineHarvester; cd CombineHarvester - git init - git remote add origin git@github.com:cms-analysis/CombineHarvester.git - git config core.sparsecheckout true; echo CombineTools/python >> .git/info/sparse-checkout - git pull origin v2.0.0 - popd -fi diff --git a/CombineTools/scripts/sparse-checkout-ssh.sh b/CombineTools/scripts/sparse-checkout-ssh.sh deleted file mode 100644 index 070d8d3b01a..00000000000 --- a/CombineTools/scripts/sparse-checkout-ssh.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/bin/sh -set -x -set -e - -if [ -z ${CMSSW_BASE+x} ]; then - echo "CMSSW environment not set!"; -else - pushd $CMSSW_BASE/src - mkdir CombineHarvester; cd CombineHarvester - git init - git remote add origin git@github.com:cms-analysis/CombineHarvester.git - git config core.sparsecheckout true; echo CombineTools/ >> .git/info/sparse-checkout - git pull origin v2.0.0 - popd -fi diff --git a/README.md b/README.md index 1a2372e5e43..88747863529 100644 --- a/README.md +++ b/README.md @@ -4,25 +4,17 @@ Full documentation: http://cms-analysis.github.io/CombineHarvester ## Quick start -This package requires HiggsAnalysis/CombinedLimit to be in your local CMSSW area. We follow the release recommendations of the combine developers which can be found [here](https://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/#setting-up-the-environment-and-installation). The CombineHarvester framework is compatible with the CMSSW 10_2_X and 11_3_X series releases. The default branch, `main`, is for developments in the 11_3_X releases, and the current recommended tag is `v2.0.0`. The `102x` branch should be used in CMSSW_10_2_X, and is expected to receive only minor updates. - -If you just need the core CombineHarvester/CombineTools subpackage, then the following scripts can be used to clone the repository with a sparse checkout for this one only: - - git clone via ssh: - bash <(curl -s https://raw.githubusercontent.com/cms-analysis/CombineHarvester/main/CombineTools/scripts/sparse-checkout-ssh.sh) - git clone via https: - bash <(curl -s https://raw.githubusercontent.com/cms-analysis/CombineHarvester/main/CombineTools/scripts/sparse-checkout-https.sh) +This package requires HiggsAnalysis/CombinedLimit to be in your local CMSSW area. We follow the release recommendations of the combine developers which can be found [here](https://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/#setting-up-the-environment-and-installation). The CombineHarvester framework is compatible with the CMSSW 14_1_X and 11_3_X series releases. The default branch, `main`, is for developments in the 14_1_X releases, and the current recommended tag is `v3.0.0-pre1`. The `v2.1.0` tag should be used in CMSSW_11_3_X. A new full release area can be set up and compiled in the following steps: - export SCRAM_ARCH=slc7_amd64_gcc900 - scram project CMSSW CMSSW_11_3_4 - cd CMSSW_11_3_4/src + cmsrel CMSSW_14_1_0_pre4 + cd CMSSW_14_1_0_pre4/src cmsenv git clone https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit.git HiggsAnalysis/CombinedLimit # IMPORTANT: Checkout the recommended tag on the link above git clone https://github.com/cms-analysis/CombineHarvester.git CombineHarvester - git checkout v2.0.0 + git checkout v3.0.0-pre1 scram b Previously this package contained some analysis-specific subpackages. These packages can now be found [here](https://gitlab.cern.ch/cms-hcg/ch-areas). If you would like a repository for your analysis package to be created in that group, please create an issue in the CombineHarvester repository stating the desired package name and your NICE username. Note: you are not obliged to store your analysis package in this central group. diff --git a/docs/Main.md b/docs/Main.md index 8d0ec4c62c8..c31aa69c23c 100644 --- a/docs/Main.md +++ b/docs/Main.md @@ -31,16 +31,15 @@ This repository is a "top-level" CMSSW package, i.e. it should be located at `$C * **CombineHarvester/CombineTools**, which contains the CombineHarvester class and other parts of the core framework * **CombineHarvester/CombinePdfs**, which provides tools for building custom RooFit pdfs -The CMSSW version that should be used with CombineHarvester is driven by the recommendation for the HiggsAnalysis/CombinedLimit package, which is also required. The latest instructions can be found [here](https://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/#setting-up-the-environment-and-installation). The CombineHarvester framework is compatible with the CMSSW 10_2_X and 11_3_X series releases. A new release area can be set up and compiled in the following steps: +The CMSSW version that should be used with CombineHarvester is driven by the recommendation for the HiggsAnalysis/CombinedLimit package, which is also required. The latest instructions can be found [here](https://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/#setting-up-the-environment-and-installation). The CombineHarvester framework is compatible with the CMSSW 14_1_X and 11_3_X series releases. A new release area can be set up and compiled in the following steps: - export SCRAM_ARCH=slc7_amd64_gcc900 - scram project CMSSW CMSSW_11_3_4 - cd CMSSW_11_3_4/src + cmsrel CMSSW_14_1_0_pre4 + cd CMSSW_14_1_0_pre4/src cmsenv git clone https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit.git HiggsAnalysis/CombinedLimit # IMPORTANT: Checkout the recommended tag on the link above git clone https://github.com/cms-analysis/CombineHarvester.git CombineHarvester - git checkout v2.0.0 + git checkout v3.0.0-pre1 scram b If you are using this framework for the first time we recommend taking a look through some of the examples below which demonstrate the main features: