insilichem / ommprotocol

A command line application to launch molecular dynamics simulations with OpenMM
http://ommprotocol.readthedocs.io
GNU Lesser General Public License v3.0
39 stars 8 forks source link

Provide complete examples and tutorials #11

Open jaimergp opened 6 years ago

jaimergp commented 6 years ago

README.md and examples/ are not enough. We should add complete tutorials and proper documentation, as suggested by @ajasja in #9. This would be probably tackled when I start writing the manuscript for OMMProtocol, around February.

In the meantime, we can chat here and provide different systems and sources. For example, some tutorials could include:

OMMProtocol

OMMAnalyze

jaimergp commented 6 years ago

Hello! Quick report.

The OMMProtocol manuscript is now submitted. As part of that effort, I wrote some accompanying documentation that is now published on http://ommprotocol.readthedocs.io. While proper tutorials are yet to be included, there are some tips for beginners.

Hope it helps!

(Pinging @ajasja)

ajasja commented 6 years ago

Thanks, I'll give it a try in the near future. (I had/have some problems running openMM itself).

Good luck with the manuscript!

jaimergp commented 6 years ago

Thanks! And one more thing, I forgot to mention that you can find some prepackaged installers in the releases section that might be helpful.