From 610d8ded8d1f71ed4db4d634cd9e2d7b8ae7b560 Mon Sep 17 00:00:00 2001 From: Andrew Gilbert Date: Wed, 25 Jan 2023 11:58:04 +0100 Subject: [PATCH] updating release docs --- CombineTools/scripts/sparse-checkout-https.sh | 1 + .../scripts/sparse-checkout-plotting-https.sh | 1 + .../scripts/sparse-checkout-plotting-ssh.sh | 1 + CombineTools/scripts/sparse-checkout-ssh.sh | 1 + README.md | 15 ++++++++------- docs/Main.md | 9 +++++---- 6 files changed, 17 insertions(+), 11 deletions(-) diff --git a/CombineTools/scripts/sparse-checkout-https.sh b/CombineTools/scripts/sparse-checkout-https.sh index 1190ac735ea..5e73fba80fd 100644 --- a/CombineTools/scripts/sparse-checkout-https.sh +++ b/CombineTools/scripts/sparse-checkout-https.sh @@ -11,5 +11,6 @@ else 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 113x + git checkout v2.0.0 popd fi diff --git a/CombineTools/scripts/sparse-checkout-plotting-https.sh b/CombineTools/scripts/sparse-checkout-plotting-https.sh index eb94e076f41..190fec9776f 100644 --- a/CombineTools/scripts/sparse-checkout-plotting-https.sh +++ b/CombineTools/scripts/sparse-checkout-plotting-https.sh @@ -11,5 +11,6 @@ else 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 113x + git checkout v2.0.0 popd fi diff --git a/CombineTools/scripts/sparse-checkout-plotting-ssh.sh b/CombineTools/scripts/sparse-checkout-plotting-ssh.sh index 3313ecf23e6..67debc390f0 100644 --- a/CombineTools/scripts/sparse-checkout-plotting-ssh.sh +++ b/CombineTools/scripts/sparse-checkout-plotting-ssh.sh @@ -11,5 +11,6 @@ else 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 113x + git checkout v2.0.0 popd fi diff --git a/CombineTools/scripts/sparse-checkout-ssh.sh b/CombineTools/scripts/sparse-checkout-ssh.sh index 831f3154309..0a00028f980 100644 --- a/CombineTools/scripts/sparse-checkout-ssh.sh +++ b/CombineTools/scripts/sparse-checkout-ssh.sh @@ -11,5 +11,6 @@ else 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 113x + git checkout v2.0.0 popd fi diff --git a/README.md b/README.md index 5c945cb23ca..1a2372e5e43 100644 --- a/README.md +++ b/README.md @@ -4,24 +4,25 @@ Full documentation: http://cms-analysis.github.io/CombineHarvester ## Quick start -This pacakge 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 8_1_X and 10_2_X series releases. For the 11_2_X series we require a number of changes to the python interface code, and a special branch `112x` has been prepared, but note that this has not been tested or validated yet. +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 subpackge, then the following scripts can be used to clone the repository with a sparse checkout for this one only: +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/master/CombineTools/scripts/sparse-checkout-ssh.sh) + 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/master/CombineTools/scripts/sparse-checkout-https.sh) + bash <(curl -s https://raw.githubusercontent.com/cms-analysis/CombineHarvester/main/CombineTools/scripts/sparse-checkout-https.sh) A new full release area can be set up and compiled in the following steps: - export SCRAM_ARCH=slc7_amd64_gcc700 - scram project CMSSW CMSSW_10_2_13 - cd CMSSW_10_2_13/src + export SCRAM_ARCH=slc7_amd64_gcc900 + scram project CMSSW CMSSW_11_3_4 + cd CMSSW_11_3_4/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 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 4419dcf1051..8d0ec4c62c8 100644 --- a/docs/Main.md +++ b/docs/Main.md @@ -31,15 +31,16 @@ 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 8_1_X and 10_2_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 10_2_X and 11_3_X series releases. A new release area can be set up and compiled in the following steps: - export SCRAM_ARCH=slc6_amd64_gcc530 - scram project CMSSW CMSSW_10_2_13 - cd CMSSW_10_2_13/src + export SCRAM_ARCH=slc7_amd64_gcc900 + scram project CMSSW CMSSW_11_3_4 + cd CMSSW_11_3_4/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 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: