Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better Quick Start Guide #405

Open
Andrew-S-Rosen opened this issue Jun 26, 2023 · 5 comments
Open

Better Quick Start Guide #405

Andrew-S-Rosen opened this issue Jun 26, 2023 · 5 comments

Comments

@Andrew-S-Rosen
Copy link
Member

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.

@JaGeo
Copy link
Member

JaGeo commented Jun 26, 2023

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

@Andrew-S-Rosen
Copy link
Member Author

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
Copy link
Member Author

Or use your upcoming phonon workflow ;)

@JaGeo
Copy link
Member

JaGeo commented Jun 26, 2023

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

@mjwen
Copy link
Member

mjwen commented Jun 27, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants