polaris.job.write_job_script

polaris.job.write_job_script(config, machine, work_dir, nodes=None, target_cores=None, min_cores=None, suite='', script_filename=None, run_command=None)[source]
Parameters:

  • config (polaris.config.PolarisConfigParser) – Configuration options for this test case, a combination of user configs and the defaults for the machine and component

  • machine ({str, None}) – The name of the machine

  • work_dir (str) – The work directory where the job script should be written

  • nodes (int, optional) – The number of nodes for the job. If not provided, it will be calculated based on target_cores and min_cores.

  • target_cores (int, optional) – The target number of cores for the job to use if nodes not provided

  • min_cores (int, optional) – The minimum number of cores for the job to use if nodes not provided

  • suite (str, optional) – The name of the suite

  • script_filename (str, optional) – The name of the job script file to write. If not provided, defaults to ‘job_script.sh’ or ‘job_script.{suite}.sh’ if suite is specified.

  • run_command (str, optional) – The command(s) to run in the job script. If not provided, defaults to ‘polaris serial {{suite}}’.