Skip to content

Updating usage and examples.#106

Open
ajarifi wants to merge 7 commits intomainfrom
demo
Open

Updating usage and examples.#106
ajarifi wants to merge 7 commits intomainfrom
demo

Conversation

@ajarifi
Copy link
Copy Markdown
Collaborator

@ajarifi ajarifi commented Aug 11, 2025

I edited the usage and examples by adding the infinite potential well and hydrogen-like atom in the README.md and docs/src/index.md. Probably, the example is too much for README.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.

@ajarifi ajarifi requested a review from ohno August 11, 2025 00:19
Copy link
Copy Markdown
Owner

@ohno ohno left a comment

Choose a reason for hiding this comment

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

Sorry for the late response and for throwing away your contribution. I've added some comments so please update PR.

Comment thread README.md
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Please see #88. Please do not add contents to README.md. It will be simple like https://github.com/JuliaFewBody/FewBodyHamiltonians.jl.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

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.

f
save("assets/fig/InfinitePotentialWell.png", f) # hide
; # hide
```
![](assets/fig/InfinitePotentialWell.png)

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

The comment is same as docs/src/assets/fig/H_wavefunction.png.

Comment thread docs/src/index.md
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

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.

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.

2 participants