Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Port notebooks from qutip-notebooks #18

Open
christian512 opened this issue Jun 22, 2022 · 5 comments
Open

Port notebooks from qutip-notebooks #18

christian512 opened this issue Jun 22, 2022 · 5 comments

Comments

@christian512
Copy link
Collaborator

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 hodgestar changed the title Port notebooks from qutip-tutorials Port notebooks from qutip-notebooks Jun 22, 2022
@hodgestar
Copy link
Contributor

hodgestar commented Dec 1, 2022

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

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

@hodgestar
Copy link
Contributor

The HEOM examples have been ported.

@rochisha0
Copy link
Contributor

@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
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants