Merge pull request #152 from ChihweiLHBird/dev

Update Documents, Adding Google Colab Badge, Adding `check_source`

README.md

@@ -16,9 +16,14 @@
 [The conference paper](https://github.com/cyrus-/papers/raw/master/sciunit-icse14/sciunit-icse14.pdf)
 
 ## Documentation
+[![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ChihweiLHBird/sciunit/blob/dev/docs/chapter1.ipynb) <br>
 [Chapter 1](https://github.com/scidash/sciunit/blob/master/docs/chapter1.ipynb) /
 [Chapter 2](https://github.com/scidash/sciunit/blob/master/docs/chapter2.ipynb) /
 [Chapter 3](https://github.com/scidash/sciunit/blob/master/docs/chapter3.ipynb) /
+[Chapter 4](https://github.com/ChihweiLHBird/sciunit/blob/dev/docs/chapter4.ipynb) /
+[Chapter 5](https://github.com/ChihweiLHBird/sciunit/blob/dev/docs/chapter5.ipynb) /
+[Chapter 6](https://github.com/ChihweiLHBird/sciunit/blob/dev/docs/chapter6.ipynb) /
+
 
 ## Basic Usage
 ```python

docs/chapter1.ipynb

@@ -6,16 +6,47 @@
    "source": [
     "![SciUnit Logo](https://raw.githubusercontent.com/scidash/assets/master/logos/sciunit.png)\n",
     "\n",
-    "# SciUnit is a framework for validating scientific models by creating experimental-data-driven unit tests.  \n",
+    "# SciUnit is a framework for validating scientific models by creating experimental-data-driven unit tests. \n",
+    "\n",
+    "<a href=\"https://colab.research.google.com/github/ChihweiLHBird/sciunit/blob/dev/docs/chapter1.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
     "\n",
     "# Chapter 1. What is SciUnit?\n",
     "Everyone hopes that their model has some correspondence with reality.  Usually, checking whether this is true is done informally.\n",
     "### SciUnit makes this formal and transparent.  "
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### If you are using this file in Google Colab, this block of code can help you install sciunit from PyPI in Colab environment."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "try:\n",
+    "    import google.colab\n",
+    "    IN_COLAB = True\n",
+    "except:\n",
+    "    IN_COLAB = False\n",
+    "if IN_COLAB:\n",
+    "    !pip install -q sciunit"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "After installation, let's begin with importing sciunit."
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -122,9 +153,7 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {
-    "collapsed": true
-   },
+   "metadata": {},
    "source": [
     "### All of our tests can be organized into a suite to compare results across related tests.  "
    ]
@@ -207,9 +236,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.6"
+   "version": "3.8.3"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 1
-}
+ "nbformat_minor": 4
+}