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

Add documentation: Flows, FireWorks, Dynamic Flows, Makers #338

Merged
merged 22 commits into from
Jun 8, 2023

Conversation

Andrew-S-Rosen
Copy link
Member

@Andrew-S-Rosen Andrew-S-Rosen commented Jun 8, 2023

Closes #90. Also closes materialsproject/atomate2#278.

This PR adds important details on how to set up and use FireWorks with Jobflow, including how to launch jobs with different queuing options, as requested by @JaGeo. I also added the other missing tutorial notebooks for flows and dynamic flows.

@codecov
Copy link

codecov bot commented Jun 8, 2023

Codecov Report

Merging #338 (44d70b7) into main (7e62e93) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #338   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           19        19           
  Lines         1429      1429           
  Branches       361       361           
=========================================
  Hits          1429      1429           

@Andrew-S-Rosen Andrew-S-Rosen changed the title [WIP] Add FireWorks documentation Add FireWorks documentation Jun 8, 2023
@Andrew-S-Rosen Andrew-S-Rosen changed the title Add FireWorks documentation Add documentation: Flows, FireWorks Jun 8, 2023
@Andrew-S-Rosen Andrew-S-Rosen changed the title Add documentation: Flows, FireWorks Add documentation: Flows, FireWorks, Dynamic Flows Jun 8, 2023
@Andrew-S-Rosen Andrew-S-Rosen changed the title Add documentation: Flows, FireWorks, Dynamic Flows [WIP] Add documentation: Flows, FireWorks, Dynamic Flows Jun 8, 2023
@JaGeo
Copy link
Member

JaGeo commented Jun 8, 2023

@arosen93, thank you so much! 😀 🎉 I think this will benefit a lot of users! I will then also try to link to this part of the tutorial from the documentation on the Lobster runs in atomate2!

@Andrew-S-Rosen Andrew-S-Rosen changed the title [WIP] Add documentation: Flows, FireWorks, Dynamic Flows [WIP] Add documentation: Flows, FireWorks, Dynamic Flows, Makers Jun 8, 2023
@Andrew-S-Rosen
Copy link
Member Author

@utf, this is ready to go!

@Andrew-S-Rosen Andrew-S-Rosen changed the title [WIP] Add documentation: Flows, FireWorks, Dynamic Flows, Makers Add documentation: Flows, FireWorks, Dynamic Flows, Makers Jun 8, 2023
@utf
Copy link
Member

utf commented Jun 8, 2023

This is awesome! Thank you so much.

@utf utf merged commit 616c1a7 into materialsproject:main Jun 8, 2023
@Andrew-S-Rosen Andrew-S-Rosen deleted the docs branch June 8, 2023 07:33
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.

Documentation (fireworks) Documentation: Dynamic workflows, FireWorks, Makers, and Updating Metadata
3 participants