atlas-ftag-tools 0.0.8__py3-none-any.whl → 0.0.9__py3-none-any.whl

{atlas_ftag_tools-0.0.8.dist-info → atlas_ftag_tools-0.0.9.dist-info}/METADATA

@@ -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
@@ -60,3 +60,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.dist-info → atlas_ftag_tools-0.0.9.dist-info}/RECORD

@@ -1,17 +1,17 @@
-ftag/__init__.py,sha256=ULhLJx6S4eI6belw3lP41InlJSx_9PrYgKmuA_YVz2U,731
+ftag/__init__.py,sha256=092e5JJGG0mORUgE6Si-6sMU2HxNP90t0NfWh9n3t5g,543
 ftag/cuts.py,sha256=Ge4WXLPg3WNgGxg-g7oIgCbbNFcKZonvkyskU0fDuDg,2733
-ftag/flavour.py,sha256=ciNtvPjcLhmf0tq2x5sOQXk2xwtLgMFS1wVlRk16VqI,2033
+ftag/flavour.py,sha256=67Otbi-78vEAOagLC9mvPGwNcr_S0ljy34eoChzd_9o,2396
 ftag/flavours.yaml,sha256=S4WoB_n2uqvjo8_mlvNA1wKUwz9aFLhpyXtWsR8uR80,3121
 ftag/mock.py,sha256=3ux7kx22o94K4eCHvI3vLTElBTvlDWEHwfCwidkNCiU,3579
 ftag/region.py,sha256=Tbw7o7cqdeZcu3x49n1iXUxR0apHaUSAsSY_vTHPuGI,371
 ftag/sample.py,sha256=p7JWiBvj4tq0YcvRGi_xp_3IvBXOFvx2mUEtO05NHac,2319
-ftag/vds.py,sha256=3b3Hc9A9eGtftZbfenth_PDP1NoRAirKvTCqLMoU3uU,2352
+ftag/vds.py,sha256=FmpP31YiSKBvh6TRIMWr-_aJHAkQs0Trhmqh2KLfT64,2402
 ftag/hdf5/__init__.py,sha256=A_a_4IUlZ2mSiDcfrZKBdja_3iTrUHvADM2lWx6g66g,325
 ftag/hdf5/h5reader.py,sha256=7FK1TfOb4tV34rlf6O3Xh918j3RwYMkm0-QLgO2NkHM,8446
 ftag/hdf5/h5utils.py,sha256=tHspHfO0lsRFcft9WQo98_ot55837nYNiTO4_0z4qwk,2376
 ftag/hdf5/h5writer.py,sha256=D4GZKWyPE-ob8anCsZ2Vw2UFwbZltl1dPn7ZlI-y1oM,3094
-atlas_ftag_tools-0.0.8.dist-info/METADATA,sha256=ovJP-STvMbIw42NMXMjyrH6Uq9xhiECoyjIWAXAF3Mg,2024
-atlas_ftag_tools-0.0.8.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-atlas_ftag_tools-0.0.8.dist-info/entry_points.txt,sha256=f-2kD2GPwnJis7whmkso1bfJ64HKgzxyI1to5zCPHhw,38
-atlas_ftag_tools-0.0.8.dist-info/top_level.txt,sha256=qiYQuKcAvMim-31FwkT3MTQu7WQm0s58tPAia5KKWqs,5
-atlas_ftag_tools-0.0.8.dist-info/RECORD,,
+atlas_ftag_tools-0.0.9.dist-info/METADATA,sha256=yajFDhKPhccegFIOLG49l7cuclhJiguFgF72ELrTQJA,2966
+atlas_ftag_tools-0.0.9.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+atlas_ftag_tools-0.0.9.dist-info/entry_points.txt,sha256=UKbRbwA9DxfsTPRBIVVDz3u15WdzhzgRKwXXSAXuQqc,73
+atlas_ftag_tools-0.0.9.dist-info/top_level.txt,sha256=qiYQuKcAvMim-31FwkT3MTQu7WQm0s58tPAia5KKWqs,5
+atlas_ftag_tools-0.0.9.dist-info/RECORD,,

{atlas_ftag_tools-0.0.8.dist-info → atlas_ftag_tools-0.0.9.dist-info}/entry_points.txt

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

ftag/__init__.py

@@ -1,23 +1,25 @@
 """atlas-ftag-tools - Common tools for ATLAS flavour tagging software."""
 
 
-__version__ = "v0.0.8"
+__version__ = "v0.0.9"
 
-from pathlib import Path
-
-import yaml
 
 import ftag.hdf5 as hdf5
 from ftag.cuts import Cuts
-from ftag.flavour import Flavour, FlavourContainer
+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
 
-# 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__"]
+__all__ = [
+    "Cuts",
+    "Flavour",
+    "Flavours",
+    "Sample",
+    "hdf5",
+    "get_mock_file",
+    "get_discriminant",
+    "get_working_points",
+    "__version__",
+]

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)

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}...")