ENH raise error in 00_setup_colab if not run from Colab

TomDLT · TomDLT · commit 90c1c2158c06 · 2023-03-07T17:21:11.000-08:00
diff --git a/doc/Makefile b/doc/Makefile
@@ -47,8 +47,6 @@ merge-notebooks:
 		> $(NBDIR)/merged_for_colab.ipynb
 	echo "Saved in $(NBDIR)/merged_for_colab.ipynb"
 
-
-merge-notebooks-model-fitting:
 	python merge_notebooks.py \
 		$(NBDIR)/00_setup_colab.ipynb \
 		$(NBDIR)/01_plot_explainable_variance.ipynb \
diff --git a/tutorials/notebooks/shortclips/00_download_shortclips.ipynb b/tutorials/notebooks/shortclips/00_download_shortclips.ipynb
@@ -89,7 +89,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.3"
+      "version": "3.10.9"
     }
   },
   "nbformat": 4,
diff --git a/tutorials/notebooks/shortclips/00_setup_colab.ipynb b/tutorials/notebooks/shortclips/00_setup_colab.ipynb
@@ -72,6 +72,17 @@
         "# - Set up an email and username to use git, git-annex, and datalad (required to download the data)\n# - Add NeuroDebian to the package sources\n# - Update the gpg keys to use NeuroDebian\n# - Update the list of available packages\n# - Install Inkscape to use more features from Pycortex, and install git-annex to download the data\n# - Install the tutorial helper package, and all the required dependencies"
       ]
     },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "try:\n    import google.colab # noqa\n    in_colab = True\nexcept ImportError:\n    in_colab = False\nif not in_colab:\n    raise RuntimeError(\"This script is only meant to be run from Google \"\n                       \"Colab. You can skip it if you run the tutorials \"\n                       \"on your machine.\")"
+      ]
+    },
     {
       "cell_type": "markdown",
       "metadata": {},
@@ -132,7 +143,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.3"
+      "version": "3.10.9"
     }
   },
   "nbformat": 4,
diff --git a/tutorials/notebooks/shortclips/01_plot_explainable_variance.ipynb b/tutorials/notebooks/shortclips/01_plot_explainable_variance.ipynb
@@ -319,7 +319,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.3"
+      "version": "3.10.9"
     }
   },
   "nbformat": 4,
diff --git a/tutorials/notebooks/shortclips/02_plot_ridge_regression.ipynb b/tutorials/notebooks/shortclips/02_plot_ridge_regression.ipynb
@@ -406,7 +406,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.3"
+      "version": "3.10.9"
     }
   },
   "nbformat": 4,
diff --git a/tutorials/notebooks/shortclips/03_plot_wordnet_model.ipynb b/tutorials/notebooks/shortclips/03_plot_wordnet_model.ipynb
@@ -653,7 +653,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.3"
+      "version": "3.10.9"
     }
   },
   "nbformat": 4,
diff --git a/tutorials/notebooks/shortclips/04_plot_hemodynamic_response.ipynb b/tutorials/notebooks/shortclips/04_plot_hemodynamic_response.ipynb
@@ -352,7 +352,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.3"
+      "version": "3.10.9"
     }
   },
   "nbformat": 4,
diff --git a/tutorials/notebooks/shortclips/05_plot_motion_energy_model.ipynb b/tutorials/notebooks/shortclips/05_plot_motion_energy_model.ipynb
@@ -341,7 +341,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.3"
+      "version": "3.10.9"
     }
   },
   "nbformat": 4,
diff --git a/tutorials/notebooks/shortclips/06_plot_banded_ridge_model.ipynb b/tutorials/notebooks/shortclips/06_plot_banded_ridge_model.ipynb
@@ -510,7 +510,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.3"
+      "version": "3.10.9"
     }
   },
   "nbformat": 4,
diff --git a/tutorials/notebooks/shortclips/07_extract_motion_energy.ipynb b/tutorials/notebooks/shortclips/07_extract_motion_energy.ipynb
@@ -136,7 +136,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.3"
+      "version": "3.10.9"
     }
   },
   "nbformat": 4,
diff --git a/tutorials/notebooks/shortclips/merged_for_colab.ipynb b/tutorials/notebooks/shortclips/merged_for_colab.ipynb
@@ -104,6 +104,25 @@
     "# - Install the tutorial helper package, and all the required dependencies"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": false
+   },
+   "outputs": [],
+   "source": [
+    "try:\n",
+    "    import google.colab # noqa\n",
+    "    in_colab = True\n",
+    "except ImportError:\n",
+    "    in_colab = False\n",
+    "if not in_colab:\n",
+    "    raise RuntimeError(\"This script is only meant to be run from Google \"\n",
+    "                       \"Colab. You can skip it if you run the tutorials \"\n",
+    "                       \"on your machine.\")"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -4238,7 +4257,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.3"
+   "version": "3.10.9"
   },
   "name": "_merged"
  },
diff --git a/tutorials/notebooks/shortclips/merged_for_colab_model_fitting.ipynb b/tutorials/notebooks/shortclips/merged_for_colab_model_fitting.ipynb
@@ -104,6 +104,25 @@
     "# - Install the tutorial helper package, and all the required dependencies"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": false
+   },
+   "outputs": [],
+   "source": [
+    "try:\n",
+    "    import google.colab # noqa\n",
+    "    in_colab = True\n",
+    "except ImportError:\n",
+    "    in_colab = False\n",
+    "if not in_colab:\n",
+    "    raise RuntimeError(\"This script is only meant to be run from Google \"\n",
+    "                       \"Colab. You can skip it if you run the tutorials \"\n",
+    "                       \"on your machine.\")"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -3017,7 +3036,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.3"
+   "version": "3.10.9"
   },
   "name": "_merged"
  },
diff --git a/tutorials/notebooks/vim2/00_download_vim2.ipynb b/tutorials/notebooks/vim2/00_download_vim2.ipynb
@@ -100,7 +100,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.3"
+      "version": "3.10.9"
     }
   },
   "nbformat": 4,
diff --git a/tutorials/notebooks/vim2/01_extract_motion_energy.ipynb b/tutorials/notebooks/vim2/01_extract_motion_energy.ipynb
@@ -143,7 +143,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.3"
+      "version": "3.10.9"
     }
   },
   "nbformat": 4,
diff --git a/tutorials/notebooks/vim2/02_plot_ridge_model.ipynb b/tutorials/notebooks/vim2/02_plot_ridge_model.ipynb
@@ -334,7 +334,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.8.3"
+      "version": "3.10.9"
     }
   },
   "nbformat": 4,
diff --git a/tutorials/shortclips/00_setup_colab.py b/tutorials/shortclips/00_setup_colab.py
@@ -42,8 +42,18 @@
 # - Install the tutorial helper package, and all the required dependencies
 
 ###############################################################################
-# Now run the following cell to download the data for the tutorials.
+try:
+    import google.colab # noqa
+    in_colab = True
+except ImportError:
+    in_colab = False
+if not in_colab:
+    raise RuntimeError("This script is only meant to be run from Google "
+                       "Colab. You can skip it if you run the tutorials "
+                       "on your machine.")
 
+###############################################################################
+# Now run the following cell to download the data for the tutorials.
 
 from voxelwise_tutorials.io import download_datalad
 

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@`
`89`	`89`	`"name": "python",`
`90`	`90`	`"nbconvert_exporter": "python",`
`91`	`91`	`"pygments_lexer": "ipython3",`
`92`		`- "version": "3.8.3"`
	`92`	`+ "version": "3.10.9"`
`93`	`93`	`}`
`94`	`94`	`},`
`95`	`95`	`"nbformat": 4,`
Original file line number	Diff line number	Diff line change
`@@ -319,7 +319,7 @@`
`319`	`319`	`"name": "python",`
`320`	`320`	`"nbconvert_exporter": "python",`
`321`	`321`	`"pygments_lexer": "ipython3",`
`322`		`- "version": "3.8.3"`
	`322`	`+ "version": "3.10.9"`
`323`	`323`	`}`
`324`	`324`	`},`
`325`	`325`	`"nbformat": 4,`
Original file line number	Diff line number	Diff line change
`@@ -406,7 +406,7 @@`
`406`	`406`	`"name": "python",`
`407`	`407`	`"nbconvert_exporter": "python",`
`408`	`408`	`"pygments_lexer": "ipython3",`
`409`		`- "version": "3.8.3"`
	`409`	`+ "version": "3.10.9"`
`410`	`410`	`}`
`411`	`411`	`},`
`412`	`412`	`"nbformat": 4,`
Original file line number	Diff line number	Diff line change
`@@ -653,7 +653,7 @@`
`653`	`653`	`"name": "python",`
`654`	`654`	`"nbconvert_exporter": "python",`
`655`	`655`	`"pygments_lexer": "ipython3",`
`656`		`- "version": "3.8.3"`
	`656`	`+ "version": "3.10.9"`
`657`	`657`	`}`
`658`	`658`	`},`
`659`	`659`	`"nbformat": 4,`
Original file line number	Diff line number	Diff line change
`@@ -352,7 +352,7 @@`
`352`	`352`	`"name": "python",`
`353`	`353`	`"nbconvert_exporter": "python",`
`354`	`354`	`"pygments_lexer": "ipython3",`
`355`		`- "version": "3.8.3"`
	`355`	`+ "version": "3.10.9"`
`356`	`356`	`}`
`357`	`357`	`},`
`358`	`358`	`"nbformat": 4,`
Original file line number	Diff line number	Diff line change
`@@ -341,7 +341,7 @@`
`341`	`341`	`"name": "python",`
`342`	`342`	`"nbconvert_exporter": "python",`
`343`	`343`	`"pygments_lexer": "ipython3",`
`344`		`- "version": "3.8.3"`
	`344`	`+ "version": "3.10.9"`
`345`	`345`	`}`
`346`	`346`	`},`
`347`	`347`	`"nbformat": 4,`
Original file line number	Diff line number	Diff line change
`@@ -510,7 +510,7 @@`
`510`	`510`	`"name": "python",`
`511`	`511`	`"nbconvert_exporter": "python",`
`512`	`512`	`"pygments_lexer": "ipython3",`
`513`		`- "version": "3.8.3"`
	`513`	`+ "version": "3.10.9"`
`514`	`514`	`}`
`515`	`515`	`},`
`516`	`516`	`"nbformat": 4,`
Original file line number	Diff line number	Diff line change
`@@ -136,7 +136,7 @@`
`136`	`136`	`"name": "python",`
`137`	`137`	`"nbconvert_exporter": "python",`
`138`	`138`	`"pygments_lexer": "ipython3",`
`139`		`- "version": "3.8.3"`
	`139`	`+ "version": "3.10.9"`
`140`	`140`	`}`
`141`	`141`	`},`
`142`	`142`	`"nbformat": 4,`