search

michael-hartmann / caps

The Casimir Effect in the plane-sphere geometry.
GNU General Public License v2.0
4 stars 1 forks source link

Doc: introduction: explain purpose #153

Closed jwuttke closed 4 years ago

jwuttke commented 4 years ago

In the beginning of the user documentation, add one sentence to explain what the Casimir effect is, and one paragraph to explain the purpose of this software.

This software does not "implement" the Casimir effect (as README.md says), nor does it "describe" the effect (as the doc says). It computes certain properties of a certain model. This should be explained in more detail.

jwuttke commented 4 years ago

<- https://github.com/openjournals/joss-reviews/issues/2011

michael-hartmann commented 4 years ago

We have addressed the issue, see #161. The introduction in the user manual is now longer and contains more information. Instead of putting a lot of references to the introduction of the user manual, we have decided to refer the reader to the JOSS paper. We will add the remark once the JOSS paper got published.