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

QuTiPv5 Paper Notebook: smesolve #110

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

Langhaarzombie
Copy link
Contributor

@Langhaarzombie Langhaarzombie commented Nov 8, 2024

Adds an example notebook for the smesolve solver mentioned in the paper for QuTiPv5.

A far as I can tell, there is only thing left to do:

  • Add tests for the notebook (it's not yet clear what exactely to test)
  • Include references and format like this

- Added code used in the paper
- Wrote a first draft of instructions
Copy link
Member

@nwlambert nwlambert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks, basically looks great, left a few small comments

tutorials-v5/time-evolution/022_v5_paper-smesolve.md Outdated Show resolved Hide resolved
tutorials-v5/time-evolution/022_v5_paper-smesolve.md Outdated Show resolved Hide resolved
Copy link
Member

@pmenczel pmenczel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, Max! Two more general comments (that maybe you have talked about already, sorry):

  • I was wondering if these paper examples should go into a separate folder? But the whole structure of the tutorial notebooks could use a bit of a revision...
  • Should we wait with merging these PRs until after publication of the paper? I wonder if the journal will make us trouble if the material is "already published". On the other hand, after the paper publication, could there be copyright issues?

tutorials-v5/time-evolution/022_v5_paper-smesolve.md Outdated Show resolved Hide resolved
tutorials-v5/time-evolution/022_v5_paper-smesolve.md Outdated Show resolved Hide resolved
@nwlambert
Copy link
Member

Thank you, Max! Two more general comments (that maybe you have talked about already, sorry):

  • I was wondering if these paper examples should go into a separate folder? But the whole structure of the tutorial notebooks could use a bit of a revision...

yeah we went back and forth on this a bit a few weeks ago. we ended up with this convention of highlighting in their names that they come from the paper, but putting them in the subfolder most associated with their application, e.g., time evolution, qip etc, and then revisiting the whole folder structure later (mostly motived by this qutip.org tutorials page structure problem, which needs some improvement)

  • Should we wait with merging these PRs until after publication of the paper? I wonder if the journal will make us trouble if the material is "already published". On the other hand, after the paper publication, could there be copyright issues?

hmm fair point. also relates to what we do with the original python files, and where/how we store those. i am not really sure.

Copy link
Member

@pmenczel pmenczel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good from my side (however, let's wait with merging)

@Langhaarzombie Langhaarzombie marked this pull request as ready for review December 3, 2024 02:34
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

Successfully merging this pull request may close these issues.

3 participants