Write a detailed `README` file
Closed this issue · 4 comments
albertomercurio commented
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
ytdHuang commented
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 commented
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 commented
@albertomercurio
Should we close this one ?
albertomercurio commented
Yes