search

ur-whitelab / hoomd-tf

A plugin that allows the use of Tensorflow in Hoomd-Blue for GPU-accelerated ML+MD
https://hoomd-tf.readthedocs.io
MIT License
30 stars 8 forks source link

[JOSS] Documentation and Readme #200

Closed RMeli closed 4 years ago

RMeli commented 4 years ago

The description on the documentation homepage is quite short (see statement of need). Since the README contains a more detailed explanation, I think using the same explanation in both the README and the documentation would be beneficial.

Listing the main (and optional) dependencies mentioned in the documentation on the README would be helpful as well.

JOSS review

RainierBarrett commented 4 years ago

PR #202 should cover this. I'm PRing these into the readthedocs branch for now so we can get that included in the version bump with everything else once that's ready to go.

RMeli commented 4 years ago

Sounds good, thanks! LGTM

RMeli commented 4 years ago

I'll close this unless @malramsay64 has anything to add.

malramsay64 commented 4 years ago

I have nothing to add LGTM