Skip to content

Commit b04a97b

Browse files
committed
updated metadata & readme for distribution
1 parent fa712f8 commit b04a97b

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,18 @@ pip install servicex-analysis-utils
88

99
##### This package contains the to_awk() function:
1010
```
11-
Load an awkward array from the deliver() output with uproot or uproot.dask.
11+
Load an awkward array from the deliver() output with uproot or uproot.dask.
1212
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
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+
iterator(bool): Optional. Flag to materialize the data into arrays or to return iterables with uproot.iterate
18+
**kwargs : Optional. Additional keyword arguments passed to uproot.dask, uproot.iterate and from_parquet
1819
19-
20-
Returns:
21-
dict: keys are sample names and values are awkward arrays, uproot generator objects or dask-awkward arrays.
20+
21+
Returns:
22+
dict: keys are sample names and values are awkward arrays, uproot generator objects or dask-awkward arrays.
2223
```
2324

2425
## Documentation

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "servicex_analysis_utils"
7-
version = "1.0.b2"
7+
version = "1.0.b3"
88
description = "A package with analysis tools for ServiceX."
99
authors = [{name = "Artur Cordeiro Oudot Choi", email = "acordeir@cern.ch"}]
1010
readme = "README.md"
@@ -17,8 +17,8 @@ dependencies = [
1717
]
1818

1919
[project.urls]
20-
"Source Code" = "https://github.com/ArturU043/ServiceX_analysis_utils"
21-
"Issue Tracker" = "https://github.com/ArturU043/ServiceX_analysis_utils/issues"
20+
"Source Code" = "https://github.com/ssl-hep/ServiceX_analysis_utils"
21+
"Issue Tracker" = "https://github.com/ssl-hep/ServiceX_analysis_utils/issues"
2222

2323
[tool.hatch.build.targets.sdist]
2424
include = [

0 commit comments

Comments
 (0)