Add instructions for running Java notebooks

sualeh · May 8, 2024 · ca9f641 · ca9f641
1 parent 2c6c40d
commit ca9f641
Show file tree

Hide file tree

Showing 4 changed files with 150 additions and 6 deletions.
diff --git a/Notebooks/2_java_unicode_case_conversions.ipynb b/Notebooks/2_java_unicode_case_conversions.ipynb
@@ -1,5 +1,42 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "----------\n",
+    "\n",
+    "> **How to Run This Notebook**\n",
+    "\n",
+    "You can run this notebook in Google Colab. The cell below should be run only once, and then followed by a change of runtime to \"Java (java)\". Refresh the browser before running any subsequent code. You can also run this notebook locally if you have the IJava kernel for Jupyter installed."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#@title Prepare Google Colab for IJava Kernel\n",
+    "\n",
+    "%%sh\n",
+    "# Install java kernel\n",
+    "wget -q https://github.com/SpencerPark/IJava/releases/download/v1.3.0/ijava-1.3.0.zip\n",
+    "unzip -q ijava-1.3.0.zip\n",
+    "python install.py\n",
+    "\n",
+    "# Install proxy for the java kernel\n",
+    "wget -qO- https://gist.github.com/SpencerPark/e2732061ad19c1afa4a33a58cb8f18a9/archive/b6cff2bf09b6832344e576ea1e4731f0fb3df10c.tar.gz | tar xvz --strip-components=1\n",
+    "python install_ipc_proxy_kernel.py --kernel=java --implementation=ipc_proxy_kernel.py"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "----------"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

diff --git a/Notebooks/3_java_unicode_numbers.ipynb b/Notebooks/3_java_unicode_numbers.ipynb
@@ -1,5 +1,42 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "----------\n",
+    "\n",
+    "> **How to Run This Notebook**\n",
+    "\n",
+    "You can run this notebook in Google Colab. The cell below should be run only once, and then followed by a change of runtime to \"Java (java)\". Refresh the browser before running any subsequent code. You can also run this notebook locally if you have the IJava kernel for Jupyter installed."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#@title Prepare Google Colab for IJava Kernel\n",
+    "\n",
+    "%%sh\n",
+    "# Install java kernel\n",
+    "wget -q https://github.com/SpencerPark/IJava/releases/download/v1.3.0/ijava-1.3.0.zip\n",
+    "unzip -q ijava-1.3.0.zip\n",
+    "python install.py\n",
+    "\n",
+    "# Install proxy for the java kernel\n",
+    "wget -qO- https://gist.github.com/SpencerPark/e2732061ad19c1afa4a33a58cb8f18a9/archive/b6cff2bf09b6832344e576ea1e4731f0fb3df10c.tar.gz | tar xvz --strip-components=1\n",
+    "python install_ipc_proxy_kernel.py --kernel=java --implementation=ipc_proxy_kernel.py"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "----------"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -19,11 +56,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {
-    "vscode": {
-     "languageId": "java"
-    }
-   },
+   "metadata": {},
    "outputs": [],
    "source": [
     "final String hindiNumber = \"१२३४५६७८९०\";\n",
@@ -43,7 +76,7 @@
    "codemirror_mode": "java",
    "file_extension": ".jshell",
    "mimetype": "text/x-java-source",
-   "name": "Java",
+   "name": "java",
    "pygments_lexer": "java",
    "version": "17.0.6+9-LTS-190"
   }

diff --git a/Notebooks/4_java_encoding.ipynb b/Notebooks/4_java_encoding.ipynb
@@ -1,5 +1,42 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "----------\n",
+    "\n",
+    "> **How to Run This Notebook**\n",
+    "\n",
+    "You can run this notebook in Google Colab. The cell below should be run only once, and then followed by a change of runtime to \"Java (java)\". Refresh the browser before running any subsequent code. You can also run this notebook locally if you have the IJava kernel for Jupyter installed."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#@title Prepare Google Colab for IJava Kernel\n",
+    "\n",
+    "%%sh\n",
+    "# Install java kernel\n",
+    "wget -q https://github.com/SpencerPark/IJava/releases/download/v1.3.0/ijava-1.3.0.zip\n",
+    "unzip -q ijava-1.3.0.zip\n",
+    "python install.py\n",
+    "\n",
+    "# Install proxy for the java kernel\n",
+    "wget -qO- https://gist.github.com/SpencerPark/e2732061ad19c1afa4a33a58cb8f18a9/archive/b6cff2bf09b6832344e576ea1e4731f0fb3df10c.tar.gz | tar xvz --strip-components=1\n",
+    "python install_ipc_proxy_kernel.py --kernel=java --implementation=ipc_proxy_kernel.py"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "----------"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

diff --git a/Notebooks/5_java_unicode_pattern_matching.ipynb b/Notebooks/5_java_unicode_pattern_matching.ipynb
@@ -1,5 +1,42 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "----------\n",
+    "\n",
+    "> **How to Run This Notebook**\n",
+    "\n",
+    "You can run this notebook in Google Colab. The cell below should be run only once, and then followed by a change of runtime to \"Java (java)\". Refresh the browser before running any subsequent code. You can also run this notebook locally if you have the IJava kernel for Jupyter installed."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#@title Prepare Google Colab for IJava Kernel\n",
+    "\n",
+    "%%sh\n",
+    "# Install java kernel\n",
+    "wget -q https://github.com/SpencerPark/IJava/releases/download/v1.3.0/ijava-1.3.0.zip\n",
+    "unzip -q ijava-1.3.0.zip\n",
+    "python install.py\n",
+    "\n",
+    "# Install proxy for the java kernel\n",
+    "wget -qO- https://gist.github.com/SpencerPark/e2732061ad19c1afa4a33a58cb8f18a9/archive/b6cff2bf09b6832344e576ea1e4731f0fb3df10c.tar.gz | tar xvz --strip-components=1\n",
+    "python install_ipc_proxy_kernel.py --kernel=java --implementation=ipc_proxy_kernel.py"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "----------"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},