Merge pull request #262 from Ouranosinc/to-excel

Save to excel

HISTORY.rst

@@ -16,6 +16,7 @@ New features and enhancements
 * ``xs.spatial_mean`` now accepts the ``region="global"`` keyword to perform a global average (:issue:`94`, :pull:`260`).
 * ``xs.spatial_mean`` with ``method='xESMF'`` will also automatically segmentize polygons (down to a 1° resolution) to ensure a correct average (:pull:`260`).
 * Added documentation for `require_all_on` in `search_data_catalogs`. (:pull:`263`).
+* ``xs.save_to_table`` and ``xs.io.to_table`` to transform datasets and arrays to DataFrames, but with support for multi-columns, multi-sheets and localized table of content generation.
 
 Breaking changes
 ^^^^^^^^^^^^^^^^

tests/test_io.py

@@ -1,5 +1,6 @@
 import numpy as np
 import pytest
+import xarray as xr
 
 import xscen as xs
 
@@ -66,3 +67,52 @@ def test_variables(self, datablock_3d):
         for v in ds_ch.data_vars:
             for dim, chunks in zip(list(ds.dims), ds_ch[v].chunks):
                 assert chunks[0] == new_chunks[v][dim]
+
+
+class TestToTable:
+    ds = xs.utils.unstack_dates(
+        xr.merge(
+            [
+                xs.testing.datablock_3d(
+                    np.random.random_sample((20, 3, 2)),
+                    v,
+                    "lon",
+                    0,
+                    "lat",
+                    0,
+                    1,
+                    1,
+                    "1993-01-01",
+                    "QS-JAN",
+                )
+                for v in ["tas", "pr", "snw"]
+            ]
+        )
+        .stack(site=["lat", "lon"])
+        .reset_index("site")
+        .assign_coords(site=list("abcdef"))
+    ).transpose("season", "time", "site")
+
+    def test_normal(self):
+        # Default
+        tab = xs.io.to_table(self.ds)
+        assert tab.shape == (120, 5)  # 3 vars + 2 aux coords
+        assert tab.columns.names == ["variable"]
+        assert tab.index.names == ["season", "time", "site"]
+        # Season order is chronological, rather than alphabetical
+        np.testing.assert_array_equal(
+            tab.xs("1993", level="time")
+            .xs("a", level="site")
+            .index.get_level_values("season"),
+            ["JFM", "AMJ", "JAS", "OND"],
+        )
+
+        # Variable in the index, thus no coords
+        tab = xs.io.to_table(
+            self.ds, row=["time", "variable"], column=["season", "site"], coords=False
+        )
+        assert tab.shape == (15, 24)
+        assert tab.columns.names == ["season", "site"]
+        np.testing.assert_array_equal(
+            tab.loc[("1993", "pr"), ("JFM",)], self.ds.pr.sel(time="1993", season="JFM")
+        )

xscen/__init__.py

@@ -36,7 +36,7 @@
     subset_warming_level,
 )
 from .indicators import compute_indicators  # noqa
-from .io import save_to_netcdf, save_to_zarr  # noqa
+from .io import save_to_netcdf, save_to_table, save_to_zarr  # noqa
 from .reduce import build_reduction_data, reduce_ensemble
 from .regrid import *
 from .scripting import (

xscen/data/fr/LC_MESSAGES/xscen.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: xscen 0.6.18b0\n"
 "Report-Msgid-Bugs-To: [email protected]\n"
-"POT-Creation-Date: 2023-09-08 15:17-0400\n"
+"POT-Creation-Date: 2023-09-29 11:45-0400\n"
 "PO-Revision-Date: 2023-08-15 16:48-0400\n"
 "Last-Translator: Pascal Bourgault <[email protected]>\n"
 "Language: fr\n"
@@ -18,18 +18,34 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Generated-By: Babel 2.12.1\n"
 
-#: xscen/aggregate.py:184
+#: xscen/aggregate.py:185
 msgid "{window}-year mean of {attr}."
 msgstr "Moyenne {window} ans de {attr}."
 
-#: xscen/aggregate.py:318
+#: xscen/aggregate.py:319
 msgid "{attr1}: {kind} delta compared to {refhoriz}."
 msgstr "{attr1}: Delta {kind} comparé à {refhoriz}."
 
-#: xscen/diagnostics.py:500
+#: xscen/diagnostics.py:501
 msgid "Ranking of measure performance"
 msgstr "Classement de performance de la mesure"
 
-#: xscen/diagnostics.py:559
+#: xscen/diagnostics.py:560
 msgid "Fraction of improved grid cells"
 msgstr "Fraction de points de grille améliorés"
+
+#: xscen/io.py:650
+msgid "Variable"
+msgstr "Variable"
+
+#: xscen/io.py:650
+msgid "Description"
+msgstr "Description"
+
+#: xscen/io.py:650
+msgid "Units"
+msgstr "Unités"
+
+#: xscen/io.py:654
+msgid "Content"
+msgstr "Contenu"