Workflow: Draft spec

[liamhuber]

So the purpose of this is twofold: First, we talked quite a while ago about adding README.md files to different contrib sub-modules -- since the submodules are all so different compared to in other pyiron repos -- to see if they get nicely rendered by GitHub; Second, as a place to discuss overall code structure and start defining some interfaces/expectations/promises, even before they're implemented!

@samwaseda, let me know what you think about the content, but also the idea of using this space for these sorts of discussions/definitions, at least while we're devving. Note that the actual list of classes is really only a temporary feature since a bunch of them aren't defined -- ultimately we can replace that with an automatically generated UML diagram and some light commentary where needed.

[github-actions]

👈 Launch a binder notebook on branch pyiron/pyiron_contrib/add_workflow_readme

[liamhuber]

Ok, rad GitHub does render it nicely!

[github-actions]

Pull Request Test Coverage Report for Build 5425212174

• 0 of 0 changed or added relevant lines in 0 files are covered.
• 7 unchanged lines in 1 file lost coverage.
• Overall coverage decreased (-0.006%) to 12.397%

---

Files with Coverage Reduction	New Missed Lines	%
pyiron_contrib/tinybase/executor.py	7	0%

Totals
Change from base Build 5391084330:	-0.006%
Covered Lines:	1754
Relevant Lines:	14149

---

💛 - Coveralls

[liamhuber]

In the process of making this document and playing in #729 and #745, I realized that there are times that we want to assume that HasNodes has a label and so forth, and that Macro and Workflow will probably share implementations of required Node (formerly/presently IsNodal) methods.... so it makes a lot more sense to interject a common ancestor -- which I call Composite here -- instead of using a mix-in strategy with HasNodes.