nomad-coe/nomad

Improve documentation for "how to run a parse"

Opened this issue · 0 comments

nakib commented

I'm requesting improvement of the doc at http://nomad-lab.eu/prod/v1/staging/docs/apis/local_parsers.html

Details:

  1. The concept of a parser might not be familiar to the user, so a link to the doc describing it would help.
  2. A lot of the doc is about handling potential troubleshooting related to installing a dependency. This could be handled in a separate doc and be linked from here.
  3. Add a link to the normalization doc.
  4. Explain under what circumstances can the normalization step may be skipped?
  5. The python code should explain that the normalization step may be commented out for the case when normalization is not required.