Simplify "Working with the Ensemble" Notebook (#401)

* Streamline Working with the Ensemble Notebook * Add diagrams of the Ensemble API structure * Centered images and modified links * Fix typos
lincc-frameworks · Mar 15, 2024 · 8f0c7b7 · 8f0c7b7
1 parent 0448c67
commit 8f0c7b7
Show file tree

Hide file tree

Showing 4 changed files with 88 additions and 620 deletions.
diff --git a/docs/_static/tutorial_images/ensemble_api_structure.png b/docs/_static/tutorial_images/ensemble_api_structure.png
diff --git a/docs/_static/tutorial_images/ensemble_frame_hierarchy.png b/docs/_static/tutorial_images/ensemble_frame_hierarchy.png
diff --git a/docs/tutorials/batch_showcase.ipynb b/docs/tutorials/batch_showcase.ipynb
@@ -30,11 +30,6 @@
     "import sys"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": []
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -550,12 +545,27 @@
     "res_otsu.compute()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Using light-curve package features\n",
+    "`Ensemble.batch()` also supports the use of [light-curve](https://pypi.org/project/light-curve/) package feature extractor:"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
    "outputs": [],
-   "source": []
+   "source": [
+    "import light_curve as licu\n",
+    "\n",
+    "extractor = licu.Extractor(licu.Amplitude(), licu.AndersonDarlingNormal(), licu.StetsonK())\n",
+    "# band_to_calc=None will ignore the band column and use all sources for each object\n",
+    "res = ens.batch(extractor, band_to_calc=\"g\")\n",
+    "res.compute()"
+   ]
   }
  ],
  "metadata": {
@@ -574,7 +584,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.11"
+   "version": "3.10.13"
   },
   "vscode": {
    "interpreter": {