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

Write a detailed README file #79

Closed
albertomercurio opened this issue Apr 24, 2024 · 4 comments
Closed

Write a detailed README file #79

albertomercurio opened this issue Apr 24, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@albertomercurio
Copy link
Member

I think that a detailed README file is needed.

The file should explain the potentialities of this package

  • Syntax very close to the QuTiP one
  • Very fast simulations thanks to Julia
  • Easy to extend
  • Support for GPUs
  • Support for Distributed computing

And making also some examples such as

  • The master equation in CPU (showing the similarities to QuTiP) and in the GPU (showing how easy is to perform fast simulations)
  • The Distributed computing of quantum trajectories
@albertomercurio albertomercurio added the documentation Improvements or additions to documentation label Apr 24, 2024
@ytdHuang
Copy link
Member

ytdHuang commented Apr 24, 2024

Sure, I think we can do this after moving to QuTiP org. ?
Since we also need to change the links of the badges for runtests, codecov, and documentation after that.

@ytdHuang
Copy link
Member

ytdHuang commented Apr 25, 2024

Maybe we can follow the similar structure of README.md in QuTiP

Including the following sections:

  • Title (QuantumToolbox.jl) with all the badges underneath
  • introduction of the package
  • Support (add it in the future if we got one lol)
  • Installation
  • Documentation
  • Citing QuantumToolbox.jl: zenodo link and doi (maybe published paper's bibTex and doi in the future if we have one)

@ytdHuang
Copy link
Member

@albertomercurio
Should we close this one ?

@albertomercurio
Copy link
Member Author

Yes

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

No branches or pull requests

2 participants