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.

Sign up for GitHub

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

Jump to bottom

Documentation and help #8

Open

jaakkojulin opened this issue Apr 13, 2022 · 0 comments

Labels

Member

jaakkojulin commented Apr 13, 2022

Documentation is needed

Built-in interactive help, especially usage hints should be checked, expanded and improved
The code needs better commenting (Doxygen) and documentation generated by these comments
Physics models need to be explained. A manuscript is under preparation, but an additional continuously updated document is needed
More examples, along with explanations, should be produced

jaakkojulin added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment