atlas-schema 0.1.0__py3-none-any.whl

atlas_schema/__init__.py

@@ -0,0 +1,12 @@
+"""
+Copyright (c) 2024 Giordon Stark. All rights reserved.
+
+atlas_schema: Collection of utilities and helper functions for HEP ATLAS analysers
+"""
+
+from __future__ import annotations
+
+from atlas_schema._version import version as __version__
+from atlas_schema.enums import ParticleOrigin, PhotonID
+
+__all__ = ["__version__", "ParticleOrigin", "PhotonID"]

atlas_schema/_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)

atlas_schema/_version.pyi

@@ -0,0 +1,4 @@
+from __future__ import annotations
+
+version: str
+version_tuple: tuple[int, int, int] | tuple[int, int, int, str, str]

atlas_schema/enums.py

@@ -0,0 +1,116 @@
+from __future__ import annotations
+
+from enum import IntEnum
+
+from atlas_schema.typing_compat import Annotated
+
+
+# https://gitlab.cern.ch/atlas/athena/-/blob/74f43ff0910edb2a2bd3778880ccbdad648dc037/Generators/TruthUtils/TruthUtils/TruthClasses.h#L51-103
+class ParticleType(IntEnum):
+    Unknown: Annotated[int, "Unknown"] = 0
+    UnknownElectron: Annotated[int, "UnknownElectron"] = 1
+    IsoElectron: Annotated[int, "IsoElectron"] = 2
+    NonIsoElectron: Annotated[int, "NonIsoElectron"] = 3
+    BkgElectron: Annotated[int, "BkgElectron"] = 4
+    UnknownMuon: Annotated[int, "UnknownMuon"] = 5
+    IsoMuon: Annotated[int, "IsoMuon"] = 6
+    NonIsoMuon: Annotated[int, "NonIsoMuon"] = 7
+    BkgMuon: Annotated[int, "BkgMuon"] = 8
+    UnknownTau: Annotated[int, "UnknownTau"] = 9
+    IsoTau: Annotated[int, "IsoTau"] = 10
+    NonIsoTau: Annotated[int, "NonIsoTau"] = 11
+    BkgTau: Annotated[int, "BkgTau"] = 12
+    UnknownPhoton: Annotated[int, "UnknownPhoton"] = 13
+    IsoPhoton: Annotated[int, "IsoPhoton"] = 14
+    NonIsoPhoton: Annotated[int, "NonIsoPhoton"] = 15
+    BkgPhoton: Annotated[int, "BkgPhoton"] = 16
+    Hadron: Annotated[int, "Hadron"] = 17
+    Neutrino: Annotated[int, "Neutrino"] = 18
+    NuclFrag: Annotated[int, "NuclFrag"] = 19
+    NonPrimary: Annotated[int, "NonPrimary"] = 20
+    GenParticle: Annotated[int, "GenParticle"] = 21
+    SUSYParticle: Annotated[int, "SUSYParticle"] = 22
+    OtherBSMParticle: Annotated[int, "OtherBSMParticle"] = 39
+    BBbarMesonPart: Annotated[int, "BBbarMesonPart"] = 23
+    BottomMesonPart: Annotated[int, "BottomMesonPart"] = 24
+    CCbarMesonPart: Annotated[int, "CCbarMesonPart"] = 25
+    CharmedMesonPart: Annotated[int, "CharmedMesonPart"] = 26
+    BottomBaryonPart: Annotated[int, "BottomBaryonPart"] = 27
+    CharmedBaryonPart: Annotated[int, "CharmedBaryonPart"] = 28
+    StrangeBaryonPart: Annotated[int, "StrangeBaryonPart"] = 29
+    LightBaryonPart: Annotated[int, "LightBaryonPart"] = 30
+    StrangeMesonPart: Annotated[int, "StrangeMesonPart"] = 31
+    LightMesonPart: Annotated[int, "LightMesonPart"] = 32
+    BJet: Annotated[int, "BJet"] = 33
+    CJet: Annotated[int, "CJet"] = 34
+    LJet: Annotated[int, "LJet"] = 35
+    GJet: Annotated[int, "GJet"] = 36
+    TauJet: Annotated[int, "TauJet"] = 37
+    UnknownJet: Annotated[int, "UnknownJet"] = 38
+
+
+# https://gitlab.cern.ch/atlas/athena/-/blob/74f43ff0910edb2a2bd3778880ccbdad648dc037/Generators/TruthUtils/TruthUtils/TruthClasses.h#L51-103
+class ParticleOrigin(IntEnum):
+    NonDefined: Annotated[int, "NonDefined"] = 0
+    SingleElec: Annotated[int, "SingleElec"] = 1
+    SingleMuon: Annotated[int, "SingleMuon"] = 2
+    SinglePhot: Annotated[int, "SinglePhot"] = 3
+    SingleTau: Annotated[int, "SingleTau"] = 4
+    PhotonConv: Annotated[int, "PhotonConv"] = 5
+    DalitzDec: Annotated[int, "DalitzDec"] = 6
+    ElMagProc: Annotated[int, "ElMagProc"] = 7
+    Mu: Annotated[int, "Mu"] = 8
+    TauLep: Annotated[int, "TauLep"] = 9
+    top: Annotated[int, "top"] = 10
+    QuarkWeakDec: Annotated[int, "QuarkWeakDec"] = 11
+    WBoson: Annotated[int, "WBoson"] = 12
+    ZBoson: Annotated[int, "ZBoson"] = 13
+    Higgs: Annotated[int, "Higgs"] = 14
+    HiggsMSSM: Annotated[int, "HiggsMSSM"] = 15
+    HeavyBoson: Annotated[int, "HeavyBoson"] = 16
+    WBosonLRSM: Annotated[int, "WBosonLRSM"] = 17
+    NuREle: Annotated[int, "NuREle"] = 18
+    NuRMu: Annotated[int, "NuRMu"] = 19
+    NuRTau: Annotated[int, "NuRTau"] = 20
+    LQ: Annotated[int, "LQ"] = 21
+    SUSY: Annotated[int, "SUSY"] = 22
+    OtherBSM: Annotated[int, "OtherBSM"] = 46
+    LightMeson: Annotated[int, "LightMeson"] = 23
+    StrangeMeson: Annotated[int, "StrangeMeson"] = 24
+    CharmedMeson: Annotated[int, "CharmedMeson"] = 25
+    BottomMeson: Annotated[int, "BottomMeson"] = 26
+    CCbarMeson: Annotated[int, "CCbarMeson"] = 27
+    JPsi: Annotated[int, "JPsi"] = 28
+    BBbarMeson: Annotated[int, "BBbarMeson"] = 29
+    LightBaryon: Annotated[int, "LightBaryon"] = 30
+    StrangeBaryon: Annotated[int, "StrangeBaryon"] = 31
+    CharmedBaryon: Annotated[int, "CharmedBaryon"] = 32
+    BottomBaryon: Annotated[int, "BottomBaryon"] = 33
+    PionDecay: Annotated[int, "PionDecay"] = 34
+    KaonDecay: Annotated[int, "KaonDecay"] = 35
+    BremPhot: Annotated[int, "BremPhot"] = 36
+    PromptPhot: Annotated[int, "PromptPhot"] = 37
+    UndrPhot: Annotated[int, "UndrPhot"] = 38
+    ISRPhot: Annotated[int, "ISRPhot"] = 39
+    FSRPhot: Annotated[int, "FSRPhot"] = 40
+    NucReact: Annotated[int, "NucReact"] = 41
+    PiZero: Annotated[int, "PiZero"] = 42
+    DiBoson: Annotated[int, "DiBoson"] = 43
+    ZorHeavyBoson: Annotated[int, "ZorHeavyBoson"] = 44
+    MultiBoson: Annotated[int, "MultiBoson"] = 47
+    QCD: Annotated[int, "QCD"] = 45
+
+
+# https://twiki.cern.ch/twiki/bin/viewauth/AtlasProtected/EGammaIdentificationRun2#Photon_isEM_word
+class PhotonID(IntEnum):
+    Rhad: Annotated[int, "ClusterHadronicLeakage_Photon"] = 10
+    E277: Annotated[int, "ClusterMiddleEnergy_Photon"] = 11
+    Reta: Annotated[int, "ClusterMiddleEratio37_Photon"] = 12
+    Rphi: Annotated[int, "ClusterMiddleEratio33_Photon"] = 13
+    Weta2: Annotated[int, "ClusterMiddleWidth_Photon"] = 14
+    f1: Annotated[int, "ClusterStripsEratio_Photon"] = 15
+    DeltaE: Annotated[int, "ClusterStripsDeltaE_Photon"] = 17
+    Wstot: Annotated[int, "ClusterStripsWtot_Photon"] = 18
+    fside: Annotated[int, "ClusterStripsFracm_Photon"] = 19
+    Ws3: Annotated[int, "ClusterStripsWeta1c_Photon"] = 20
+    ERatio: Annotated[int, "ClusterStripsDEmaxs1_Photon"] = 21

atlas_schema/methods.py

@@ -0,0 +1,181 @@
+"""Mixins for the Ntuple schema"""
+
+from __future__ import annotations
+
+from functools import reduce
+from operator import ior
+
+import awkward
+from coffea.nanoevents.methods import base, candidate, vector
+from dask_awkward import dask_method
+
+from atlas_schema.enums import PhotonID
+from atlas_schema.typing_compat import Behavior
+
+behavior: Behavior = {}
+behavior.update(base.behavior)
+# vector behavior is included in candidate behavior
+behavior.update(candidate.behavior)
+
+
+class NtupleEvents(behavior["NanoEvents"]):  # type: ignore[misc, valid-type, name-defined]
+    def __repr__(self):
+        return f"<event {getattr(self,'runNumber','??')}:\
+                {getattr(self,'eventNumber','??')}:\
+                {getattr(self,'mcChannelNumber','??')}>"
+
+
+behavior["NanoEvents"] = NtupleEvents
+
+
+def _set_repr_name(classname):
+    def namefcn(_self):
+        return classname
+
+    behavior[("__typestr__", classname)] = classname[0].lower() + classname[1:]
+    behavior[classname].__repr__ = namefcn
+
+
+@awkward.mixin_class(behavior)
+class Weight(base.NanoCollection, base.Systematic): ...
+
+
+_set_repr_name("Weight")
+
+
+@awkward.mixin_class(behavior)
+class Pass(base.NanoCollection, base.Systematic): ...
+
+
+_set_repr_name("Pass")
+
+
+@awkward.mixin_class(behavior)
+class Particle(vector.PtEtaPhiMLorentzVector):
+    """Generic particle collection that has Lorentz vector properties
+
+    Also handles the following additional branches:
+    - '{obj}_select'
+    """
+
+    @property
+    def mass(self):
+        r"""Invariant mass (+, -, -, -)
+
+        :math:`\sqrt{t^2-x^2-y^2-z^2}`
+        """
+        return self["mass"] / 1.0e3
+
+    @dask_method
+    def passes(self, name):
+        return self[f"select_{name}"] == 1
+
+    @passes.dask
+    def passes(self, dask_array, name):
+        return dask_array[f"select_{name}"] == 1
+
+    # NB: fields with the name 'pt' take precedence over this
+    # @dask_property
+    # def pt(self):
+    #     print('inside non-dask prop')
+    #     return self["pt_NOSYS"]
+
+    # @pt.dask
+    # def pt(self, dask_array):
+    #     branch = 'pt'
+    #     print('inside dask prop')
+    #     variation = dask_array._events().metadata.get("systematic", "NOSYS")
+    #     with contextlib.suppress(Exception):
+    #         return dask_array[f"{branch}_{variation}"]
+
+    #     if variation != "NOSYS":
+    #         with contextlib.suppress(Exception):
+    #             return dask_array[f"{branch}_NOSYS"]
+
+    #     return dask_array[branch]
+
+
+_set_repr_name("Particle")
+
+
+@awkward.mixin_class(behavior)
+class MasslessParticle(Particle, base.NanoCollection):
+    @property
+    def mass(self):
+        r"""Invariant mass (+, -, -, -)
+
+        :math:`\sqrt{t^2-x^2-y^2-z^2}`
+        """
+        return 0.0 * self.pt
+
+
+_set_repr_name("MasslessParticle")
+
+
+@awkward.mixin_class(behavior)
+class MissingET(MasslessParticle, base.NanoCollection, base.Systematic):
+    @property
+    def pt(self):
+        """Alias for `r`"""
+        return self["met"] / 1.0e3
+
+    @property
+    def eta(self):
+        r"""Pseudorapidity
+
+        :math:`-\ln\tan(\theta/2) = \text{arcsinh}(z/r)`
+        """
+        return 0.0 * self.pt
+
+
+_set_repr_name("MissingET")
+
+
+@awkward.mixin_class(behavior)
+class Photon(MasslessParticle, base.NanoCollection, base.Systematic):
+    @property
+    def isEM(self):
+        return self.isEM_syst.NOSYS == 0
+
+    def pass_isEM(self, words: list[PhotonID]):
+        # 0 is pass, 1 is fail
+        return (
+            self.isEM_syst.NOSYS & reduce(ior, (1 << word.value for word in words))
+        ) == 0
+
+
+_set_repr_name("Photon")
+
+
+@awkward.mixin_class(behavior)
+class Electron(MasslessParticle, base.NanoCollection, base.Systematic): ...
+
+
+_set_repr_name("Electron")
+
+
+@awkward.mixin_class(behavior)
+class Muon(MasslessParticle, base.NanoCollection, base.Systematic): ...
+
+
+_set_repr_name("Muon")
+
+
+@awkward.mixin_class(behavior)
+class Jet(Particle, base.NanoCollection, base.Systematic): ...
+
+
+_set_repr_name("Jet")
+
+
+__all__ = [
+    "NtupleEvents",
+    "Weight",
+    "Pass",
+    "MissingET",
+    "Particle",
+    "Photon",
+    "Electron",
+    "Muon",
+    "Jet",
+]

atlas_schema/schema.py

@@ -0,0 +1,206 @@
+from __future__ import annotations
+
+import warnings
+from collections.abc import KeysView, ValuesView
+from typing import Any, ClassVar
+
+from coffea.nanoevents.schemas.base import BaseSchema, zip_forms
+
+from atlas_schema.typing_compat import Behavior, Self
+
+
+class NtupleSchema(BaseSchema):  # type: ignore[misc]
+    """Ntuple schema builder
+
+    The Ntuple schema is built from all branches found in the supplied file, based on
+    the naming pattern of the branches. The following additional arrays are constructed:
+
+    - n/a
+    """
+
+    __dask_capable__ = True
+
+    warn_missing_crossrefs = True
+    error_missing_event_ids = False
+
+    event_ids_data: ClassVar[set[str]] = {
+        "lumiBlock",
+        "averageInteractionsPerCrossing",
+        "actualInteractionsPerCrossing",
+        "dataTakingYear",
+    }
+    event_ids_mc: ClassVar[set[str]] = {
+        "mcChannelNumber",
+        "runNumber",
+        "eventNumber",
+        "mcEventWeights",
+    }
+    event_ids: ClassVar[set[str]] = {*event_ids_data, *event_ids_mc}
+
+    mixins: ClassVar[dict[str, str]] = {
+        "el": "Electron",
+        "jet": "Jet",
+        "met": "MissingET",
+        "mu": "Muon",
+        "pass": "Pass",
+        "ph": "Photon",
+        "trigPassed": "Trigger",
+        "weight": "Weight",
+    }
+
+    # These are stored as length-1 vectors unnecessarily
+    singletons: ClassVar[list[str]] = []
+
+    docstrings: ClassVar[dict[str, str]] = {
+        "charge": "charge",
+        "eta": "pseudorapidity",
+        "met": "missing transverse energy [MeV]",
+        "mass": "invariant mass [MeV]",
+        "pt": "transverse momentum [MeV]",
+        "phi": "azimuthal angle",
+    }
+
+    def __init__(self, base_form: dict[str, Any], version: str = "latest"):
+        super().__init__(base_form)
+        self._version = version
+        if version == "latest":
+            pass
+        else:
+            pass
+        self._form["fields"], self._form["contents"] = self._build_collections(
+            self._form["fields"], self._form["contents"]
+        )
+        self._form["parameters"]["metadata"]["version"] = self._version
+
+    @classmethod
+    def v1(cls, base_form: dict[str, Any]) -> Self:
+        """Build the NtupleEvents
+
+        For example, one can use ``NanoEventsFactory.from_root("file.root", schemaclass=NtupleSchema.v1)``
+        to ensure NanoAODv7 compatibility.
+        """
+        return cls(base_form, version="1")
+
+    def _build_collections(
+        self, field_names: list[str], input_contents: list[Any]
+    ) -> tuple[KeysView[str], ValuesView[dict[str, Any]]]:
+        branch_forms = dict(zip(field_names, input_contents))
+
+        # parse into high-level records (collections, list collections, and singletons)
+        collections = {k.split("_")[0] for k in branch_forms}
+        collections -= self.event_ids
+        collections -= set(self.singletons)
+
+        # rename needed because easyjet breaks the AMG assumptions
+        # https://gitlab.cern.ch/easyjet/easyjet/-/issues/246
+        for k in list(branch_forms):
+            if "NOSYS" not in k:
+                continue
+            branch_forms[k.replace("_NOSYS", "") + "_NOSYS"] = branch_forms.pop(k)
+
+        # these are collections with systematic variations
+        subcollections = {
+            k.split("__")[0].split("_", 1)[1].replace("_NOSYS", "")
+            for k in branch_forms
+            if "NOSYS" in k
+        }
+
+        # Check the presence of the event_ids
+        missing_event_ids = [
+            event_id for event_id in self.event_ids if event_id not in branch_forms
+        ]
+
+        if len(missing_event_ids) > 0:
+            if self.error_missing_event_ids:
+                msg = f"There are missing event ID fields: {missing_event_ids} \n\n\
+                    The event ID fields {self.event_ids} are necessary to perform sub-run identification \
+                    (e.g. for corrections and sub-dividing data during different detector conditions),\
+                    to cross-validate MC and Data (i.e. matching events for comparison), and to generate event displays. \
+                    It's advised to never drop these branches from the dataformat.\n\n\
+                    This error can be demoted to a warning by setting the class level variable error_missing_event_ids to False."
+                raise RuntimeError(msg)
+            warnings.warn(
+                f"Missing event_ids : {missing_event_ids}",
+                RuntimeWarning,
+                stacklevel=2,
+            )
+
+        output = {}
+
+        # first, register the event-level stuff directly
+        for name in self.event_ids:
+            if name in missing_event_ids:
+                continue
+            output[name] = branch_forms[name]
+
+        # next, go through and start grouping up collections
+        for name in collections:
+            mixin = self.mixins.get(name, "NanoCollection")
+            content = {}
+            used = set()
+
+            for subname in subcollections:
+                prefix = f"{name}_{subname}_"
+                used.update({k for k in branch_forms if k.startswith(prefix)})
+                subcontent = {
+                    k[len(prefix) :]: branch_forms[k]
+                    for k in branch_forms
+                    if k.startswith(prefix)
+                }
+                if subcontent:
+                    # create the nominal version
+                    content[subname] = branch_forms[f"{prefix}NOSYS"]
+                    # create a collection of the systematic variations for the given variable
+                    content[f"{subname}_syst"] = zip_forms(
+                        subcontent, f"{name}_syst", record_name="NanoCollection"
+                    )
+
+            content.update(
+                {
+                    k[len(name) + 1 :]: branch_forms[k]
+                    for k in branch_forms
+                    if k.startswith(name + "_") and k not in used
+                }
+            )
+
+            output[name] = zip_forms(content, name, record_name=mixin)
+
+            output[name].setdefault("parameters", {})
+            output[name]["parameters"].update({"collection_name": name})
+
+            if output[name]["class"] == "ListOffsetArray":
+                parameters = output[name]["content"]["fields"]
+                contents = output[name]["content"]["contents"]
+            elif output[name]["class"] == "RecordArray":
+                parameters = output[name]["fields"]
+                contents = output[name]["contents"]
+            else:
+                msg = f"Unhandled class {output[name]['class']}"
+                raise RuntimeError(msg)
+            # update docstrings as needed
+            # NB: must be before flattening for easier logic
+            for index, parameter in enumerate(parameters):
+                if "parameters" not in contents[index]:
+                    continue
+
+                parsed_name = parameter.replace("_NOSYS", "")
+                contents[index]["parameters"]["__doc__"] = self.docstrings.get(
+                    parsed_name,
+                    contents[index]["parameters"].get(
+                        "__doc__", "no docstring available"
+                    ),
+                )
+
+            if name in self.singletons:
+                # flatten! this 'promotes' the content of an inner dimension
+                # upwards, effectively hiding one nested dimension
+                output[name] = output[name]["content"]
+
+        return output.keys(), output.values()
+
+    @classmethod
+    def behavior(cls) -> Behavior:
+        """Behaviors necessary to implement this schema"""
+        from atlas_schema.methods import behavior as roaster
+
+        return roaster

atlas_schema/typing_compat.py

@@ -0,0 +1,29 @@
+"""
+Typing helpers.
+"""
+
+from __future__ import annotations
+
+import sys
+from typing import Dict, Type
+
+import awkward
+
+if sys.version_info >= (3, 9):
+    from typing import Annotated
+else:
+    from typing_extensions import Annotated
+
+if sys.version_info >= (3, 10):
+    from typing import TypeAlias
+else:
+    from typing_extensions import TypeAlias
+
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+Behavior: TypeAlias = Dict[str, Type[awkward.Record]]
+
+__all__ = ("Annotated", "Behavior", "Self")

atlas_schema-0.1.0.dist-info/METADATA

@@ -0,0 +1,283 @@
+Metadata-Version: 2.3
+Name: atlas-schema
+Version: 0.1.0
+Summary: Helper python package for ATLAS Common NTuple Analysis work.
+Project-URL: Homepage, https://github.com/scipp-atlas/atlas-schema
+Project-URL: Bug Tracker, https://github.com/scipp-atlas/atlas-schema/issues
+Project-URL: Discussions, https://github.com/scipp-atlas/atlas-schema/discussions
+Project-URL: Changelog, https://github.com/scipp-atlas/atlas-schema/releases
+Author-email: Giordon Stark <kratsg@gmail.com>
+License: 
+                                         Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright 2024 Giordon Stark
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Requires-Dist: coffea[dask]>=2024.4.1
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=3; extra == 'dev'
+Requires-Dist: pytest>=6; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo>=2023.08.17; extra == 'docs'
+Requires-Dist: myst-parser>=0.13; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
+Requires-Dist: sphinx-copybutton; extra == 'docs'
+Requires-Dist: sphinx>=7.0; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: build; extra == 'test'
+Requires-Dist: pylint; extra == 'test'
+Requires-Dist: pytest-cov>=3; extra == 'test'
+Requires-Dist: pytest>=6; extra == 'test'
+Requires-Dist: tbump>=6.7.0; extra == 'test'
+Requires-Dist: twine; extra == 'test'
+Description-Content-Type: text/markdown
+
+# atlas-schema v0.1.0
+
+[![Actions Status][actions-badge]][actions-link]
+[![Documentation Status][rtd-badge]][rtd-link]
+
+[![PyPI version][pypi-version]][pypi-link]
+[![Conda-Forge][conda-badge]][conda-link]
+[![PyPI platforms][pypi-platforms]][pypi-link]
+
+[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
+
+<!-- SPHINX-START -->
+
+<!-- prettier-ignore-start -->
+[actions-badge]:            https://github.com/scipp-atlas/atlas-schema/workflows/CI/badge.svg
+[actions-link]:             https://github.com/scipp-atlas/atlas-schema/actions
+[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/atlas-schema
+[conda-link]:               https://github.com/conda-forge/atlas-schema-feedstock
+[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
+[github-discussions-link]:  https://github.com/scipp-atlas/atlas-schema/discussions
+[pypi-link]:                https://pypi.org/project/atlas-schema/
+[pypi-platforms]:           https://img.shields.io/pypi/pyversions/atlas-schema
+[pypi-version]:             https://img.shields.io/pypi/v/atlas-schema
+[rtd-badge]:                https://readthedocs.org/projects/atlas-schema/badge/?version=latest
+[rtd-link]:                 https://atlas-schema.readthedocs.io/en/latest/?badge=latest
+
+<!-- prettier-ignore-end -->
+
+## Developer Notes
+
+### Converting Enums from C++ to Python
+
+This useful `vim` substitution helps:
+
+```
+%s/    \([A-Za-z]\+\)\s\+=  \(\d\+\),\?/    \1: Annotated[int, "\1"] = \2
+```

atlas_schema-0.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+atlas_schema/__init__.py,sha256=eba1N4_cWS5YzEOgDdCJGiPKqUtO-Vn7t8dYq0Q6gk8,354
+atlas_schema/_version.py,sha256=IMl2Pr_Sy4LVRKy_Sm4CdwUl1Gryous6ncL96EMYsnM,411
+atlas_schema/_version.pyi,sha256=j5kbzfm6lOn8BzASXWjGIA1yT0OlHTWqlbyZ8Si_o0E,118
+atlas_schema/enums.py,sha256=RktHMdqNcjcqHOtXzRP5pnakhrfo0VfRl60Mqsa7i74,5522
+atlas_schema/methods.py,sha256=Vo9pQ52ZVm13TBpJ6KiiDlN2kS1MMGBMLjwRPB62ces,4111
+atlas_schema/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+atlas_schema/schema.py,sha256=YRVaiDa5Evl2HZ9CzH23d0-TLkvxqyvFQhn0ixyWCcw,7668
+atlas_schema/typing_compat.py,sha256=ZEdCro9ZfwqyEXrcxpkgyQqmpPiiLFc6JhDr9qFlD4w,555
+atlas_schema-0.1.0.dist-info/METADATA,sha256=tiETJp8Ho_BdhjcKHExLrsxt4_z-65d-ovTBszl6pU8,16445
+atlas_schema-0.1.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+atlas_schema-0.1.0.dist-info/licenses/LICENSE,sha256=snem82NV8fgAi4DKaaUIfReaM5RqIWbH5OOXOvy40_w,11344
+atlas_schema-0.1.0.dist-info/RECORD,,

atlas_schema-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.26.3
+Root-Is-Purelib: true
+Tag: py3-none-any

atlas_schema-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Giordon Stark
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.