Add option to generate Try QuTiP URLs.

Author: hodgestar

website/create_index.py

@@ -4,6 +4,7 @@
 import os
 import pathlib
 import re
+import urllib.parse
 
 from jinja2 import (
     Environment,
@@ -36,16 +37,25 @@ class Notebook:
     """ Notebook object for use in rendering templates. """
 
     NBVIEWER_URL_PREFIX = "https://nbviewer.org/urls/qutip.org/qutip-tutorials/"
+    TRY_QUTIP_URL_PREFIX = "https://qutip.org/try-qutip/lab/index.html?"
 
-    def __init__(self, path, title):
-        tutorial_folder = path.parent.parent
-        web_folder = tutorial_folder.parent
+    def __init__(self, title, tutorial_folder, path):
+        self.tutorial_folder = tutorial_folder
+        self.web_folder = tutorial_folder.parent
 
-        self.web_md_path = path.relative_to(web_folder)
-        self.web_ipynb_path = self.web_md_path.with_suffix(".ipynb")
         self.title = title
 
-        self.url = self.NBVIEWER_URL_PREFIX + self.web_ipynb_path.as_posix()
+        self.web_md_path = path.relative_to(self.web_folder)
+        self.web_ipynb_path = self.web_md_path.with_suffix(".ipynb")
+
+        self.tutorial_md_path = path.relative_to(self.tutorial_folder)
+        self.tutorial_ipynb_path = self.tutorial_md_path.with_suffix(".ipynb")
+
+        self.nbviewer_url = self.NBVIEWER_URL_PREFIX + self.web_ipynb_path.as_posix()
+        self.try_qutip_url = (
+            self.TRY_QUTIP_URL_PREFIX +
+            urllib.parse.urlencode({"path": "tutorials/" + self.tutorial_ipynb_path.as_posix()})
+        )
 
 
 def get_title(path):
@@ -82,7 +92,10 @@ def get_notebooks(tutorials_folder, subfolder):
     files = list((tutorials_folder / subfolder).glob("*.md"))
     titles = [get_title(f) for f in files]
     files_sorted, titles_sorted = sort_files_titles(files, titles)
-    notebooks = [Notebook(f, t) for f, t in zip(files_sorted, titles_sorted)]
+    notebooks = [
+        Notebook(title, tutorials_folder, path)
+        for title, path in zip(titles_sorted, files_sorted)
+    ]
     return notebooks
 
 
@@ -106,18 +119,28 @@ def render_template(template_path, **kw):
 
 def parse_args():
     parser = argparse.ArgumentParser(
-        description="Generate indexes for tutorial notebooks.",
-    )
-    parser.add_argument(
-        "index_type", choices=["html", "notebook"],
-        metavar="INDEX_TYPE",
-        help="Whether to generate an HTML or Markdown Jupyter notebook index [html, notebook].",
+        description="""
+            Generate indexes for tutorial notebooks.
+
+            This script is used both by this repository to generate the indexes
+            for the QuTiP tutorial website and by https://github.com/qutip/try-qutip/
+            to generate the notebook indexes for the Try QuTiP site.
+        """,
     )
     parser.add_argument(
         "qutip_version", choices=["v4", "v5"],
         metavar="QUTIP_VERSION",
         help="Which QuTiP version to generate the tutorial index for [v4, v5].",
     )
+    parser.add_argument(
+        "index_type", choices=["html", "try-qutip"],
+        metavar="INDEX_TYPE",
+        help=(
+            "Whether to generate an HTML index for the website or"
+            " a Markdown Jupyter notebook index for the Try QuTiP site"
+            " [html, try-qutip]."
+        ),
+    )
     parser.add_argument(
         "output_file",
         metavar="OUTPUT_FILE",
@@ -160,8 +183,8 @@ def main():
             version_note=version_note,
             tutorials=tutorials,
         )
-    elif args.index_type == "notebook":
-        template = root_folder / "website" / "index.notebook.jinja"
+    elif args.index_type == "try-qutip":
+        template = root_folder / "website" / "index.try-qutip.jinja"
         text = render_template(
             template,
             title=title,

website/index.html.jinja

@@ -68,7 +68,7 @@ useful to have a look at these IPython notebook
 <h4 id="python-introduction">Python Introduction</h4>
 <ul>
 {% for item in tutorials['python-introduction'] %}
-    <li><a href="{{ item.url }}">{{ item.title }}</a></li>
+    <li><a href="{{ item.nbviewer_url }}">{{ item.title }}</a></li>
 {% endfor %}
 </ul>
 <p>For a more in depth discussion see: <a href="https://github.com/jrjohansson/scientific-python-lectures">Lectures on scientific computing with Python</a>.</p>
@@ -77,7 +77,7 @@ useful to have a look at these IPython notebook
 <h4 id="visualizations">Visualization</h4>
 <ul>
 {% for item in tutorials['visualization'] %}
-    <li><a href="{{ item.url }}">{{ item.title }}</a></li>
+    <li><a href="{{ item.nbviewer_url }}">{{ item.title }}</a></li>
 {% endfor %}
 </ul>
 
@@ -87,14 +87,14 @@ useful to have a look at these IPython notebook
 <h5 id="qip-circuits">Quantum circuits and algorithms</h5>
 <ul>
 {% for item in tutorials['quantum-circuits'] %}
-    <li><a href="{{ item.url }}">{{ item.title }}</a></li>
+    <li><a href="{{ item.nbviewer_url }}">{{ item.title }}</a></li>
 {% endfor %}
 </ul>
 
 <h5 id="qip-pulse-level">Pulse-level circuit simulation</h5>
 <ul>
 {% for item in tutorials['pulse-level-circuit-simulation'] %}
-    <li><a href="{{ item.url }}">{{ item.title }}</a></li>
+    <li><a href="{{ item.nbviewer_url }}">{{ item.title }}</a></li>
 {% endfor %}
 </ul>
 
@@ -105,7 +105,7 @@ useful to have a look at these IPython notebook
 <h4 id="time-evolution">Time evolution</h4>
 <ul>
 {% for item in tutorials['time-evolution'] %}
-    <li><a href="{{ item.url }}">{{ item.title }}</a></li>
+    <li><a href="{{ item.nbviewer_url }}">{{ item.title }}</a></li>
 {% endfor %}
 </ul>
 
@@ -145,14 +145,14 @@ useful to have a look at these IPython notebook
 <h4 id="heom">Hierarchical Equations of Motion</h4>
 <ul>
 {% for item in tutorials['heom'] %}
-    <li><a href="{{ item.url }}">{{ item.title }}</a></li>
+    <li><a href="{{ item.nbviewer_url }}">{{ item.title }}</a></li>
 {% endfor %}
 </ul>
 
 <h4 id="miscellaneous">Miscellaneous tutorials</h4>
 <ul>
 {% for item in tutorials['miscellaneous'] %}
-    <li><a href="{{ item.url }}">{{ item.title }}</a></li>
+    <li><a href="{{ item.nbviewer_url }}">{{ item.title }}</a></li>
 {% endfor %}
 </ul>
 
@@ -168,7 +168,7 @@ topics and analyze them numerically using QuTiP (some more detailed than others)
 
 <ul>
 {% for item in tutorials['lectures'] %}
-    <li><a href="{{ item.url }}">{{ item.title }}</a></li>
+    <li><a href="{{ item.nbviewer_url }}">{{ item.title }}</a></li>
 {% endfor %}
 </ul>
 

website/index.notebook.jinja website/index.try-qutip.jinjawebsite/index.notebook.jinja renamed to website/index.try-qutip.jinja

@@ -18,14 +18,14 @@ jupyter:
 ## Python Introduction
 
 {% for item in tutorials['python-introduction'] %}
-    - [{{ item.title }}]({{ item.url }})
+    - [{{ item.title }}]({{ item.try_qutip_url }})
 {% endfor %}
 
 
 ## Visualization
 
 {% for item in tutorials['visualization'] %}
-    - [{{ item.title }}]({{ item.url }})
+    - [{{ item.title }}]({{ item.try_qutip_url }})
 {% endfor %}
 
 
@@ -36,34 +36,34 @@ This section requires an additional package [qutip-qip](https://github.com/qutip
 ### Quantum circuits and algorithms
 
 {% for item in tutorials['quantum-circuits'] %}
-    - [{{ item.title }}]({{ item.url }})
+    - [{{ item.title }}]({{ item.try_qutip_url }})
 {% endfor %}
 
 ### Pulse-level circuit simulation
 
 {% for item in tutorials['pulse-level-circuit-simulation'] %}
-    - [{{ item.title }}]({{ item.url }})
+    - [{{ item.title }}]({{ item.try_qutip_url }})
 {% endfor %}
 
 
 ## Time evolution
 
 {% for item in tutorials['time-evolution'] %}
-    - [{{ item.title }}]({{ item.url }})
+    - [{{ item.title }}]({{ item.try_qutip_url }})
 {% endfor %}
 
 
 ## Hierarchical Equations of Motion
 
 {% for item in tutorials['heom'] %}
-    - [{{ item.title }}]({{ item.url }})
+    - [{{ item.title }}]({{ item.try_qutip_url }})
 {% endfor %}
 
 
 ## Miscellaneous tutorials
 
 {% for item in tutorials['miscellaneous'] %}
-    - [{{ item.title }}]({{ item.url }})
+    - [{{ item.title }}]({{ item.try_qutip_url }})
 {% endfor %}
 
 
@@ -73,7 +73,7 @@ These lecture-style notebooks focus on particular quantum mechanics
 topics and analyze them numerically using QuTiP (some more detailed than others).
 
 {% for item in tutorials['lectures'] %}
-    - [{{ item.title }}]({{ item.url }})
+    - [{{ item.title }}]({{ item.try_qutip_url }})
 {% endfor %}