Metadata-Version: 2.4
Name: epic-capybara
Version: 1.0.0
Summary: Track and visualize multi-dimensional CI metrics
Project-URL: Documentation, https://github.com/eic/epic-capybara#readme
Project-URL: Issues, https://github.com/eic/epic-capybara/issues
Project-URL: Source, https://github.com/eic/epic-capybara
Author-email: Dmitry Kalinkin <dmitry.kalinkin@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
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 :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.7
Requires-Dist: awkward
Requires-Dist: bokeh>=3.0.0
Requires-Dist: click
Requires-Dist: hist
Requires-Dist: pygithub
Requires-Dist: requests
Requires-Dist: scipy
Requires-Dist: uproot
Provides-Extra: rntuple
Requires-Dist: uproot>=5.7.0; extra == 'rntuple'
Description-Content-Type: text/markdown

# epic-capybara

epic-capybara is a collection of tools for comparison and presentation of
differences between [ROOT](https://root.cern) TTree files. The available tools
are:

- `capybara capy` fetches CI artifacts either for a single revision of for the PR branch and its reference branch
- `capybara bara` projects each TTree leaf onto a histogram, render it as an html report using Bokeh
- `capybara cate` upload report to a github repo

See `capybara --help` or `capybara <tool-name> --help` for options.

### Installing

You will need to obtain epic-capybara itself and [Hatch](https://hatch.pypa.io/latest/).

```
git clone git@github.com:eic/epic-capybara.git
pip install hatch
cd epic-capybara
```

You can then either run the development version:
```
hatch env run -- capybara capy pr 123
```

Or build a wheel and install it locally
```
hatch build
pip install dist/*.whl
```

### Legacy scripts

This repository contains scripts for ROOT file comparisons in CI.
- `capy.py`: obtain ROOT files from previous CI pipelines
- `bara.py`: compare two ROOT files
