[Documentation] Explain the differences between the TestClusterExecutor and the SlurmClusterExecutor and the FluxClusterExecutor
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77
- Forks
- 7
- Avg merge
- 10h 32m
- Merged PRs (30d)
- 12
Description
For the TestClusterExecutor this is the case, because the subprocess interface does not provide any dependency management. It waits until all dependent tasks are completed before the next step is submitted:
https://github.com/pyiron/executorlib/blob/main/src/executorlib/task_scheduler/file/spawner_subprocess.py#L49
In contrast to this the FluxClusterExecutor and the SlurmClusterExecutor use the job scheduler for dependency management, so for those there is no need to wait:
https://github.com/pyiron/executorlib/blob/main/src/executorlib/task_scheduler/file/spawner_pysqa.py#L70
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked spawner_subprocess.py and spawner_pysqa.py sections to verify how dependency handling differs between TestClusterExecutor and the scheduler-backed executors. Add documentation that clearly explains when dependent tasks are waited on versus delegated to the scheduler, and ensure it covers TestClusterExecutor, SlurmClusterExecutor, and FluxClusterExecutor.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, hpc
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100