Port notebooks from qutip-notebooks

[christian512]

trafficstars

To add content to this repository, we have to port the notebooks from the qutip-notebooks repository to this one. During the port, we should modify the notebooks such that they work with QuTiP 4 and 5, and add some documentation (markdown).

To keep track of the progress, we use the following GitHub project: https://github.com/users/christian512/projects/1/

[hodgestar]

Examples left to port (01/12/2022):

• Optimal control
• HEOM (#52)
• PIQS
• A few miscellaneous tutorials (Stern-Gerlach experiment, single photon interference, ...)

[hodgestar]

The HEOM examples have been ported.

[hodgestar]

A list of notebooks to port that might make good first issues for new contributors to tackle:

• [ ] https://github.com/qutip/qutip-notebooks/blob/master/examples/photon-emission.ipynb
• [ ] https://github.com/qutip/qutip-notebooks/blob/master/examples/pulse-wise-second-order-coherence-g2.ipynb
• [ ] https://github.com/qutip/qutip-notebooks/blob/master/examples/pulse-wise-two-photon-interference.ipynb
• [x] https://github.com/qutip/qutip-notebooks/blob/master/examples/single-photon-interference-example.ipynb
• [ ] https://github.com/qutip/qutip-notebooks/blob/master/examples/temporal-photon-scattering.ipynb
• [ ] https://github.com/qutip/qutip-notebooks/blob/master/examples/tomography-iMLE-photon-counting.ipynb

[rochisha0]

@hodgestar I would like to port the first notebook on the list. Can you explain what kind of documentation is required for this notebook.

[nwlambert]

I think @hodgestar said he would write up some quick guidelines for level of documentation needed for tutorials asap. I would say that particular example has a reasonable level of documentation already, so main tasks would be to check it is easy to follow, make it fit the template.md format in the tutorial subfolders, make sure that it complies to to the code formatting described in the readme.md, and make sure the v4 and v5 variants work on their respective qutip versions.