atlas-ftag-tools 0.0.8__tar.gz → 0.0.9__tar.gz

{atlas-ftag-tools-0.0.8 → atlas-ftag-tools-0.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atlas-ftag-tools
-Version: 0.0.8
+Version: 0.0.9
 Summary: ATLAS Flavour Tagging Tools
 Author: Sam Van Stroud, Philipp Gadow
 License: MIT
@@ -50,3 +50,27 @@ The script is `vds.py` and can be run after installing this package with
 ```
 vds <pattern> <output path>
 ```
+
+The `<pattern>` argument should be a quotes enclosed [glob pattern](https://en.wikipedia.org/wiki/Glob_(programming)), for example `"dsid/path/*.h5"`
+
+
+## Calculate WPs
+
+This package contains a script to calculate tagger working points (WPs).
+The script is `working_points.py` and can be run after installing this package with
+
+```
+wps \
+    --ttbar "path/to/ttbar/*.h5" \
+    --tagger GN120220509 \
+    --fx 0.1
+```
+
+Both the `--tagger` and `--fx` options accept a list if you want to get the WPs for multiple taggers.
+
+If you want to use the `ttbar` WPs get the efficiencies and rejections for the `zprime` sample, you can add `--zprime "path/to/zprime/*.h5"` to the command.
+Note that a default selection of $p_T > 250 ~GeV$ to jets in the `zprime` sample.
+
+By default the working points are printed to the terminal, but you can save the results to a YAML file with the `--outfile` option.
+
+Use `--help` for more options and information.

{atlas-ftag-tools-0.0.8 → atlas-ftag-tools-0.0.9}/README.md

@@ -39,3 +39,27 @@ The script is `vds.py` and can be run after installing this package with
 ```
 vds <pattern> <output path>
 ```
+
+The `<pattern>` argument should be a quotes enclosed [glob pattern](https://en.wikipedia.org/wiki/Glob_(programming)), for example `"dsid/path/*.h5"`
+
+
+## Calculate WPs
+
+This package contains a script to calculate tagger working points (WPs).
+The script is `working_points.py` and can be run after installing this package with
+
+```
+wps \
+    --ttbar "path/to/ttbar/*.h5" \
+    --tagger GN120220509 \
+    --fx 0.1
+```
+
+Both the `--tagger` and `--fx` options accept a list if you want to get the WPs for multiple taggers.
+
+If you want to use the `ttbar` WPs get the efficiencies and rejections for the `zprime` sample, you can add `--zprime "path/to/zprime/*.h5"` to the command.
+Note that a default selection of $p_T > 250 ~GeV$ to jets in the `zprime` sample.
+
+By default the working points are printed to the terminal, but you can save the results to a YAML file with the `--outfile` option.
+
+Use `--help` for more options and information.

{atlas-ftag-tools-0.0.8 → atlas-ftag-tools-0.0.9}/atlas_ftag_tools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atlas-ftag-tools
-Version: 0.0.8
+Version: 0.0.9
 Summary: ATLAS Flavour Tagging Tools
 Author: Sam Van Stroud, Philipp Gadow
 License: MIT
@@ -50,3 +50,27 @@ The script is `vds.py` and can be run after installing this package with
 ```
 vds <pattern> <output path>
 ```
+
+The `<pattern>` argument should be a quotes enclosed [glob pattern](https://en.wikipedia.org/wiki/Glob_(programming)), for example `"dsid/path/*.h5"`
+
+
+## Calculate WPs
+
+This package contains a script to calculate tagger working points (WPs).
+The script is `working_points.py` and can be run after installing this package with
+
+```
+wps \
+    --ttbar "path/to/ttbar/*.h5" \
+    --tagger GN120220509 \
+    --fx 0.1
+```
+
+Both the `--tagger` and `--fx` options accept a list if you want to get the WPs for multiple taggers.
+
+If you want to use the `ttbar` WPs get the efficiencies and rejections for the `zprime` sample, you can add `--zprime "path/to/zprime/*.h5"` to the command.
+Note that a default selection of $p_T > 250 ~GeV$ to jets in the `zprime` sample.
+
+By default the working points are printed to the terminal, but you can save the results to a YAML file with the `--outfile` option.
+
+Use `--help` for more options and information.

{atlas-ftag-tools-0.0.8 → atlas-ftag-tools-0.0.9}/atlas_ftag_tools.egg-info/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
 vds = ftag.vds:main
+wps = ftag.wps.working_points:main

atlas-ftag-tools-0.0.9/ftag/__init__.py

@@ -0,0 +1,25 @@
+"""atlas-ftag-tools - Common tools for ATLAS flavour tagging software."""
+
+
+__version__ = "v0.0.9"
+
+
+import ftag.hdf5 as hdf5
+from ftag.cuts import Cuts
+from ftag.flavour import Flavour, Flavours
+from ftag.mock import get_mock_file
+from ftag.sample import Sample
+from ftag.wps.discriminant import get_discriminant
+from ftag.wps.working_points import get_working_points
+
+__all__ = [
+    "Cuts",
+    "Flavour",
+    "Flavours",
+    "Sample",
+    "hdf5",
+    "get_mock_file",
+    "get_discriminant",
+    "get_working_points",
+    "__version__",
+]

{atlas-ftag-tools-0.0.8 → atlas-ftag-tools-0.0.9}/ftag/flavour.py

@@ -2,6 +2,9 @@ from __future__ import annotations
 
 from collections.abc import Generator
 from dataclasses import dataclass
+from pathlib import Path
+
+import yaml
 
 from ftag.cuts import Cuts
 
@@ -74,3 +77,10 @@ class FlavourContainer:
             if flavour.cuts == cuts:
                 return flavour
         raise KeyError(f"Flavour with {cuts} not found")
+
+
+with open(Path(__file__).parent / "flavours.yaml") as f:
+    flavours_yaml = yaml.safe_load(f)
+flavours_dict = {f["name"]: Flavour(cuts=Cuts.from_list(f.pop("cuts")), **f) for f in flavours_yaml}
+assert len(flavours_dict) == len(flavours_yaml), "Duplicate flavour names detected"
+Flavours = FlavourContainer(flavours_dict)

{atlas-ftag-tools-0.0.8 → atlas-ftag-tools-0.0.9}/ftag/vds.py

@@ -65,9 +65,11 @@ def create_virtual_file(
 def main():
     import argparse
 
-    parser = argparse.ArgumentParser(description="Create a virtual dataset from a glob pattern")
-    parser.add_argument("pattern", type=Path, help="Glob pattern of files to merge")
-    parser.add_argument("output", type=Path, help="Output file name")
+    parser = argparse.ArgumentParser(
+        description="Create a lightweight wrapper around a set of h5 files"
+    )
+    parser.add_argument("pattern", type=Path, help="quotes-enclosed glob pattern of files to merge")
+    parser.add_argument("output", type=Path, help="path to output virtual file")
     args = parser.parse_args()
 
     print(f"Globbing {args.pattern}...")

{atlas-ftag-tools-0.0.8 → atlas-ftag-tools-0.0.9}/pyproject.toml

@@ -28,6 +28,7 @@ dev = [
 
 [project.scripts]
 vds = "ftag.vds:main"
+wps = "ftag.wps.working_points:main"
 
 [tool.setuptools]
 packages = ["ftag", "ftag.hdf5"]

atlas-ftag-tools-0.0.8/ftag/__init__.py

@@ -1,23 +0,0 @@
-"""atlas-ftag-tools - Common tools for ATLAS flavour tagging software."""
-
-
-__version__ = "v0.0.8"
-
-from pathlib import Path
-
-import yaml
-
-import ftag.hdf5 as hdf5
-from ftag.cuts import Cuts
-from ftag.flavour import Flavour, FlavourContainer
-from ftag.mock import get_mock_file
-from ftag.sample import Sample
-
-# load flavours
-with open(Path(__file__).parent / "flavours.yaml") as f:
-    flavours_yaml = yaml.safe_load(f)
-flavours_dict = {f["name"]: Flavour(cuts=Cuts.from_list(f.pop("cuts")), **f) for f in flavours_yaml}
-assert len(flavours_dict) == len(flavours_yaml), "Duplicate flavour names detected"
-Flavours = FlavourContainer(flavours_dict)
-
-__all__ = ["Cuts", "Flavours", "Sample", "hdf5", "get_mock_file", "__version__"]