F.A.S.T. package for summarizing ROOT TTrees
Project description
fast-carpenter
Turns your trees into tables (ie. reads ROOT TTrees, writes summary Pandas DataFrames)
fast-carpenter can:
- Be controlled using YAML-based config files
- Define new variables
- Cut out events or define phase-space "regions"
- Produce histograms stored as CSV files using multiple weighting schemes
- Make use of user-defined stages to manipulate the data
Powered by:
- AlphaTwirl (presently): to run the dataset splitting
- Atuproot: to adapt AlphaTwirl to use uproot
- uproot: to load ROOT Trees into memory as numpy arrays
- fast-flow: to manage the processing config files
- fast-curator: to orchestrate the lists of datasets to be processed
- coffee: to help the developer(s) write code
Installation
Can be installed from pypi:
pip install --user fast-carpenter
or if you want to be able to edit code in this repo:
pip install --user -e git+https://gitlab.cern.ch/fast-hep/public/fast-carpenter.git#egg=fast_carpenter --src .
Note that to use this repository and the main fast_carpenter command, you normally shouldn't need to be able to edit this codebase;
in most instances the full analysis should be describable with just a config file, and in some cases custom, analysis-specific stages to create more tricky variables for example.
Also note that if you install this with pip, the main executable, fast_carpenter, will only be available everywhere if include the directory ~/.local/bin in your PATH variable.
Documentation
Basic usage:
- Build a description of the datasets you wish to process using the
fast_curatorcommand from the fast-curator package. - Write a description of what you want to do with your data (see documentation below).
- Run things:
fast_carpenter datasets.yaml processing.yaml
You can use the built-in help as well for more info:
fast_carpenter --help
Talk:
which partially act as documentation:
Example analysis
The fast_cms_public_tutorial shows an example analysis that uses this package.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fast-carpenter-0.6.9.tar.gz.
File metadata
- Download URL: fast-carpenter-0.6.9.tar.gz
- Upload date:
- Size: 14.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7037c9c3fbd5e50b6608219683d7a0faf49a61d3f3cf4c17a2787801045c65a1 |
|
| MD5 | d3387ff8ec5c5c27557752bc9b145296 |
|
| BLAKE2b-256 | 9011dfe525cf2bd13b908900d28a5d0777c7a29086f79f277bce510ece31c1aa |
File details
Details for the file fast_carpenter-0.6.9-py2.py3-none-any.whl.
File metadata
- Download URL: fast_carpenter-0.6.9-py2.py3-none-any.whl
- Upload date:
- Size: 18.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0b5b0b414804ede09e670ad873856684a9f2b643109e0926119ed7377882c043 |
|
| MD5 | 56fe0696d609aaf84ef9899ee18fcf85 |
|
| BLAKE2b-256 | 68b4c5de71d7ca7109cc944f08a2faa90782b162251a640f9e11fbea673307ef |
