Skip to content

Commit 19c2b23

Browse files
committed
update readme
1 parent a224561 commit 19c2b23

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,24 @@
22
This repository provides analysis tools to be used with the [ServiceX Client](https://github.com/ssl-hep/ServiceX_frontend/tree/master)
33

44
### To install
5-
'''
5+
```
66
pip install servicex-analysis-utils
7-
'''
7+
```
8+
9+
##### This package contains the to_awk() function:
10+
```
11+
Load an awkward array from the deliver() output with uproot or uproot.dask.
12+
13+
Parameters:
14+
deliver_dict (dict): Returned dictionary from servicex.deliver()
15+
(keys are sample names, values are file paths or URLs).
16+
dask (bool): Optional. Flag to load as dask-awkward array. Default is False
17+
**uproot_kwargs : Optional. Additional keyword arguments passed to uproot.dask or uproot.iterate
18+
19+
20+
Returns:
21+
dict: keys are sample names and values are awkward arrays or dask-awkward arrays.
22+
```
823

924
## Documentation
10-
The different functions are documented in [ServiceX Documentation](https://servicex-frontend.readthedocs.io)
25+
The different functions are documented in TBD

0 commit comments

Comments
 (0)