You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-2
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,15 @@
1
1
# 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.
3
3
4
4
### To install
5
5
```
6
6
pip install servicex-analysis-utils
7
7
```
8
+
#### Requirements
9
+
This package depends requires a `servicex.yml` configuration file granting access to one endpoint with a deployed ServiceX backend.
8
10
9
-
##### This package contains the to_awk() function:
11
+
### This package contains:
12
+
#### `to_awk()`:
10
13
```
11
14
Load an awkward array from the deliver() output with uproot or uproot.dask.
12
15
@@ -22,5 +25,24 @@ Returns:
22
25
dict: keys are sample names and values are awkward arrays, uproot generator objects or dask-awkward arrays.
23
26
```
24
27
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:
0 commit comments