Merge branch 'main' into numbagg

* main:
  Smol docstring improvement
  [pre-commit.ci] auto fixes from pre-commit.com hooks
  Add aggregation as top-level import
  Updates to notebook
  Add custom aggregations user story
  Add user stories (#81)
  Add ignore_old_chunks for rechunk_for_cohorts
  Skip reindexing in finalize_results if reindex is True
  Fix multiple grouper, same dim
  Pass reindex to _reduce_blockwise
  Better IntervalIndex creation
  Fix tests
  Multiple groupers v3 (#76)
  More consistent fill_value handling.
  isnull instead of isnan
  Add funding badge (#77)
  Handle sorting in factorize_
  Handle reindex in factorize_
  Small refactor
  Extra test and comment

Author: dcherian

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
         - id: check-docstring-first
 
     - repo: https://github.com/psf/black
-      rev: 22.1.0
+      rev: 22.3.0
       hooks:
         - id: black
 

README.md

@@ -1,4 +1,4 @@
-[![GitHub Workflow CI Status](https://img.shields.io/github/workflow/status/dcherian/flox/CI?logo=github&style=flat)](https://github.com/dcherian/flox/actions)[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/dcherian/flox/main.svg)](https://results.pre-commit.ci/latest/github/dcherian/flox/main)[![image](https://img.shields.io/codecov/c/github/dcherian/flox.svg?style=flat)](https://codecov.io/gh/dcherian/flox)[![PyPI](https://img.shields.io/pypi/v/flox.svg?style=flat)](https://pypi.org/project/flox/)[![Conda-forge](https://img.shields.io/conda/vn/conda-forge/flox.svg?style=flat)](https://anaconda.org/conda-forge/flox)[![Documentation Status](https://readthedocs.org/projects/flox/badge/?version=latest)](https://flox.readthedocs.io/en/latest/?badge=latest)
+[![GitHub Workflow CI Status](https://img.shields.io/github/workflow/status/dcherian/flox/CI?logo=github&style=flat)](https://github.com/dcherian/flox/actions)[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/dcherian/flox/main.svg)](https://results.pre-commit.ci/latest/github/dcherian/flox/main)[![image](https://img.shields.io/codecov/c/github/dcherian/flox.svg?style=flat)](https://codecov.io/gh/dcherian/flox)[![PyPI](https://img.shields.io/pypi/v/flox.svg?style=flat)](https://pypi.org/project/flox/)[![Conda-forge](https://img.shields.io/conda/vn/conda-forge/flox.svg?style=flat)](https://anaconda.org/conda-forge/flox)[![Documentation Status](https://readthedocs.org/projects/flox/badge/?version=latest)](https://flox.readthedocs.io/en/latest/?badge=latest)[![NASA-80NSSC18M0156](https://img.shields.io/badge/NASA-80NSSC18M0156-blue)](https://earthdata.nasa.gov/esds/competitive-programs/access/pangeo-ml)
 
 # flox
 

ci/docs.yml

@@ -8,8 +8,12 @@ dependencies:
   - numpydoc
   - numpy_groupies
   - toolz
+  - matplotlib-base
   - myst-parser
+  - myst-nb
   - sphinx
   - furo
+  - ipykernel
+  - jupyter
   - pip:
     - git+https://github.com/dcherian/flox

docs/source/_static/style.css

@@ -0,0 +1,12 @@
+.xr-wrap {
+  font-size: 0.85em;
+  margin-left: 1.25em;
+  padding-left: 1.25em;
+  border-left: thin var(--color-foreground-muted) solid;
+}
+.xr-array-wrap, .xr-var-data, .xr-var-preview {
+  font-size: 0.9em;
+}
+.gp {
+  color: darkorange;
+}

docs/source/api.rst

@@ -39,6 +39,6 @@ Aggregation Objects
 .. autosummary::
     :toctree: generated/
 
-    aggregations.Aggregation
-    aggregations.sum
+    Aggregation
+    aggregations.sum_
     aggregations.nansum

docs/source/conf.py

@@ -16,6 +16,9 @@
 import sys
 
 import flox
+import flox.aggregations
+import flox.visualize
+import flox.xarray
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -29,14 +32,14 @@
 
 # -- General configuration -----------------------------------------------------
 extensions = [
-    "myst_parser",
     "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
     "sphinx.ext.extlinks",
     "numpydoc",
     "sphinx.ext.napoleon",
+    "myst_nb",
 ]
 
 extlinks = {
@@ -45,7 +48,7 @@
 }
 
 templates_path = ["_templates"]
-source_suffix = [".rst", ".md"]
+source_suffix = [".rst"]
 master_doc = "index"
 language = "en"
 
@@ -117,7 +120,8 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ["_static"]
+html_static_path = ["_static"]
+html_css_files = ["style.css"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

docs/source/custom.md

@@ -4,6 +4,8 @@
 It also allows you to specify a custom Aggregation (again inspired by dask.dataframe),
 though this might not be fully functional at the moment. See `aggregations.py` for examples.
 
+See the ["Custom Aggregations"](user-stories/custom-aggregations.ipynb) user story for a more user-friendly example.
+
 ```python
     mean = Aggregation(
         # name used for dask tasks

docs/source/index.md

@@ -50,4 +50,5 @@ It was motivated by many discussions in the [Pangeo](https://pangeo.io) communit
    implementation.md
    custom.md
    api.rst
+   user-stories.md
 ```

docs/source/user-stories.md

@@ -0,0 +1,9 @@
+# User Stories
+
+```{eval-rst}
+.. toctree::
+   :maxdepth: 1
+
+   user-stories/climatology.ipynb
+   user-stories/custom-aggregations.ipynb
+```