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

📚 update docs for all parameters #238

Merged
merged 4 commits into from
Aug 21, 2022
Merged

📚 update docs for all parameters #238

merged 4 commits into from
Aug 21, 2022

Conversation

jacksund
Copy link
Owner

@scott-materials @laurenmm @becca9835

This PR will help a bunch with figuring out workflow parameters and how to use them. Once it's merged, you'll want to read through the documentation for the workflow module. (try this link after merging and it will bring you right to the relevant section).

I think there are a lot of features that I've built into the workflow yaml files that are overlooked because the documentation is difficult to find for each workflow. For example, one cool feature that I don't think anyone knows about is that you can run a workflow with a materials project structure -- without ever going to their website or even making a cif/poscar file:

workflow_name: static-energy.vasp.mit
structure:
    database_table: MatprojStructure
    database_id: mp-1234

Definitely read through the structure parameter setting once this is merged.

@jacksund jacksund merged commit 93c4e28 into main Aug 21, 2022
@jacksund jacksund deleted the add-parameter-docs branch August 21, 2022 18:55
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

Successfully merging this pull request may close these issues.

1 participant