From 2cb17bae4065e301389b5898f91b53ace5af3508 Mon Sep 17 00:00:00 2001 From: jpn-- Date: Tue, 16 Jan 2024 21:27:07 +0000 Subject: [PATCH] deploy: c560b45f0e1cd5ccbb871319b5ccfbcf789debaf --- .buildinfo | 2 +- _modules/index.html | 86 +- _modules/sharrow/dataset.html | 113 +- _modules/sharrow/flows.html | 126 +- _modules/sharrow/relationships.html | 130 +- _sources/walkthrough/encoding.ipynb | 229 ++- _sources/walkthrough/one-dim.ipynb | 375 +++-- _sources/walkthrough/sparse.ipynb | 245 ++-- _sources/walkthrough/two-dim.ipynb | 342 +++-- .../_sphinx_javascript_frameworks_compat.js | 134 ++ _static/basic.css | 54 +- _static/doctools.js | 480 +++---- _static/documentation_options.js | 6 +- _static/{jquery-3.5.1.js => jquery-3.6.0.js} | 227 +-- _static/jquery.js | 4 +- _static/language_data.js | 100 +- _static/scripts/bootstrap.js | 2 +- _static/scripts/bootstrap.js.LICENSE.txt | 4 +- _static/scripts/bootstrap.js.map | 2 +- _static/scripts/pydata-sphinx-theme.js | 2 +- _static/scripts/pydata-sphinx-theme.js.map | 2 +- _static/searchtools.js | 784 ++++++----- _static/styles/bootstrap.css | 8 +- _static/styles/bootstrap.css.map | 1 + _static/styles/pydata-sphinx-theme.css | 3 +- _static/styles/pydata-sphinx-theme.css.map | 1 + .../vendor/fontawesome/6.1.2/css/all.min.css | 5 - .../6.1.2/webfonts/fa-brands-400.ttf | Bin 181264 -> 0 bytes .../6.1.2/webfonts/fa-brands-400.woff2 | Bin 105112 -> 0 bytes .../6.1.2/webfonts/fa-regular-400.ttf | Bin 60236 -> 0 bytes .../6.1.2/webfonts/fa-regular-400.woff2 | Bin 24028 -> 0 bytes .../6.1.2/webfonts/fa-solid-900.ttf | Bin 389948 -> 0 bytes .../6.1.2/webfonts/fa-solid-900.woff2 | Bin 154840 -> 0 bytes .../6.1.2/webfonts/fa-v4compatibility.ttf | Bin 10084 -> 0 bytes .../6.1.2/webfonts/fa-v4compatibility.woff2 | Bin 4776 -> 0 bytes .../fontawesome/{6.1.2 => 6.5.1}/LICENSE.txt | 4 +- .../vendor/fontawesome/6.5.1/css/all.min.css | 5 + .../vendor/fontawesome/6.5.1/js/all.min.js | 2 + .../6.5.1/js/all.min.js.LICENSE.txt | 5 + .../6.5.1/webfonts/fa-brands-400.ttf | Bin 0 -> 207972 bytes .../6.5.1/webfonts/fa-brands-400.woff2 | Bin 0 -> 117372 bytes .../6.5.1/webfonts/fa-regular-400.ttf | Bin 0 -> 68004 bytes .../6.5.1/webfonts/fa-regular-400.woff2 | Bin 0 -> 25452 bytes .../6.5.1/webfonts/fa-solid-900.ttf | Bin 0 -> 419720 bytes .../6.5.1/webfonts/fa-solid-900.woff2 | Bin 0 -> 156496 bytes .../6.5.1/webfonts/fa-v4compatibility.ttf | Bin 0 -> 10832 bytes .../6.5.1/webfonts/fa-v4compatibility.woff2 | Bin 0 -> 4792 bytes _static/webpack-macros.html | 23 +- api.html | 493 +++---- genindex.html | 86 +- index.html | 95 +- intro.html | 97 +- search.html | 84 +- searchindex.js | 2 +- walkthrough/encoding.html | 929 ++++++------ walkthrough/index.html | 88 +- walkthrough/one-dim.html | 730 +++++----- walkthrough/sparse.html | 1253 +++++++++-------- walkthrough/two-dim.html | 535 +++---- 59 files changed, 4325 insertions(+), 3573 deletions(-) create mode 100644 _static/_sphinx_javascript_frameworks_compat.js rename _static/{jquery-3.5.1.js => jquery-3.6.0.js} (98%) create mode 100644 _static/styles/bootstrap.css.map create mode 100644 _static/styles/pydata-sphinx-theme.css.map delete mode 100644 _static/vendor/fontawesome/6.1.2/css/all.min.css delete mode 100644 _static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.ttf delete mode 100644 _static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2 delete mode 100644 _static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.ttf delete mode 100644 _static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2 delete mode 100644 _static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.ttf delete mode 100644 _static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2 delete mode 100644 _static/vendor/fontawesome/6.1.2/webfonts/fa-v4compatibility.ttf delete mode 100644 _static/vendor/fontawesome/6.1.2/webfonts/fa-v4compatibility.woff2 rename _static/vendor/fontawesome/{6.1.2 => 6.5.1}/LICENSE.txt (98%) create mode 100644 _static/vendor/fontawesome/6.5.1/css/all.min.css create mode 100644 _static/vendor/fontawesome/6.5.1/js/all.min.js create mode 100644 _static/vendor/fontawesome/6.5.1/js/all.min.js.LICENSE.txt create mode 100644 _static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.ttf create mode 100644 _static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2 create mode 100644 _static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.ttf create mode 100644 _static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2 create mode 100644 _static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.ttf create mode 100644 _static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2 create mode 100644 _static/vendor/fontawesome/6.5.1/webfonts/fa-v4compatibility.ttf create mode 100644 _static/vendor/fontawesome/6.5.1/webfonts/fa-v4compatibility.woff2 diff --git a/.buildinfo b/.buildinfo index 848089c..b292330 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 51f2cc419d3bb38499a014514559aa0c +config: e81c7af78bdc45d0158326e2c90823f7 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_modules/index.html b/_modules/index.html index d17e14d..797bbae 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -3,12 +3,12 @@ - + - Overview: module code — v2.6.0 + Overview: module code — v2.7.0 @@ -18,15 +18,15 @@ - - - + + + - - - - + + + + @@ -39,12 +39,14 @@ - - + + + + @@ -65,7 +67,7 @@ - + @@ -73,7 +75,16 @@ - + + +
+ + + + Ctrl+K + +
- +
+
+
+
+ + + +
@@ -127,6 +146,7 @@
+
@@ -262,20 +283,22 @@ + + @@ -302,7 +325,7 @@

-
+

All modules for which code is available

  • sharrow.dataset
    • @@ -315,22 +338,20 @@

    All modules for which code is available

    -
    + + +
    -
    - -
    -
    -
    -
+
+
@@ -347,6 +368,7 @@

All modules for which code is available

+

© Copyright 2022 AMPO Research Foundation. @@ -373,8 +395,8 @@

All modules for which code is available

- - + +
diff --git a/_modules/sharrow/dataset.html b/_modules/sharrow/dataset.html index 6ae3358..98717cc 100644 --- a/_modules/sharrow/dataset.html +++ b/_modules/sharrow/dataset.html @@ -3,12 +3,12 @@ - + - sharrow.dataset — v2.6.0 + sharrow.dataset — v2.7.0 @@ -18,15 +18,15 @@ - - - + + + - - - - + + + + @@ -39,12 +39,14 @@ - - + + + + @@ -65,7 +67,7 @@ - + @@ -73,7 +75,16 @@ - + + +
+ + + + Ctrl+K
+ +
- +
+
+
+
+ + + +
@@ -127,6 +146,7 @@
+
@@ -262,20 +283,22 @@ + + @@ -302,7 +325,7 @@

-
+

Source code for sharrow.dataset

 from __future__ import annotations
@@ -386,7 +409,7 @@ 
Source code for sharrow.dataset
 
 
[docs]def construct(source):
     """
-    A generic constructor for creating Datasets from various similar objects.
+    Create Datasets from various similar objects.
 
     Parameters
     ----------
@@ -418,7 +441,7 @@ 
Source code for sharrow.dataset
     sparse: bool = False,
     preserve_cat: bool = True,
 ) -> Dataset:
-    """Convert a pandas.DataFrame into an xarray.Dataset
+    """Convert a pandas.DataFrame into an xarray.Dataset.
 
     Each column will be converted into an independent variable in the
     Dataset. If the dataframe's index is a MultiIndex, it will be expanded
@@ -436,6 +459,13 @@ 
Source code for sharrow.dataset
         If true, create a sparse arrays instead of dense numpy arrays. This
         can potentially save a large amount of memory if the DataFrame has
         a MultiIndex. Requires the sparse package (sparse.pydata.org).
+    preserve_cat : bool, default True
+        If true, preserve encoding of categorical columns.  Xarray lacks an
+        official implementation of a categorical datatype, so sharrow's
+        dictionary-based digital encoding is applied instead. Note that in
+        native xarray usage, the resulting variable will look like integer
+        values instead of the category values.  The `dataset.cat` accessor
+        can be used to interact with the categorical data.
 
     Returns
     -------
@@ -446,7 +476,6 @@ 
Source code for sharrow.dataset
     xarray.DataArray.from_series
     pandas.DataFrame.to_xarray
     """
-
     # this is much faster than the default xarray version when not
     # using a MultiIndex.
 
@@ -515,7 +544,7 @@ 
Source code for sharrow.dataset
     index=None,
 ):
     """
-    Convert a pyarrow.Table into an xarray.Dataset
+    Convert a pyarrow.Table into an xarray.Dataset.
 
     Parameters
     ----------
@@ -620,7 +649,6 @@ 
Source code for sharrow.dataset
     -------
     Dataset
     """
-
     # handle both larch.OMX and openmatrix.open_file versions
     if "lar" in type(omx).__module__:
         omx_data = omx.data
@@ -995,9 +1023,7 @@ 
Source code for sharrow.dataset
 
 @xr.register_dataset_accessor("single_dim")
 class _SingleDim:
-    """
-    Convenience accessor for single-dimension datasets.
-    """
+    """Convenience accessor for single-dimension datasets."""
 
     __slots__ = ("dataset", "dim_name")
 
@@ -1139,9 +1165,7 @@ 
Source code for sharrow.dataset
 
 @xr.register_dataarray_accessor("single_dim")
 class _SingleDimArray:
-    """
-    Convenience accessor for single-dimension datasets.
-    """
+    """Convenience accessor for single-dimension datasets."""
 
     __slots__ = ("dataarray", "dim_name")
 
@@ -1494,7 +1518,7 @@ 
Source code for sharrow.dataset
     from .relationships import sparse_array_type
 
     def to_numpy(var):
-        """Coerces wrapped data to numpy and returns a numpy.ndarray"""
+        """Coerces wrapped data to numpy and returns a numpy.ndarray."""
         data = var.data
         if hasattr(data, "chunks"):
             data = data.compute()
@@ -1518,7 +1542,7 @@ 
Source code for sharrow.dataset
 @register_dataset_method
 def select_and_rename(self, name_dict=None, **names):
     """
-    Select and rename variables from this Dataset
+    Select and rename variables from this Dataset.
 
     Parameters
     ----------
@@ -1682,22 +1706,20 @@ 
Source code for sharrow.dataset
 
               
               
-                

+              
+              
+                

                   
-

-  
-    

 

-

-  
 

-
                 

               
             

             
             
               
+                

+