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.PBSJob.submit

PBSJob.submit() → int | None

Submit the job to the PBS scheduler.

This method saves the job script to the specified script_path and submits it to the PBS scheduler using the qsub command. It extracts and stores the job ID assigned by PBS.

Returns:

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

Raises:

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