Spec and test

[liamhuber]

Update the documentation and testing.

• Channel
• IO
• Node
• Function
• Composite
• Macro
• Workflow
• __init__
• Make a quickstart.ipynb
• Update the current example to re-phrase it as a deep-dive (or maybe just remove it?)
• Update the github README

Closes #61
Closes #62

[github-actions]

👈 Launch a binder notebook on branch pyiron/pyiron_workflow/spec_and_test

[github-actions]

Pull Request Test Coverage Report for Build 6832421987

• 78 of 78 (100.0%) changed or added relevant lines in 5 files are covered.
• 99 unchanged lines in 7 files lost coverage.
• Overall coverage increased (+0.4%) to 88.019%

---

Files with Coverage Reduction	New Missed Lines	%
workflow.py	3	82.93%
macro.py	5	89.83%
function.py	11	92.44%
channels.py	13	92.23%
io.py	13	90.08%
node.py	23	89.17%
composite.py	31	88.06%

Totals
Change from base Build 6774228126:	0.4%
Covered Lines:	3328
Relevant Lines:	3781

---

💛 - Coveralls

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.55% (target: -1.00%)	81.11%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (3732bf8)	1893	1542	81.46%
Head commit (4ec4d72)	1906 (+13)	1563 (+21)	82.00% (+0.55%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#70)	90	73	81.11%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

[liamhuber]

The notebooks failure is actually the same problem that is causing the pyiron_atomistics daily tests to fail:

File /usr/share/miniconda3/envs/my-env/lib/python3.11/site-packages/emmet/core/tasks.py:10
      8 from typing import Any, Dict, List, Optional, Tuple, Type, TypeVar, Union
---> 10 from custodian.vasp.jobs import VaspJob
     11 import numpy as np

ModuleNotFoundError: No module named 'custodian'

My knee-jerk suspicion is that materials project has again inserted a direct dependency into their code without including that dependency directly and the API has gotten out of sync with what conda is actually installing, although just because that happened before doesn't mean it's for sure what's happening now.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB