libAtoms / matscipy

Materials science with Python at the atomic-scale
http://libatoms.github.io/matscipy/
GNU Lesser General Public License v2.1
188 stars 55 forks source link

[JOSS Review] Documentation #186

Closed mbarzegary closed 10 months ago

mbarzegary commented 1 year ago

Dear authors,

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

P.S. This issue is related to https://github.com/openjournals/joss-reviews/issues/5668

pastewka commented 10 months ago

@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 commented 10 months ago

@pastewka I think I am done with the electrochemistry and CLI documentation pages on https://github.com/libAtoms/matscipy/pull/210 . Generating the docs from jupyter notebooks works very neatly!