Merge pull request #327 from lincc-frameworks/batch_per_band_attempt2

Add `by_band` kwarg to batch, allow each lightcurve band to be processed independently
lincc-frameworks · Dec 21, 2023 · 97a2bfc · 97a2bfc
2 parents e7bea17 + 5215892
commit 97a2bfc
Show file tree

Hide file tree

Showing 10 changed files with 797 additions and 74 deletions.
diff --git a/docs/examples/rrlyr-period.ipynb b/docs/examples/rrlyr-period.ipynb
@@ -66,7 +66,7 @@
     "periodogram = Periodogram(peaks=1, nyquist=0.1, max_freq_factor=10, fast=False)\n",
     "\n",
     "# Use r band only\n",
-    "df = ens.batch(periodogram, band_to_calc='r')\n",
+    "df = ens.batch(periodogram, band_to_calc='r').compute()\n",
     "display(df)\n",
     "\n",
     "# Find RR Lyr with the most confient period\n",
@@ -121,13 +121,13 @@
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
-    "version": 2
+    "version": 3
    },
    "file_extension": ".py",
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython2",
+   "pygments_lexer": "ipython3",
    "version": "3.10.11"
   },
   "vscode": {

diff --git a/docs/gettingstarted/quickstart.ipynb b/docs/gettingstarted/quickstart.ipynb
@@ -108,7 +108,7 @@
    "source": [
     "from tape.analysis import calc_sf2\n",
     "result = ens.batch(calc_sf2, sf_method=\"macleod_2012\") # The batch function applies the provided function to all individual lightcurves within the Ensemble\n",
-    "result"
+    "result.compute()"
    ]
   },
   {

diff --git a/docs/tutorials.rst b/docs/tutorials.rst
@@ -11,6 +11,7 @@ functionality.
     Scaling to Large Data Volume <tutorials/scaling_to_large_data>
     Working with Structure Function <tutorials/working_with_structure_function>
     Binning Sources in the Ensemble <tutorials/binning_slowly_changing_sources>
+    Batch Function Showcase <tutorials/batch_showcase>
     Structure Function Showcase <tutorials/structure_function_showcase>
     Loading Data into the Ensemble <tutorials/tape_datasets>
     Using Ray with the Ensemble <tutorials/using_ray_with_the_ensemble>