Conversation
ohno
left a comment
There was a problem hiding this comment.
Sorry for the late response and for throwing away your contribution. I've added some comments so please update PR.
There was a problem hiding this comment.
Please see #88. Please do not add contents to README.md. It will be simple like https://github.com/JuliaFewBody/FewBodyHamiltonians.jl.
There was a problem hiding this comment.
Please do not commit image files. The following usage is sufficient for use in documentation. Images are generated automatically by GitHub Actions and Documenter.jl; there's no need to include them in your source code.
Antique.jl/docs/src/InfinitePotentialWell.md
Lines 74 to 75 in 19a245c
Antique.jl/docs/src/InfinitePotentialWell.md
Lines 99 to 104 in 19a245c
There was a problem hiding this comment.
The comment is same as docs/src/assets/fig/H_wavefunction.png.
There was a problem hiding this comment.
This is too much to solve #100. It would be enough if the usage of E, V, and ψ were covered as pointed out in the issue. Either a harmonic oscillator or a hydrogen atom would be enough. Please keep your contribution to the Greek Letters and Symbols table for this version.
I edited the usage and examples by adding the
infinite potential wellandhydrogen-likeatom in theREADME.mdanddocs/src/index.md. Probably, the example is too much forREADME.md.I also created a table of symbols and Greek letters, which may be useful for the current version.
Two plots for wave functions are also uploaded.