Skip to content

Commit fcd6719

Browse files
author
KyungEon Choi
committed
Update README for v0.2.6
1 parent b21aeff commit fcd6719

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ServiceX DataBinder
22

3-
<p align="right"> Release v0.2.5 </p>
3+
<p align="right"> Release v0.2.6 </p>
44

55
[![PyPI version](https://badge.fury.io/py/servicex-databinder.svg)](https://badge.fury.io/py/servicex-databinder)
66

@@ -73,7 +73,7 @@ The followings are available options:
7373
| `Tree` | Name of the input ROOT `TTree` (`uproot` ONLY) |`String` |
7474
| `Filter` | Selection in the TCut syntax, e.g. `jet_pt > 10e3 && jet_eta < 2.0` (TCut ONLY) |`String` |
7575
| `Columns` | List of columns (or branches) to be delivered; multiple columns separately by comma (TCut ONLY) |`String` |
76-
| `FuncADL` | func-adl expression for a given sample (func adl ONLY) |`String` |
76+
| `FuncADL` | func-adl expression for a given sample (see [example](config_example_xaod.yml)) |`String` |
7777

7878
<!-- Options exclusively for TCut syntax (CANNOT combine with the option `FuncADL`) -->
7979

@@ -93,11 +93,12 @@ sx_db = DataBinder('<CONFIG>.yml')
9393
out = sx_db.deliver()
9494
```
9595

96-
The function `deliver()` returns a Python nested dictionary:
96+
The function `deliver()` returns a Python nested dictionary that contains delivered files:
9797
- for `uproot` backend and `parquet` output format: `out['<SAMPLE>']['<TREE>'] = [ List of output parquet files ]`
9898
- for `uproot` backend and `root` output format: `out['<SAMPLE>'] = [ List of output root files ]`
9999
- for `xAOD` backend: `out['<SAMPLE>'] = [ List of output root files ]`
100100

101+
Input configuration can be also feed as a dictionary.
101102

102103
<!-- ## Currently available
103104
- Dataset as Rucio DID + Input file format is ROOT TTree + ServiceX delivers output in parquet format

servicex_databinder/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
from .servicex_databinder import DataBinder
44

5-
__version__ = '0.2.5'
5+
__version__ = '0.2.6'
66

77
logging.basicConfig(format="%(levelname)s - %(message)s")
88
logging.getLogger(__name__).setLevel(logging.INFO)

0 commit comments

Comments
 (0)