This is a collection of Python tools for working with files produced with the FTAG ntuple dumper. The code is intended to be used a library for other projects. Please see the examples for usage.
atlas-ftag-tools can be installed from PyPI or using the latest code from this repository.
pip install atlas-ftag-toolsThe installation from PyPI only allows to install tagged releases, meaning you can not
install the latest code from this repo using the above command.
If you just want to use a stable release of atlas-ftag-tools, this is the way to go.
pip install https://github.com/umami-hep/atlas-ftag-tools/archive/main.tar.gzThis will install the latest version of atlas-ftag-tools, i.e. the current version
from the main branch (no matter if it is a release/tagged commit).
If you plan on contributing to atlas-ftag-tools and/or want the latest version possible, this
is what you want.
For development, we recommend using uv, a fast Python package installer and resolver. First, install uv:
# On macOS and Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
# On Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
# Or with pip (If installing from PyPI, we recommend installing uv into an isolated environment)
pip install uvThen clone the repository and install atlas-ftag-tools with development dependencies:
git clone https://github.com/umami-hep/atlas-ftag-tools.git
cd atlas-ftag-tools
uv sync --extra devThis will install atlas-ftag-tools in editable mode along with all development tools (testing, linting, etc.).
Tip
In order to use locally installed version of atlas-ftag-tools in other uv-managed projects, you can add the following to the pyproject.toml of the other project:
[tool.uv.sources]
atlas-ftag-tools = { path = "path_to/atlas-ftag-tools" }Extensive examples are given in the Examples