Neighbor list concepts page

glotzerlab / hoomd-blue

Molecular dynamics and Monte Carlo soft matter simulation on GPUs.

http://glotzerlab.engin.umich.edu/hoomd-blue

BSD 3-Clause "New" or "Revised" License

329 stars 127 forks source link

Neighbor list concepts page #141

Closed joaander closed 8 years ago

joaander commented 8 years ago

Original report by Michael Howard (Bitbucket: mphoward, GitHub: mphoward).

The different neighbor list styles need to be well-documented with a concepts page illustrating graphically what the difference is between them, and clearly identifying advantages and disadvantages of each. The neighbor list paper (http://dx.doi.org/10.1016/j.cpc.2016.02.003) should also be added to the citation page and to the automatic citation generation module. I can take care of this.

joaander commented 8 years ago

OK, thanks. I'm currently converting from doxygen to sphinx. Should have something workable soon.

joaander commented 8 years ago

Original comment by Michael Howard (Bitbucket: mphoward, GitHub: mphoward).

Sure, no rush -- I will wait for the updated docs before starting anything.

joaander commented 8 years ago

Merged in mphoward/hoomd-blue/improve_nlist_docs (pull request #176)

fixes #141

Improve the neighbor list documentation