Add Colab badge

waltsims · Nov 5, 2023 · d530483 · d530483
1 parent b36a4fa
commit d530483
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/examples/example_na_controlling_the_pml/README.md b/examples/example_na_controlling_the_pml/README.md
@@ -1,5 +1,9 @@
 # Using An Ultrasound Transducer As A Sensor Example
 
+<a target="_blank" href="https://colab.research.google.com/github/waltsims/k-wave-python/blob/master/examples/example_na_controlling_the_pml/example_na_controlling_the_pml.ipynb">
+  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
+</a>
+
 # Running the example
 
 Please have a look at the `example_na_controlling_the_pml.ipynb` notebook file to see the example in action.

diff --git a/examples/example_na_controlling_the_pml/example_na_controlling_the_pml.ipynb b/examples/example_na_controlling_the_pml/example_na_controlling_the_pml.ipynb
@@ -18,6 +18,16 @@
     "The example is based on the original kWave example in Matlab. A few parts were adapted to make it compatible with `k-wave-python`."
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Install k-wave-python if not installed yet (e.g. running in Google Colab)\n",
+    "#!pip install git+https://github.com/waltsims/k-wave-python"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,