Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

cstar.execution.scheduler_job.SlurmJob.submit

SlurmJob.submit() → int | None

Submit the job to the SLURM scheduler.

This method saves the job script to the specified script_path and submits it to the SLURM scheduler using the sbatch command. It extracts and stores the job ID assigned by SLURM to the ‘id’ attribute.

Returns:

job_id (int) – The unique job ID assigned by the SLURM scheduler.

Raises:

RuntimeError – If the sbatch command fails or if the job ID cannot be extracted from the submission output.