sup3r.solar.solar_cli.kickoff_slurm_job

sup3r.solar.solar_cli.kickoff_slurm_job#

kickoff_slurm_job(ctx, cmd, pipeline_step=None, alloc='sup3r', memory=None, walltime=4, feature=None, stdout_path='./stdout/')[source]#

Run sup3r on HPC via SLURM job submission.

Parameters:

  • ctx (click.pass_context) – Click context object where ctx.obj is a dictionary

  • cmd (str) –

    Command to be submitted in SLURM shell script. Example:

    ‘python -m sup3r.cli forward_pass -c <config_file>’

  • pipeline_step (str, optional) – Name of the pipeline step being run. If None, the pipeline_step will be set to the module_name, mimicking old reV behavior. By default, None.

  • alloc (str) – HPC project (allocation) handle. Example: ‘sup3r’.

  • memory (int) – Node memory request in GB.

  • walltime (float) – Node walltime request in hours.

  • feature (str) – Additional flags for SLURM job. Format is “–qos=high” or “–depend=[state:job_id]”. Default is None.

  • stdout_path (str) – Path to print .stdout and .stderr files.