atomate2 icon indicating copy to clipboard operation
atomate2 copied to clipboard

Better Quick Start Guide

Open Andrew-S-Rosen opened this issue 2 years ago • 5 comments

I think we should strive to have a better quick start guide in the docs. Not using VASP. Something that can be run on the local machine and get you up and running in as quickly as possible just as a proof-of-concept.

Andrew-S-Rosen avatar Jun 26 '23 16:06 Andrew-S-Rosen

I agree that an example with the forcefields would be cool. However, an optimization only might not yet be a workflow.

JaGeo avatar Jun 26 '23 17:06 JaGeo

Many people will want to run a single job, so a one-step workflow is okay for a quick start! Want to make it a workflow? Do an optimization with M3GNet and take the output into CHGNet to see how much they differ. Now you have a workflow!

Andrew-S-Rosen avatar Jun 26 '23 17:06 Andrew-S-Rosen

Or use your upcoming phonon workflow ;)

Andrew-S-Rosen avatar Jun 26 '23 17:06 Andrew-S-Rosen

This should probably motivate us to be faster with the phonon workflow or others to provide other workflows including the forcefields. ;)

JaGeo avatar Jun 26 '23 17:06 JaGeo

Related to lowing the entry barrier: I think it should also be helpful to use an on-disk DB like MontyDB in maggma in the Installation section of the doc. Figuring out how to set up MongoDB, e.g., on Atlas is nontrivial for many.

Of course, we can move the MongoDB stuff to another tutorial named Production Environment and such.

mjwen avatar Jun 27 '23 18:06 mjwen