quickstats

Name	quickstats JSON
Version	0.7.0.4 JSON
	download
home_page	None
Summary	A tool for quick statistical analysis for HEP experiments
upload_time	2024-04-25 03:42:38
maintainer	None
docs_url	None
author	Alkaid Cheng
requires_python	>=3.7
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Setup

Clone the repository:
```
git clone ssh://git@gitlab.cern.ch:7999/clcheng/quickstats.git
```

### 1. CERN User

To set up from lxplus, just do
```
source setup.sh
```

### 2. Genearl User

To set up locally, make sure you have pyROOT 6.24+ installed (using conda is recommended), and do
```
pip install quickstats
```

### Installing pyROOT

Simplest way to install pyROOT is via conda
```
conda install -c conda-forge ROOT
```

## Important: First-time compilation

To compile c++ dependencies, do this for first time use
```
quickstats compile
```

# Command Line Tools

## Run Nuisance Parameter Pulls and Ranking
```
quickstats run_pulls -i <input_ws_path> -d <dataset_name> -p <np_name/pattern> --poi <poi_name> --parallel -1 -o <output_dir>
```

The following options are available

| **Option** | **Description** | **Default** |
| ---------- | ---------- | ----------- | 
| `-i/--input_file` | Path to the input workspace file | - |
| `-w/--workspace` | Name of workspace. Auto-detect by default. | None |
| `-m/--model_config` | Name of model config. Auto-detect by default. | None |
| `-d/--data` | Name of dataset | "combData" |
| `-p/--parameter` | Nuisance parameter(s) to run pulls on. Multiple parameters are separated by commas. Wildcards are accepted. All NPs will be run over by default| "" |
| `-x/--poi` | POIs to measure. If empty, impact on POI will not be calculated. | "" |
| `-r/--profile` | Parameters to profile | "" |
| `-f/--fix` | Parameters to fix | "" |
| `-s/--snapshot` | Name of initial snapshot | "nominalNuis" |
| `-o/--outdir` | Output directory | "pulls" |
| `-t/--minimizer_type` | Minimizer type | "Minuit2" |
| `-a/--minimizer_algo` | Minimizer algorithm | "Migrad" |
| `-c/--num_cpu` | Number of CPUs to use per parameter | 1 |
| `--binned/--unbinned` | Whether to use binned likelihood | True |
| `-q/--precision` | Precision for scan | 0.001 |
| `-e/--eps` | Tolerance | 1.0 |
| `-l/--log_level` | Log level | "INFO" |
| `--eigen/--no-eigen` | Compute eigenvalues and vectors | False |
| `--strategy`  | Default fit strategy | 0 |
| `--fix-cache/--no-fix-cache` | Fix StarMomentMorph cache | True |
| `--fix-multi/--no-fix-multi` |  Fix MultiPdf level 2 | True |
| `--offset/--no-offset` | Offset likelihood | True |
| `--optimize/--no-optimize` | Optimize constant terms | True |
| `--max_calls` | Maximum number of function calls | -1 |
| `--max_iters` | Maximum number of Minuit iterations | -1 |
| `--parallel` | Parallelize job across different nuisanceparameters using N workers. Use -1 for N_CPU workers. | 0 |
| `--cache/--no-cache` | Cache existing result | True |
| `--exclude` | Exclude NPs (wildcard is accepted) | "" |

## Plot Nuisance Parameter Pulls and Ranking

```
quickstats plot_pulls --help
```

## Likelihood Fit (Best-fit)
```
quickstats likelihood_fit --help
```

## Run Likelihood Scan

```
quickstats likelihood_scan --help
```

## Asymptotic CLs Limit

```
quickstats cls_limit --help
```

## CLs Limit Scan

```
quickstats limit_scan --help
```


## Generate Asimov dataset
```
quickstats generate_standard_asimov --help
```

## Inspect Workspace
```
quickstats inspect_workspace --help
```

## Create Workspace from XML Cards
```
quickstats build_xml_ws --help
```


## Modify Workspace from XML Cards or Json Config
```
quickstats modify_ws --help
```


## Combine Workspace from XML Cards or Json Config
```
quickstats combine_ws --help
```

## Compare Workspaces
```
quickstats compare_ws --help
```

## Run Event Loop from Custom Config File
```
quickstats process_rfile --help
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "quickstats",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": null,
    "author": "Alkaid Cheng",
    "author_email": "chi.lung.cheng@cern.ch",
    "download_url": "https://files.pythonhosted.org/packages/35/65/9aaa5821de568596f3117423f05306091a65df738de44069a241e22c18a7/quickstats-0.7.0.4.tar.gz",
    "platform": null,
    "description": "# Setup\n\nClone the repository:\n```\ngit clone ssh://git@gitlab.cern.ch:7999/clcheng/quickstats.git\n```\n\n### 1. CERN User\n\nTo set up from lxplus, just do\n```\nsource setup.sh\n```\n\n### 2. Genearl User\n\nTo set up locally, make sure you have pyROOT 6.24+ installed (using conda is recommended), and do\n```\npip install quickstats\n```\n\n### Installing pyROOT\n\nSimplest way to install pyROOT is via conda\n```\nconda install -c conda-forge ROOT\n```\n\n## Important: First-time compilation\n\nTo compile c++ dependencies, do this for first time use\n```\nquickstats compile\n```\n\n# Command Line Tools\n\n## Run Nuisance Parameter Pulls and Ranking\n```\nquickstats run_pulls -i <input_ws_path> -d <dataset_name> -p <np_name/pattern> --poi <poi_name> --parallel -1 -o <output_dir>\n```\n\nThe following options are available\n\n| **Option** | **Description** | **Default** |\n| ---------- | ---------- | ----------- | \n| `-i/--input_file` | Path to the input workspace file | - |\n| `-w/--workspace` | Name of workspace. Auto-detect by default. | None |\n| `-m/--model_config` | Name of model config. Auto-detect by default. | None |\n| `-d/--data` | Name of dataset | \"combData\" |\n| `-p/--parameter` | Nuisance parameter(s) to run pulls on. Multiple parameters are separated by commas. Wildcards are accepted. All NPs will be run over by default| \"\" |\n| `-x/--poi` | POIs to measure. If empty, impact on POI will not be calculated. | \"\" |\n| `-r/--profile` | Parameters to profile | \"\" |\n| `-f/--fix` | Parameters to fix | \"\" |\n| `-s/--snapshot` | Name of initial snapshot | \"nominalNuis\" |\n| `-o/--outdir` | Output directory | \"pulls\" |\n| `-t/--minimizer_type` | Minimizer type | \"Minuit2\" |\n| `-a/--minimizer_algo` | Minimizer algorithm | \"Migrad\" |\n| `-c/--num_cpu` | Number of CPUs to use per parameter | 1 |\n| `--binned/--unbinned` | Whether to use binned likelihood | True |\n| `-q/--precision` | Precision for scan | 0.001 |\n| `-e/--eps` | Tolerance | 1.0 |\n| `-l/--log_level` | Log level | \"INFO\" |\n| `--eigen/--no-eigen` | Compute eigenvalues and vectors | False |\n| `--strategy`  | Default fit strategy | 0 |\n| `--fix-cache/--no-fix-cache` | Fix StarMomentMorph cache | True |\n| `--fix-multi/--no-fix-multi` |  Fix MultiPdf level 2 | True |\n| `--offset/--no-offset` | Offset likelihood | True |\n| `--optimize/--no-optimize` | Optimize constant terms | True |\n| `--max_calls` | Maximum number of function calls | -1 |\n| `--max_iters` | Maximum number of Minuit iterations | -1 |\n| `--parallel` | Parallelize job across different nuisanceparameters using N workers. Use -1 for N_CPU workers. | 0 |\n| `--cache/--no-cache` | Cache existing result | True |\n| `--exclude` | Exclude NPs (wildcard is accepted) | \"\" |\n\n## Plot Nuisance Parameter Pulls and Ranking\n\n```\nquickstats plot_pulls --help\n```\n\n## Likelihood Fit (Best-fit)\n```\nquickstats likelihood_fit --help\n```\n\n## Run Likelihood Scan\n\n```\nquickstats likelihood_scan --help\n```\n\n## Asymptotic CLs Limit\n\n```\nquickstats cls_limit --help\n```\n\n## CLs Limit Scan\n\n```\nquickstats limit_scan --help\n```\n\n\n## Generate Asimov dataset\n```\nquickstats generate_standard_asimov --help\n```\n\n## Inspect Workspace\n```\nquickstats inspect_workspace --help\n```\n\n## Create Workspace from XML Cards\n```\nquickstats build_xml_ws --help\n```\n\n\n## Modify Workspace from XML Cards or Json Config\n```\nquickstats modify_ws --help\n```\n\n\n## Combine Workspace from XML Cards or Json Config\n```\nquickstats combine_ws --help\n```\n\n## Compare Workspaces\n```\nquickstats compare_ws --help\n```\n\n## Run Event Loop from Custom Config File\n```\nquickstats process_rfile --help\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A tool for quick statistical analysis for HEP experiments",
    "version": "0.7.0.4",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "087e1924af052888b673149a354b35586b4a75f1533c8407d79e04917f404cfd",
                "md5": "d6059fe8313af781ecbc69fea98979ee",
                "sha256": "7a7b78dddbd84a32b8de7c0d4e0ce7324e37229a85dd46cb77cc6d871b3b53d2"
            },
            "downloads": -1,
            "filename": "quickstats-0.7.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d6059fe8313af781ecbc69fea98979ee",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 556331,
            "upload_time": "2024-04-25T03:42:27",
            "upload_time_iso_8601": "2024-04-25T03:42:27.653591Z",
            "url": "https://files.pythonhosted.org/packages/08/7e/1924af052888b673149a354b35586b4a75f1533c8407d79e04917f404cfd/quickstats-0.7.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "35659aaa5821de568596f3117423f05306091a65df738de44069a241e22c18a7",
                "md5": "bb68a810d799e727c57062dcb6a4144c",
                "sha256": "2e0c06bae6717bf765cc60bdb0486ef47c08a581c95788133681fa4c3fbb4cc7"
            },
            "downloads": -1,
            "filename": "quickstats-0.7.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "bb68a810d799e727c57062dcb6a4144c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 450980,
            "upload_time": "2024-04-25T03:42:38",
            "upload_time_iso_8601": "2024-04-25T03:42:38.492627Z",
            "url": "https://files.pythonhosted.org/packages/35/65/9aaa5821de568596f3117423f05306091a65df738de44069a241e22c18a7/quickstats-0.7.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-25 03:42:38",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "quickstats"
}