search

materialsproject / jobflow

jobflow is a library for writing computational workflows.
https://materialsproject.github.io/jobflow
Other
93 stars 24 forks source link

Add documentation for how to deal with stores beyond `MemoryStore` #506

Closed Andrew-S-Rosen closed 10 months ago

Andrew-S-Rosen commented 10 months ago

Summary

This PR addresses a comment raised in https://github.com/openjournals/joss-reviews/issues/5995. We now include documentation for how to modify the Jobflow settings to use a custom data store. This was already described in the API documentation, but now a concrete example is provided in the main documentation.

One open question: There is basically the same info in a portion of the Atomate2 documentation. Do we instead just link to it to prevent duplication of content? Or is there value in having a dedicated page with Jobflow. I can see arguments for both. In any case, this PR provides an example.

codecov[bot] commented 10 months ago

Codecov Report

Merging #506 (8384d30) into main (3b7919a) will not change coverage. The diff coverage is n/a.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #506 +/- ## ======================================= Coverage 99.86% 99.86% ======================================= Files 20 20 Lines 1512 1512 Branches 415 415 ======================================= Hits 1510 1510 Misses 2 2 ```
utf commented 10 months ago

Great, thank you.