Skip to content

Commit 97bd57c

Browse files
authored
Update README.md
1 parent 1663529 commit 97bd57c

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# ServiceX analysis utils
2-
This repository provides analysis tools to be used with the [ServiceX Client](https://github.com/ssl-hep/ServiceX_frontend/tree/master)
2+
This repository hosts tools that depend on the [ServiceX Client](https://github.com/ssl-hep/ServiceX_frontend/tree/master). These tools facilitate `ServiceX`'s general usage and offer specific features that replace parts of an analyser workflow.
33

44
### To install
55
```
66
pip install servicex-analysis-utils
77
```
8+
#### Requirements
9+
This package depends requires a `servicex.yml` configuration file granting access to one endpoint with a deployed ServiceX backend.
810

9-
##### This package contains the to_awk() function:
11+
### This package contains:
12+
#### `to_awk()`:
1013
```
1114
Load an awkward array from the deliver() output with uproot or uproot.dask.
1215
@@ -22,5 +25,24 @@ Returns:
2225
dict: keys are sample names and values are awkward arrays, uproot generator objects or dask-awkward arrays.
2326
```
2427

28+
29+
#### `get-structure()`:
30+
31+
```
32+
Creates and sends the ServiceX request from user inputed datasets to retrieve file stucture.
33+
Calls print_structure_from_str() to dump the structure in a user-friendly format
34+
35+
Parameters:
36+
datasets (dict,str,[str]): The datasets from which to print the file structures.
37+
A name can be given as the key of each dataset in a dictionary
38+
kwargs : Arguments to be propagated to print_structure_from_str, e.g filter_branch
39+
```
40+
41+
Function can be called from the command line, e.g:
42+
43+
```
44+
$ servicex-get-structure "mc23_13TeV:some-dataset-rucio-id" --filter_branch "truth"
45+
```
46+
2547
## Documentation
2648
The different functions are documented in TBD

0 commit comments

Comments
 (0)