qmd-progress icon indicating copy to clipboard operation
qmd-progress copied to clipboard

Documentation feedback

Open jeanlucf22 opened this issue 10 months ago • 0 comments

Here are some issues I found with the recently updated documentation

  1. There is no mention or link to documentation in README file
  2. https://github.com/lanl/qmd-progress/blob/master/docs/TUTORIALS.rst The sentence "Remember to refer to the documentation of the PROGRESS and BML libraries for further details on how to utilize their features effectively." could use a link or two. In addition, isn't the PROGRESS doc what we are reading?
  3. "Running this code will produce a 100x100 Model Hamiltonian Matrix that one can use to test any PROGRESS algorithm. The output will only show part of the matrix:" Where is the matrix saved? I am getting two 10x10 matrix in std output, h_bml and ht_bml.

jeanlucf22 avatar Aug 10 '23 18:08 jeanlucf22