Skip to content

[JOSS Review] Documentation #186

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

Closed
mbarzegary opened this issue Oct 16, 2023 · 2 comments
Closed

[JOSS Review] Documentation #186

mbarzegary opened this issue Oct 16, 2023 · 2 comments

Comments

@mbarzegary
Copy link

Dear authors,

The documentation of the software is nicely done, but you may consider improving it with these suggestions:

  • Some of the mentioned functionalities of the package are not documented. For example, there is no documentation for the electrochemistry. Also, some of the atomic analysis tools and all the interatomic potential features are only documented via autogenerated API docs. I think this makes it hard for beginner users to get started with the package. The application domains (except the electrochemistry, as mentioned) are well documented and described. It can be beneficial to talk a little bit about the package features in the documentation.
  • It's mentioned that the package has an interface to the FEniCS code. This functionality is supported by one example that does not run. FEniCS dependency is not documented and elaborated.

P.S. This issue is related to openjournals/joss-reviews#5668

@pastewka
Copy link
Collaborator

pastewka commented Jan 4, 2024

@jotelha Can you please add documentation on the electrochemistry module? Maybe we can turn part of the example into a documentation of the module. Please also document the FEniCS coupling there.

@jotelha
Copy link
Contributor

jotelha commented Jan 11, 2024

@pastewka I think I am done with the electrochemistry and CLI documentation pages on #210 . Generating the docs from jupyter notebooks works very neatly!

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

No branches or pull requests

3 participants