Tutorial for Pydantic validation

[tomdemeyere]

Summary

Small tutorial about Pydantic validation and how it can be used with jobflow, please let me know if I should add anything else

https://github.com/materialsproject/jobflow/issues/808 @JaGeo @utf

• [x] Code is in the standard Python style. The easiest way to handle this is to run the following in the correct sequence on your local machine. Start with running black on your new code. This will automatically reformat your code to PEP8 conventions and removes most issues. Then run pycodestyle, followed by flake8.
• [x] Docstrings have been added in theNumpy docstring format. Run pydocstyle on your code.
• [x] Type annotations are highly encouraged. Run mypy to type check your code.
• [x] Tests have been added for any new functionality or bug fixes.
• [x] All linting and tests pass.

[JaGeo]

@tomdemeyere thanks! To me, this looks already great.

@utf do you have any comments?

I have two points I am wondering about: Should we move it to a different position in the overall documentation? Is maybe further introduction needed to motivate the validation?

[utf]

Thanks for this @tomdemeyere. I think it looks great. As @JaGeo said, if you can add a little more motivation to why this is useful that would be perfect.

For now, I think the position in the documentation is OK. We might need to do a more thorough adjustment later on.

[tomdemeyere]

Thank you both for the feedback, I've added some context at the beginning of the notebook

[JaGeo]

@tomdemeyere From my side, the context sounds good. You could additionally refer to atomate2 as a package where this is used

[tomdemeyere]

@JaGeo That makes sense, done!

[JaGeo]

@utf are you fine with the current status? Should we merge this?

[JaGeo]

@utf kind reminder 🙂. Workflows would beed to be approved.