Skip to content

Commit

Permalink
Merge pull request #326 from cms-analysis/update-docs-v3
Browse files Browse the repository at this point in the history
update docs
  • Loading branch information
ajgilbert authored Jun 19, 2024
2 parents 1d33886 + 29d916f commit 5144fd6
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 77 deletions.
15 changes: 0 additions & 15 deletions CombineTools/scripts/sparse-checkout-https.sh

This file was deleted.

15 changes: 0 additions & 15 deletions CombineTools/scripts/sparse-checkout-plotting-https.sh

This file was deleted.

15 changes: 0 additions & 15 deletions CombineTools/scripts/sparse-checkout-plotting-ssh.sh

This file was deleted.

15 changes: 0 additions & 15 deletions CombineTools/scripts/sparse-checkout-ssh.sh

This file was deleted.

16 changes: 4 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
9 changes: 4 additions & 5 deletions docs/Main.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 5144fd6

Please sign in to comment.