Added note to example notebooks

welch-lab · Feb 23, 2024 · 1235c31 · 1235c31
1 parent 06c5359
commit 1235c31
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 18 deletions.
diff --git a/Examples/MultiVelo_Fig2.ipynb b/Examples/MultiVelo_Fig2.ipynb
@@ -40,7 +40,11 @@
     "|   `-- nn_idx.txt\n",
     "`-- velocyto\n",
     "    `-- 10X_multiome_mouse_brain.loom\n",
-    "```"
+    "```\n",
+    "\n",
+    "### Important Note:\n",
+    "\n",
+    "This notebook is designed to run on the current commit of Multivelo on GitHub. It utilizes features that are not yet available on the current pip release. As such, it is recommended to download Multivelo from GitHub and use that instead of the version available on PyPI."
    ]
   },
   {
@@ -1191,9 +1195,7 @@
    "cell_type": "code",
    "execution_count": 38,
    "id": "f0edead6",
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "data": {
@@ -1377,7 +1379,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.11.4"
   },
   "toc": {
    "base_numbering": 1,

diff --git a/Examples/MultiVelo_Fig3.ipynb b/Examples/MultiVelo_Fig3.ipynb
@@ -40,7 +40,10 @@
     "|   `-- nn_idx.txt\n",
     "`-- velocyto\n",
     "    `-- 10X_multiome_mouse_brain.loom\n",
-    "```"
+    "```\n",
+    "### Important Note:\n",
+    "\n",
+    "This notebook is designed to run on the current commit of Multivelo on GitHub. It utilizes features that are not yet available on the current pip release. As such, it is recommended to download Multivelo from GitHub and use that instead of the version available on PyPI."
    ]
   },
   {
@@ -1264,7 +1267,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.11.4"
   },
   "toc": {
    "base_numbering": 1,

diff --git a/Examples/MultiVelo_Fig4.ipynb b/Examples/MultiVelo_Fig4.ipynb
@@ -18,7 +18,10 @@
     "\n",
     "ATAC: https://figshare.com/account/projects/164296/articles/22575313\n",
     "\n",
-    "If you do not download them manually, the notebook will do so automatically."
+    "If you do not download them manually, the notebook will do so automatically.\n",
+    "\n",
+    "### Important Note:\n",
+    "This notebook is designed to run on the current commit of Multivelo on GitHub. It utilizes features that are not yet available on the current pip release. As such, it is recommended to download Multivelo from GitHub and use that instead of the version available on PyPI."
    ]
   },
   {
@@ -145,9 +148,7 @@
    "cell_type": "code",
    "execution_count": 7,
    "id": "9fd40e4d",
-   "metadata": {
-    "scrolled": false
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -985,7 +986,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.11.4"
   },
   "toc": {
    "base_numbering": 1,

diff --git a/Examples/MultiVelo_Fig5.ipynb b/Examples/MultiVelo_Fig5.ipynb
@@ -18,7 +18,11 @@
     "\n",
     "ATAC: https://figshare.com/account/projects/164299/articles/22575343\n",
     "\n",
-    "If you do not download them manually, the notebook will do so automatically."
+    "If you do not download them manually, the notebook will do so automatically.\n",
+    "\n",
+    "### Important Note:\n",
+    "\n",
+    "This notebook is designed to run on the current commit of Multivelo on GitHub. It utilizes features that are not yet available on the current pip release. As such, it is recommended to download Multivelo from GitHub and use that instead of the version available on PyPI."
    ]
   },
   {
@@ -29,8 +33,7 @@
     "ExecuteTime": {
      "end_time": "2022-05-09T20:11:58.142534Z",
      "start_time": "2022-05-09T20:11:54.599165Z"
-    },
-    "scrolled": false
+    }
    },
    "outputs": [
     {
@@ -1136,7 +1139,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.11.4"
   },
   "toc": {
    "base_numbering": 1,

diff --git a/Examples/MultiVelo_Fig6.ipynb b/Examples/MultiVelo_Fig6.ipynb
@@ -18,7 +18,10 @@
     "\n",
     "ATAC: https://figshare.com/account/projects/164308/articles/22575370\n",
     "\n",
-    "If you do not download them manually, the notebook will do so automatically."
+    "If you do not download them manually, the notebook will do so automatically.\n",
+    "\n",
+    "### Important Note:\n",
+    "This notebook is designed to run on the current commit of Multivelo on GitHub. It utilizes features that are not yet available on the current pip release. As such, it is recommended to download Multivelo from GitHub and use that instead of the version available on PyPI."
    ]
   },
   {
@@ -637,7 +640,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.11.4"
   },
   "toc": {
    "base_numbering": 1,