Skip to content

Commit 248d4b3

Browse files
committed
Rename to flox
1 parent 27a46f7 commit 248d4b3

File tree

11 files changed

+27
-21
lines changed

11 files changed

+27
-21
lines changed

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,37 @@
1-
[![GitHub Workflow CI Status](https://img.shields.io/github/workflow/status/dcherian/dask_groupby/CI?logo=github&style=for-the-badge)](https://github.com/dcherian/dask_groupby/actions)[![GitHub Workflow Code Style Status](https://img.shields.io/github/workflow/status/dcherian/dask_groupby/code-style?label=Code%20Style&style=for-the-badge)](https://github.com/dcherian/dask_groupby/actions)[![image](https://img.shields.io/codecov/c/github/dcherian/dask_groupby.svg?style=for-the-badge)](https://codecov.io/gh/dcherian/dask_groupby)
1+
[![GitHub Workflow CI Status](https://img.shields.io/github/workflow/status/dcherian/flox/CI?logo=github&style=for-the-badge)](https://github.com/dcherian/flox/actions)[![GitHub Workflow Code Style Status](https://img.shields.io/github/workflow/status/dcherian/flox/code-style?label=Code%20Style&style=for-the-badge)](https://github.com/dcherian/flox/actions)[![image](https://img.shields.io/codecov/c/github/dcherian/flox.svg?style=for-the-badge)](https://codecov.io/gh/dcherian/flox)
22

3-
# dask_groupby
3+
# flox
4+
5+
This project explores strategies for fast GroupBy reductions with dask.array. It used to be called `dask_groupby`
6+
7+
This repo explores strategies for a distributed GroupBy with dask
8+
arrays. It was motivated by
9+
10+
1. Dask Dataframe GroupBy
11+
[blogpost](https://blog.dask.org/2019/10/08/df-groupby)
12+
2. numpy_groupies in Xarray
13+
[issue](https://github.com/pydata/xarray/issues/4473)
414

515
(See a
616
[presentation](https://docs.google.com/presentation/d/1muj5Yzjw-zY8c6agjyNBd2JspfANadGSDvdd6nae4jg/edit?usp=sharing)
717
about this package).
818

19+
## Acknowledgements
20+
21+
This work was funded in part by NASA-ACCESS 80NSSC18M0156 "Community tools for analysis of NASA Earth Observing System
22+
Data in the Cloud" (PI J. Hamman), and [NCAR's Earth System Data Science Initiative](https://ncar.github.io/esds/).
23+
It was motivated by many discussions in the [Pangeo](https://pangeo.io) community.
24+
925
## API
1026

1127
There are three functions
12-
1. `groupby_reduce(dask_array, by_dask_array, "mean")`
28+
1. `flox.groupby_reduce(dask_array, by_dask_array, "mean")`
1329
"pure" dask array interface
14-
2. `xarray_groupby_reduce(groupby_object, "mean")`
15-
xarray groupby interface that accepts a GroupBy object for convenience
16-
3. `xarray_reduce(xarray_object, by_dataarray, "mean")`
30+
1. `flox.xarray.xarray_reduce(xarray_object, by_dataarray, "mean")`
1731
"pure" xarray interface
1832

1933
## Implementation
2034

21-
This repo explores strategies for a distributed GroupBy with dask
22-
arrays. It was motivated by
23-
24-
1. Dask Dataframe GroupBy
25-
[blogpost](https://blog.dask.org/2019/10/08/df-groupby)
26-
2. numpy_groupies in Xarray
27-
[issue](https://github.com/pydata/xarray/issues/4473)
28-
2935
The core GroupBy operation is outsourced to
3036
[numpy_groupies](https://github.com/ml31415/numpy-groupies). The GroupBy
3137
reduction is first applied blockwise. Those intermediate results are
File renamed without changes.
File renamed without changes.
File renamed without changes.

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ profile = "black"
1919
skip_gitignore = true
2020
float_to_top = true
2121
combine_as_imports = true
22-
known_first_party = "dask_groupby"
22+
known_first_party = "flox"
2323
known_third_party = [
2424
"dask",
2525
"numpy",
@@ -34,7 +34,7 @@ known_third_party = [
3434
[tool.mypy]
3535
allow_redefinition = true
3636
exclude = "properties|asv_bench|doc|tests|flycheck"
37-
files = "dask_groupby/*.py"
37+
files = "flox/*.py"
3838
show_error_codes = true
3939

4040
[[tool.mypy.overrides]]

setup.cfg

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[metadata]
2-
name = dask_groupby
3-
author = dask_groupby Developers
2+
name = flox
3+
author = flox Developers
44
author_email = deepak@cherian.net
55
license = Apache
66
description = GroupBy operations for dask.array
77
long_description = file: README.md
88
long_description_content_type=text/markdown
99

10-
url = https://github.com/dcherian/dask_groupby
10+
url = https://github.com/dcherian/flox
1111
classifiers =
1212
Development Status :: 4 - Beta
1313
License :: OSI Approved :: Apache Software License

tests/test_core.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from dask.array import from_array
66
from numpy_groupies.aggregate_numpy import aggregate
77

8-
from dask_groupby.core import (
8+
from flox.core import (
99
_get_optimal_chunks_for_groups,
1010
find_group_cohorts,
1111
groupby_reduce,

0 commit comments

Comments
 (0)