Organize QuTiP tutorials in a notebook index

qutip / qutip-notebooks

A collection of IPython notebooks using QuTiP: examples, tutorials, development test, etc.

BSD 3-Clause "New" or "Revised" License

238 stars 236 forks source link

Organize QuTiP tutorials in a notebook index #105

Closed IvanIsCoding closed 4 years ago

IvanIsCoding commented 4 years ago

Fixes #98

Adds a notebook index in the style of http://qutip.org/tutorials.html to organize the examples and make them easy to follow. The main Binder link also leads to the index after this change.

The issue asked for numbering to organize, but there was not a consensus on numbering as the best solution. Having an index is a solution in between because we keep the filenames as they are and add the order of the tutorial page.

review-notebook-app[bot] commented 4 years ago

Check out this pull request on

You'll be able to see Jupyter notebook diff and discuss changes. Powered by ReviewNB.

nathanshammah commented 4 years ago

I like it. Would like more feedback from @ajgpitch @quantshah or others. A possibile maintainance issue to me seems that people would add ipynb to the website but need also to update the index.ipynb file. How to remind them of that? Add something in the contribution guidelines? Do we have any for the notebooks?

quantshah commented 4 years ago

I agree with @nathanshammah on having a uniform minimal set of guidelines for writing notebooks (such as having qutip.about(), adding the index and documentation links on the website)

nathanshammah commented 4 years ago

Ok, so, the guidelines could go in another notebook or in readme named CONTRIBUTING.md.

I am happy to merge this as is. I recently noticed this nice index notebook in PoliAstro (cc @astrojuanlu) and I propose two changes:

(1) First, that the My Binder link behind the badge in the README in this repo and in qutip/qutip, points to the index notebook directly.
(2) Second, optionally, that images are added for each notebook. This is much longer to do and could be done in another PR. This may still be easier to implement than a complete Sphinx Gallery overhaul. I will open an Issue.

Do you think you can address (1), @IvanIsCoding? It would help visitors not get lost when they open My Binder.

IvanIsCoding commented 4 years ago

I will add the CONTRIBUTING.md with the guidelines in this PR then. Also, this PR links the Binder badge in qutip-notebooks to the index.ipynb, so only a change in qutip/qutip is necessary.

nathanshammah commented 4 years ago

Wonderful, thanks @ivaniscoding.