fix(docs): clone branch or tag in colab template

Signed-off-by: Cameron Smith <[email protected]>
pinellolab · Jan 3, 2024 · 623048c · 623048c
1 parent 4a352d3
commit 623048c
Showing 1 changed file with 21 additions and 14 deletions.
diff --git a/docs/source/notebooks/pyrovelocity_colab_template.ipynb b/docs/source/notebooks/pyrovelocity_colab_template.ipynb
@@ -108,9 +108,16 @@
       },
       "outputs": [],
       "source": [
-        "%cd /content\n",
-        "%rm -f \"__installer__.sh\"\n",
-        "!git clone https://github.com/pinellolab/pyrovelocity.git"
+        "%%bash\n",
+        "\n",
+        "cd /content\n",
+        "rm -f \"__installer__.sh\"\n",
+        "rm -rf pyrovelocity\n",
+        "\n",
+        "# change the branch argument from a tag to a branch in development\n",
+        "git clone \\\n",
+        "--branch v0.1.3 \\\n",
+        "https://github.com/pinellolab/pyrovelocity.git"
       ]
     },
     {
@@ -119,7 +126,9 @@
         "id": "v_lKa94u4g2Z"
       },
       "source": [
-        "Because google colab uses python 3.9, you may need to edit the python version constraint in `pyproject.toml` to install in colab."
+        "If the colab python version is out of sync with the python version constraint in `pyproject.toml`, you may need to edit the version downloaded above to install in colab.\n",
+        "\n",
+        "Note that the kernel will restart again after the following command. After this you should be able to proceed to Check Installation without rerunning any of the cells above it."
       ]
     },
     {
@@ -135,6 +144,13 @@
         "get_ipython().kernel.do_shutdown(True)"
       ]
     },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "### Check installation"
+      ]
+    },
     {
       "cell_type": "markdown",
       "metadata": {
@@ -154,16 +170,7 @@
         "id": "QvXoFzK-zATP",
         "outputId": "f2a47888-6fc6-47c5-d3df-631173840ae2"
       },
-      "outputs": [
-        {
-          "name": "stdout",
-          "output_type": "stream",
-          "text": [
-            "/content/pyrovelocity/pyrovelocity/__init__.py\n",
-            "0.1.1\n"
-          ]
-        }
-      ],
+      "outputs": [],
       "source": [
         "import pyrovelocity\n",
         "print(pyrovelocity.__file__)\n",