Merge pull request #103 from StingraySoftware/address_pyopensci_comments

Address PyOpenSci comments
StingraySoftware · Sep 10, 2024 · 29875e8 · 29875e8
2 parents b013a5f + 54a0f7e
commit 29875e8
Show file tree

Hide file tree

Showing 2 changed files with 89 additions and 33 deletions.
diff --git a/Lightcurve/Lightcurve tutorial.ipynb b/Lightcurve/Lightcurve tutorial.ipynb
@@ -1237,7 +1237,13 @@
   {
    "cell_type": "code",
    "execution_count": 57,
-   "metadata": {},
+   "metadata": {
+    "editable": true,
+    "slideshow": {
+     "slide_type": ""
+    },
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "lc.check_lightcurve()"
@@ -1253,17 +1259,33 @@
   {
    "cell_type": "code",
    "execution_count": 58,
-   "metadata": {},
+   "metadata": {
+    "editable": true,
+    "slideshow": {
+     "slide_type": ""
+    },
+    "tags": [
+     "raises-exception"
+    ]
+   },
    "outputs": [],
    "source": [
-    "gti = [(10, 100), (20, 30, 40), ((1, 2), (3, 4, (5, 6)))] # not a well-behaved GTI\n",
+    "gti = [(10, 100, 123), (20, 30, 40)] # not a well-behaved GTI\n",
     "lc = Lightcurve(time, counts, dt=0.1, skip_checks=True, gti=gti)"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 59,
-   "metadata": {},
+   "metadata": {
+    "editable": true,
+    "slideshow": {
+     "slide_type": ""
+    },
+    "tags": [
+     "raises-exception"
+    ]
+   },
    "outputs": [
     {
      "ename": "TypeError",
@@ -1280,6 +1302,7 @@
     }
    ],
    "source": [
+    "# This will fail\n",
     "lc.check_lightcurve()"
    ]
   },
@@ -1420,7 +1443,13 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "editable": true,
+    "slideshow": {
+     "slide_type": ""
+    },
+    "tags": []
+   },
    "source": [
     "## Working with GTIs and Splitting Light Curves\n",
     "\n",
@@ -1737,7 +1766,13 @@
   {
    "cell_type": "code",
    "execution_count": 82,
-   "metadata": {},
+   "metadata": {
+    "editable": true,
+    "slideshow": {
+     "slide_type": ""
+    },
+    "tags": []
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -1767,7 +1802,13 @@
   {
    "cell_type": "code",
    "execution_count": 83,
-   "metadata": {},
+   "metadata": {
+    "editable": true,
+    "slideshow": {
+     "slide_type": ""
+    },
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "start_times, stop_times, lc_sums = lc.analyze_lc_chunks(segment_size = 10.0, func=np.median)"
@@ -1817,7 +1858,13 @@
   {
    "cell_type": "code",
    "execution_count": 86,
-   "metadata": {},
+   "metadata": {
+    "editable": true,
+    "slideshow": {
+     "slide_type": ""
+    },
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "start_times, stop_times, lc_result = lc.analyze_lc_chunks(segment_size=10.0, func=myfunc)"
@@ -1846,7 +1893,13 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {},
+   "metadata": {
+    "editable": true,
+    "slideshow": {
+     "slide_type": ""
+    },
+    "tags": []
+   },
    "source": [
     "## Compatibility with `Lightkurve`\n",
     "\n",
@@ -1856,7 +1909,13 @@
   {
    "cell_type": "code",
    "execution_count": 88,
-   "metadata": {},
+   "metadata": {
+    "editable": true,
+    "slideshow": {
+     "slide_type": ""
+    },
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "import lightkurve"
@@ -1865,7 +1924,13 @@
   {
    "cell_type": "code",
    "execution_count": 89,
-   "metadata": {},
+   "metadata": {
+    "editable": true,
+    "slideshow": {
+     "slide_type": ""
+    },
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "lc_new = lc.to_lightkurve()"
@@ -2139,7 +2204,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -2153,9 +2218,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.5"
+   "version": "3.11.6"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 1
+ "nbformat_minor": 4
 }
diff --git a/Multitaper/multitaper_example.ipynb b/Multitaper/multitaper_example.ipynb
@@ -203,9 +203,7 @@
    "cell_type": "code",
    "execution_count": 5,
    "id": "b7b5e756",
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "data": {
@@ -256,9 +254,7 @@
    "cell_type": "code",
    "execution_count": 6,
    "id": "eb8f5358",
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "data": {
@@ -653,9 +649,7 @@
    "cell_type": "code",
    "execution_count": 12,
    "id": "f305d250",
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "data": {
@@ -778,9 +772,7 @@
    "cell_type": "code",
    "execution_count": 13,
    "id": "a03504ed",
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "data": {
@@ -867,9 +859,7 @@
    "cell_type": "code",
    "execution_count": 14,
    "id": "efea10b1",
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stderr",
@@ -1046,8 +1036,9 @@
    "source": [
     "# Loading data\n",
     "import pandas as pd\n",
-    "\n",
-    "kepler_data = pd.read_csv(\"https://raw.githubusercontent.com/StingraySoftware/notebooks/tree/main/Multitaper/koi2133.csv\")\n",
+    "# If downloaded locally, use\n",
+    "# pd.read_csv(\"koi2133.csv\")\n",
+    "kepler_data = pd.read_csv(\"https://raw.githubusercontent.com/StingraySoftware/notebooks/main/Multitaper/koi2133.csv\")\n",
     "times_kp = np.array(kepler_data[\"times\"])\n",
     "flux_kp = np.array(kepler_data[\"flux\"])"
    ]
@@ -1351,7 +1342,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -1365,7 +1356,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.5"
+   "version": "3.11.6"
   }
  },
  "nbformat": 4,