From a90443b8bf3fa28eb1427710cb2240a7fb23c07b Mon Sep 17 00:00:00 2001 From: Andrew Gilbert Date: Fri, 12 Apr 2019 11:10:23 +0200 Subject: [PATCH 1/5] updating the docs in preparation for new tags --- docs/index.md | 36 ++++++++++++++++++++++++++++++++---- docs/releaseNotes.md | 12 ++++++++++++ 2 files changed, 44 insertions(+), 4 deletions(-) create mode 100644 docs/releaseNotes.md diff --git a/docs/index.md b/docs/index.md index 27108d476b6..31839a30517 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,24 +18,52 @@ The instructions below are for installation within a CMSSW environment You can find the latest releases on github under [https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/releases](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/releases) -### ROOT6 SLC6 release `CMSSW_8_1_X` - recommended version +### CC7 release `CMSSW_10_2_X` - validation in progress + +Once validation is completed this release will be the recommended version of combine to run. + +Setting up the environment (once): + +```sh +export SCRAM_ARCH=slc7_amd64_gcc700 + +cmsrel CMSSW_10_2_13 +cd CMSSW_10_2_13/src +cmsenv +git clone https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit.git HiggsAnalysis/CombinedLimit +cd HiggsAnalysis/CombinedLimit +``` +Update to a reccomended tag - currently the reccomended tag is **v8.0.0**: + +```sh +cd $CMSSW_BASE/src/HiggsAnalysis/CombinedLimit +git fetch origin +git checkout v8.0.0 +scramv1 b clean; scramv1 b # always make a clean build +``` + +### ROOT6 SLC6/CC7 release `CMSSW_8_1_X` - recommended version Setting up the environment (once): ```sh -export SCRAM_ARCH=slc6_64_gcc530 +# For CC7: +export SCRAM_ARCH=slc7_64_gcc530 +# For SLC6: +export SCRAM_ARCH=slc7_64_gcc530 + cmsrel CMSSW_8_1_0 cd CMSSW_8_1_0/src cmsenv git clone https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit.git HiggsAnalysis/CombinedLimit cd HiggsAnalysis/CombinedLimit ``` -Update to a reccomended tag - currently the reccomended tag is **v7.0.12**: +Update to a reccomended tag - currently the reccomended tag is **v7.0.13**: ```sh cd $CMSSW_BASE/src/HiggsAnalysis/CombinedLimit git fetch origin -git checkout v7.0.12 +git checkout v7.0.13 scramv1 b clean; scramv1 b # always make a clean build ``` diff --git a/docs/releaseNotes.md b/docs/releaseNotes.md new file mode 100644 index 00000000000..a5123a967f4 --- /dev/null +++ b/docs/releaseNotes.md @@ -0,0 +1,12 @@ +# Release notes + +## CMSSW 10_2_X - v8.0.0 + + +## CMSSW 8_1_X - v7.0.13 + + - Nuisance `edit` selections for bins, processes or systematic names now require a complete string match. For example, `nuisance edit add procA binA [...]` will no longer match `procAB` and `binAB`. Note that regex selections can still be used to match multiple labels, but again are now required to match the full strings. + - Nuisance parameters can now be frozen using attributes that have been assigned to the corresponding RooRealVars. Syntax is `--freezeWithAttributes attr1,attr2,...,attrN`. + - **[EXPERIMENTAL]** For binned analyses using autoMCStats a faster implementation of the vertical template morphing for shape uncertainties can be enabled at runtime with the option `--X-rtd FAST_VERTICAL_MORPH`. Any results using this flag should be validated carefully against the default. + - The possibility to use some old method names has now been fully removed. When setting the `-M` option, `FitDiagnostics`, `AsymptoticLimits` and `Significance` must be used instead of, respectively, `MaxLikelihoodFit`, `Asymptotic` and `ProfileLikelihood`. + - For Higgs analyses: added YR4 cross sections, branching ratios and partial width uncertainties in `data/lhc-hxswg/sm/`, as used in HIG-17-031 From b627988ec03667bc9e0a947ce3d5c6d117bc2d6e Mon Sep 17 00:00:00 2001 From: Andrew Gilbert Date: Fri, 12 Apr 2019 11:12:26 +0200 Subject: [PATCH 2/5] Update index.md --- docs/index.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 31839a30517..38a4e91480a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,13 +20,12 @@ You can find the latest releases on github under [https://github.com/cms-analysi ### CC7 release `CMSSW_10_2_X` - validation in progress -Once validation is completed this release will be the recommended version of combine to run. +Once validation is complete this release will become the recommended version. Setting up the environment (once): ```sh export SCRAM_ARCH=slc7_amd64_gcc700 - cmsrel CMSSW_10_2_13 cd CMSSW_10_2_13/src cmsenv @@ -42,7 +41,7 @@ git checkout v8.0.0 scramv1 b clean; scramv1 b # always make a clean build ``` -### ROOT6 SLC6/CC7 release `CMSSW_8_1_X` - recommended version +### SLC6/CC7 release `CMSSW_8_1_X` - recommended version Setting up the environment (once): @@ -50,7 +49,7 @@ Setting up the environment (once): # For CC7: export SCRAM_ARCH=slc7_64_gcc530 # For SLC6: -export SCRAM_ARCH=slc7_64_gcc530 +export SCRAM_ARCH=slc6_64_gcc530 cmsrel CMSSW_8_1_0 cd CMSSW_8_1_0/src From 4de7dbd17e62305876050e62edf41e4c2627e4ae Mon Sep 17 00:00:00 2001 From: Andrew Gilbert Date: Fri, 12 Apr 2019 11:28:05 +0200 Subject: [PATCH 3/5] Update releaseNotes.md --- docs/releaseNotes.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/releaseNotes.md b/docs/releaseNotes.md index a5123a967f4..4de6c56f0d4 100644 --- a/docs/releaseNotes.md +++ b/docs/releaseNotes.md @@ -2,11 +2,17 @@ ## CMSSW 10_2_X - v8.0.0 +This release contains all of the changes listed for v7.0.13 below. In addition: + +- New [documentation pages](https://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/), using the [mkdocs](http://mkdocs.org) framework. The documentation source is included in the repository as [simple markdown files](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/tree/102x/docs). Users are welcome to make additions and corrections as pull requests to this repo. +- It is now possible to include additional constraint terms for regularisiation when unfolding using combine. Detailed documentation for this is given [here](https://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/part3/regularisation/). +- The option `-S 0` to remove all systematic uncertainties has been removed. Instead, to freeze all constrained nuisance parameters the option `--freezeParameters allConstrainedNuisances` should be used, which replaces the previous shortcut of `--freezeParameters all`. +- The possibility to use some old method names has now been fully removed. When setting the `-M` option, `FitDiagnostics`, `AsymptoticLimits` and `Significance` must be used instead of, respectively, `MaxLikelihoodFit`, `Asymptotic` and `ProfileLikelihood`. + ## CMSSW 8_1_X - v7.0.13 - Nuisance `edit` selections for bins, processes or systematic names now require a complete string match. For example, `nuisance edit add procA binA [...]` will no longer match `procAB` and `binAB`. Note that regex selections can still be used to match multiple labels, but again are now required to match the full strings. - Nuisance parameters can now be frozen using attributes that have been assigned to the corresponding RooRealVars. Syntax is `--freezeWithAttributes attr1,attr2,...,attrN`. + - For Higgs analyses: added YR4 cross sections, branching ratios and partial width uncertainties in `data/lhc-hxswg/sm/`, as used in HIG-17-031 - **[EXPERIMENTAL]** For binned analyses using autoMCStats a faster implementation of the vertical template morphing for shape uncertainties can be enabled at runtime with the option `--X-rtd FAST_VERTICAL_MORPH`. Any results using this flag should be validated carefully against the default. - - The possibility to use some old method names has now been fully removed. When setting the `-M` option, `FitDiagnostics`, `AsymptoticLimits` and `Significance` must be used instead of, respectively, `MaxLikelihoodFit`, `Asymptotic` and `ProfileLikelihood`. - - For Higgs analyses: added YR4 cross sections, branching ratios and partial width uncertainties in `data/lhc-hxswg/sm/`, as used in HIG-17-031 From b8feac5b17140af253d3f96ef09c65ec93ae4165 Mon Sep 17 00:00:00 2001 From: Andrew Gilbert Date: Fri, 12 Apr 2019 11:31:23 +0200 Subject: [PATCH 4/5] removing unneeded printout --- src/Combine.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Combine.cc b/src/Combine.cc index 30090770653..4f8c8290c7e 100644 --- a/src/Combine.cc +++ b/src/Combine.cc @@ -1234,7 +1234,7 @@ void Combine::addDiscreteNuisances(RooWorkspace *w){ RooArgSet clients; utils::getClients(CascadeMinimizerGlobalConfigs::O().pdfCategories,(w->allPdfs()),clients); TIterator *it = clients.createIterator(); - clients.Print(); + // clients.Print(); while (RooAbsArg *arg = (RooAbsArg*)it->Next()) { (CascadeMinimizerGlobalConfigs::O().allRooMultiPdfs).add(*(dynamic_cast(arg))); RooAbsPdf *pdf = dynamic_cast(arg); From 066ba630976443c59c825712a3cfedf2aed7c4d7 Mon Sep 17 00:00:00 2001 From: nckw Date: Fri, 12 Apr 2019 12:04:22 +0100 Subject: [PATCH 5/5] Add a new sub-section for tag comparison Separate tag comparison text to help users see what has changed between tags --- docs/index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/index.md b/docs/index.md index 38a4e91480a..acc54682eeb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -66,6 +66,9 @@ git checkout v7.0.13 scramv1 b clean; scramv1 b # always make a clean build ``` + +## What has changed between tags? + You can generate a diff of any two tags (eg for `v7.0.8` and `v7.0.6`) by using following the url: [https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/compare/v7.0.6...v7.0.7](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/compare/v7.0.6...v7.0.7)