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

[JOSS Review] @obliviateandsurrender Some Issues and Suggestions #31

Closed
7 tasks done
obliviateandsurrender opened this issue Sep 25, 2021 · 1 comment
Closed
7 tasks done

Comments

@obliviateandsurrender
Copy link

obliviateandsurrender commented Sep 25, 2021

Dear authors,

Thank you for your work. Most of it looks good to me, but it would be great if you could address the following suggestions and points as part of the JOSS submission Review Process.

  1. JOSS Paper

    • Add a reference for tensor networks and explain how it works.
    • Mention how it is better or different from other packages (if any) that supposedly intend to quantum circuit simulations in a similar fashion either in Julia or other languages.
    • Mention if there are any limitations of this package.
  2. Repository

    • There definitely needs to be some tutorials (or documentation) for the following things:
      i. Explaining details of the workflow step by step as already mentioned in Add tutorial notebook which demonstrates basic workflow #5.
      ii. Provide the performance benchmarks for the package (see the point below).

    • While looking at the repository and the documentation, I could not see any particular examples or relevant results for the following statement.

      To reduce the turnaround time and allow larger systems to be simulated, it is necessary to move beyond single workstations and use distributed compute clusters.

      While it being obvious, it would be beneficial if some useful examples (or even better if some tutorials) could be added to showcase how this package reduces simulation time.

    • Add the link of the documentation explicitly in the README. It might not be evident to the user to access it via badge.

    • [Suggestion] I had a look at the contributing guidelines and the pull request template, and they look good! However, I would suggest you have a template for Issues as well, making the user's task a bit easier to request new features or report any bugs.

Remember that all issues are open to discussion, and additional considerations are welcome!

@nmoran
Copy link
Member

nmoran commented Jan 17, 2022

Thanks for the review, we believe we have addressed all the issues raised.

@nmoran nmoran closed this as completed Jan 17, 2022
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

2 participants