Skip to content

Commit

Permalink
Merge pull request #538 from cms-analysis/102x-release-docs
Browse files Browse the repository at this point in the history
updating the docs in preparation for new tags
  • Loading branch information
ajgilbert authored Apr 12, 2019
2 parents fa52dec + 066ba63 commit fb00aa1
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 4 deletions.
36 changes: 33 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,57 @@ 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 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
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
```

### SLC6/CC7 release `CMSSW_8_1_X` - recommended version

Setting up the environment (once):

```sh
# For CC7:
export SCRAM_ARCH=slc7_64_gcc530
# For SLC6:
export SCRAM_ARCH=slc6_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
```


## 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)
Expand Down
18 changes: 18 additions & 0 deletions docs/releaseNotes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Release notes

## 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.
2 changes: 1 addition & 1 deletion src/Combine.cc
Original file line number Diff line number Diff line change
Expand Up @@ -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<RooMultiPdf*>(arg)));
RooAbsPdf *pdf = dynamic_cast<RooAbsPdf*>(arg);
Expand Down

0 comments on commit fb00aa1

Please sign in to comment.