adding tutorial

a-renzini · May 22, 2024 · ae7b174 · ae7b174
1 parent 770f540
commit ae7b174
Show file tree

Hide file tree

Showing 3 changed files with 534 additions and 0 deletions.
diff --git a/docs/basic_tutorial.ipynb b/docs/basic_tutorial.ipynb
diff --git a/docs/demos.rst b/docs/demos.rst
@@ -0,0 +1,18 @@
+=====
+Demos
+=====
+
+.. raw:: html
+
+   <a href="run_pe.html"><button style="background-color:#307FC1;color:white;border-color:#307FC1;width: 330.0px; height: 50.0px;border-radius: 8px;margin-bottom: 10px;margin-left: 10px">Learn how to calculate :math:`\Omega_{\rm GW}` with popstock</button></a>
+
+   <br />
+
+.. currentmodule:: popstock
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   basic_tutorial
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,6 +14,7 @@ popstock documentation
 
    <a href="about.html"><button style="background-color:#307FC1;border-color:#307FC1;color:white;width: 200.0px; height: 100.0px;border-radius: 8px;margin-bottom: 10px;margin-left: 10px">More about popstock</button></a>
    <a href="installation.html"><button style="background-color:#307FC1;color:white;border-color:#307FC1;width: 200.0px; height: 100.0px;border-radius: 8px;margin-bottom: 10px;margin-left: 10px">Installing popstock</button></a>
+    <a href="api.html"><button style="background-color:#307FC1;color:white;border-color:#307FC1;width: 200.0px; height: 100.0px;border-radius: 8px;margin-bottom: 10px;margin-left: 10px">Demos</button></a>
     <a href="api.html"><button style="background-color:#307FC1;color:white;border-color:#307FC1;width: 200.0px; height: 100.0px;border-radius: 8px;margin-bottom: 10px;margin-left: 10px">Module API</button></a>
    <a href="citing.html"><button style="background-color:#307FC1;color:white;border-color:#307FC1;width: 200.0px; height: 100.0px;border-radius: 8px;margin-bottom: 10px;margin-left: 10px">Citing popstock</button></a>
    <a href="contributing.html"><button style="background-color:#307FC1;color:white;border-color:#307FC1;width: 200.0px; height: 100.0px;border-radius: 8px;margin-bottom: 10px;margin-left: 10px">Contributing to popstock</button></a>
@@ -24,6 +25,7 @@ popstock documentation
 
    about
    installation
+   demos
    api
    citing
    contributing