From 4a6bdec59a744dc2a1fbe60f014c2622604e2586 Mon Sep 17 00:00:00 2001 From: nckw Date: Wed, 19 Jun 2024 11:19:40 +0100 Subject: [PATCH 1/2] Updating CH instructions for checkout since not needed as much now (and some other places in the docs --- docs/index.md | 23 +++++++---------------- docs/part3/commonstatsmethods.md | 6 +++--- docs/part3/nonstandard.md | 2 +- docs/part3/runningthetool.md | 2 +- docs/part3/validation.md | 4 ++-- 5 files changed, 14 insertions(+), 23 deletions(-) diff --git a/docs/index.md b/docs/index.md index f4f3110ae68..ccc84c7a2be 100644 --- a/docs/index.md +++ b/docs/index.md @@ -262,29 +262,20 @@ See [contributing.md](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimi ## CombineHarvester/CombineTools -!!! info - Starting with Combine v10, CombineTool functionalities for job submition and parallelization (combineTool.py) as well as many plotting functions have been integrated into the Combine package. - For these tasks you no longer have to follow the instructions below. - +CombineHarvester/CombineTools is a package for the creation of datacards/workspaces used with Combine v10 for a number of analyses in CMS. See the [`CombineHarvester`](http://cms-analysis.github.io/CombineHarvester/) documentation pages for more details on using this tool and additional features available in the full package. -CombineTools is an additional packages with useful features for Combine, which is used for example for the automated datacard validation (see [instructions](docs/part3/validation)). -Since the repository contains a certain amount of analysis-specific code, the following scripts can be used to clone it with a sparse checkout for just the core [`CombineHarvester/CombineTools`](https://github.com/cms-analysis/CombineHarvester/tree/main/CombineTools/) subpackage, speeding up the checkout and compile times: - -git clone via ssh: +This package also comes with useful features for Combine such as the automated datacard validation (see [instructions](docs/part3/validation)). The repository can be checked out and compiled using, ```sh -bash <(curl -s https://raw.githubusercontent.com/cms-analysis/CombineHarvester/main/CombineTools/scripts/sparse-checkout-ssh.sh) +git clone https://github.com/cms-analysis/CombineHarvester.git CombineHarvester +scram b ``` -git clone via https: +See the [`Combi neHarvester`](http://cms-analysis.github.io/CombineHarvester/) documentation for full instructions and reccomended versions. -```sh -bash <(curl -s https://raw.githubusercontent.com/cms-analysis/CombineHarvester/main/CombineTools/scripts/sparse-checkout-https.sh) -``` - -make sure to run `scram` to compile the `CombineTools` package. +!!! info + Starting with Combine v10, specific ombineTool functionalities for job submition and parallelization (`combineTool.py`) as well as many plotting functions have been integrated into the Combine package. For these tasks you no longer have to follow the instructions above. -See the [`CombineHarvester`](http://cms-analysis.github.io/CombineHarvester/) documentation pages for more details on using this tool and additional features available in the full package. ## Citation diff --git a/docs/part3/commonstatsmethods.md b/docs/part3/commonstatsmethods.md index 78946e2ac70..91525452513 100644 --- a/docs/part3/commonstatsmethods.md +++ b/docs/part3/commonstatsmethods.md @@ -585,7 +585,7 @@ You should note that Combine will !!! warning This option should not be used with `--expectedFromGrid` if you did not create the grid with the same option. The reason is that the value of the test-statistic that is used to calculate the limit will not be properly calcualted if `--noUpdateGrid` is included. In future versions of the tool, this option will be ignored if using `--expectedFromGrid`. -The splitting of the jobs can be left to the user's preference. However, users may wish to use the **combineTool** for automating this, as described in the section on [combineTool for job submission](http://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/part3/runningthetool/#combinetool-for-job-submission) +The splitting of the jobs can be left to the user's preference. However, users may wish to use `combineTool.py` for automating this, as described in the section on [combineTool for job submission](http://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/part3/runningthetool/#combinetool-for-job-submission) #### Plotting @@ -656,7 +656,7 @@ The *expected* significance, assuming a signal with **r=X** can be calculated, b The total number of background toys needs to be large enough to compute the value of the significance, but you need fewer signal toys (especially when you are only computing the median expected significance). For large significances, you can run most of the toys without the `--fullBToys` option, which will be about a factor 2 faster. Only a small part of the toys needs to be run with that option turned on. -As with calculating limits with toys, these jobs can be submitted to the grid or batch systems with the help of the `combineTool`, as described in the section on [combineTool for job submission](http://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/part3/runningthetool/#combinetool-for-job-submission) +As with calculating limits with toys, these jobs can be submitted to the grid or batch systems with the help of the `combineTool.py` script, as described in the section on [combineTool for job submission](http://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/part3/runningthetool/#combinetool-for-job-submission) ## Goodness of fit tests @@ -763,7 +763,7 @@ where the former gives the result for the S+B model, while the latter gives the ### Making a plot of the GoF test statistic distribution -If you have also checked out the [combineTool](http://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/#combine-tool), you can use this to run batch jobs or on the grid (see [here](http://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/part3/runningthetool/#combinetool-for-job-submission)) and produce a plot of the results. Once the jobs have completed, you can hadd them together and run (e.g for the saturated model), +You can use the `combineTool.py` script to run batch jobs or on the grid (see [here](http://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/part3/runningthetool/#combinetool-for-job-submission)) and produce a plot of the results. Once the jobs have completed, you can hadd them together and run (e.g for the saturated model), ```sh combineTool.py -M CollectGoodnessOfFit --input data_run.root toys_run.root -m 125.0 -o gof.json diff --git a/docs/part3/nonstandard.md b/docs/part3/nonstandard.md index 7495dd3228f..7ac7f94e05c 100644 --- a/docs/part3/nonstandard.md +++ b/docs/part3/nonstandard.md @@ -223,7 +223,7 @@ The impact of a nuisance parameter (NP) θ on a parameter of interest (POI) μ i This is effectively a measure of the correlation between the NP and the POI, and is useful for determining which NPs have the largest effect on the POI uncertainty. -It is possible to use the `MultiDimFit` method of Combine with the option `--algo impact -P parameter` to calculate the impact of a particular nuisance parameter on the parameter(s) of interest. We will use the `combineTool.py` script to automate the fits (see the [`combineTool`](http://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/#combine-tool) section to check out the tool. +It is possible to use the `MultiDimFit` method of Combine with the option `--algo impact -P parameter` to calculate the impact of a particular nuisance parameter on the parameter(s) of interest. We will use the `combineTool.py` script to automate the fits. We will use an example workspace from the [$H\rightarrow\tau\tau$ datacard](https://github.com/cms-analysis/HiggsAnalysis-CombinedLimit/blob/main/data/tutorials/htt/125/htt_tt.txt), diff --git a/docs/part3/runningthetool.md b/docs/part3/runningthetool.md index cc7f2ebe638..95a53057d45 100644 --- a/docs/part3/runningthetool.md +++ b/docs/part3/runningthetool.md @@ -230,7 +230,7 @@ Here are a few examples of calculations with toys from post-fit workspaces using ## combineTool for job submission -For longer tasks that cannot be run locally, several methods in Combine can be split to run on a *batch* system or on the *Grid*. The splitting and submission is handled using the `combineTool` (see [this getting started](http://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/#combine-tool) section to check out the tool) +For longer tasks that cannot be run locally, several methods in Combine can be split to run on a *batch* system or on the *Grid*. The splitting and submission is handled using the `combineTool.py` script. ### Submission to Condor diff --git a/docs/part3/validation.md b/docs/part3/validation.md index d0d8191e94e..d8f8685112a 100644 --- a/docs/part3/validation.md +++ b/docs/part3/validation.md @@ -1,8 +1,8 @@ # Validating datacards This section covers the main features of the datacard validation tool that helps you spot potential problems with your datacards at an early stage. The tool is implemented -in the [`CombineHarvester/CombineTools`](https://github.com/cms-analysis/CombineHarvester/blob/113x/CombineTools) subpackage. See the [`combineTool`](http://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/#combine-tool) -section of the documentation for checkout instructions. +in the [`CombineHarvester/CombineTools`](https://github.com/cms-analysis/CombineHarvester/blob/113x/CombineTools) subpackage. See the [`combineTool`](https://cms-analysis.github.io/HiggsAnalysis-CombinedLimit/latest/#combineharvestercombinetools) +section of the documentation for checkout instructions for the full tool, which is needed for this task. The datacard validation tool contains a number of checks. It is possible to call subsets of these checks when creating datacards within `CombineHarvester`. However, for now we will only describe the usage of the validation tool on already existing datacards. If you create your datacards with `CombineHarvester` and would like to include the checks at the datacard creation From cd29ed52377cfe7a51f62666f1fe547330e2bf18 Mon Sep 17 00:00:00 2001 From: Aliya Nigamova Date: Wed, 19 Jun 2024 13:49:11 +0200 Subject: [PATCH 2/2] removing spaces --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index ccc84c7a2be..713abef9b4f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -271,7 +271,7 @@ git clone https://github.com/cms-analysis/CombineHarvester.git CombineHarvester scram b ``` -See the [`Combi neHarvester`](http://cms-analysis.github.io/CombineHarvester/) documentation for full instructions and reccomended versions. +See the [`CombineHarvester`](http://cms-analysis.github.io/CombineHarvester/) documentation for full instructions and reccomended versions. !!! info Starting with Combine v10, specific ombineTool functionalities for job submition and parallelization (`combineTool.py`) as well as many plotting functions have been integrated into the Combine package. For these tasks you no longer have to follow the instructions above.