credit.cli._submit

PBS job submission and training/rollout/realtime command handlers.

Attributes

logger

Functions

_train(→ None)
_rollout(→ None)
_realtime(→ None)
_load_pbs_config(→ dict)	Return the pbs: section from a YAML config file.
_resolve_pbs_opts(→ argparse.Namespace)	Return a copy of args with None fields filled from pbs_cfg then cluster defaults.
_build_pbs_script(→ str)	Return a PBS batch script string for the given args and config path.
_qsub(→ str)	Write script to save_loc/pbs_scripts/, call qsub, and return the job ID string.
_compute_chain(→ int)	Return the number of jobs to chain.
_print_job_plan(→ None)	Print a human-readable summary of what is about to be submitted.
_build_realtime_pbs_script(→ str)	Return a PBS script that runs a single realtime forecast.
_do_submit_realtime(→ None)	Submit a single PBS job for a realtime forecast.
_submit(→ None)	Generate and optionally submit PBS batch scripts, with optional chaining.
_build_rollout_pbs_script(→ str)	Return a PBS script for one subset of an ensemble rollout.
_print_ensemble_rollout_plan(→ None)	Print a human-readable summary of an ensemble rollout submission.
_rollout_ensemble(→ None)	Deprecated: use credit submit --mode rollout instead.
_do_submit_rollout(→ None)	Submit N parallel PBS rollout jobs to cover all init times.

Module Contents

credit.cli._submit.logger

credit.cli._submit._train(args: argparse.Namespace) → None

credit.cli._submit._rollout(args: argparse.Namespace) → None

credit.cli._submit._realtime(args: argparse.Namespace) → None

credit.cli._submit._load_pbs_config(config_path: str) → dict

Return the pbs: section from a YAML config file.

credit.cli._submit._resolve_pbs_opts(args: argparse.Namespace, pbs_cfg: dict) → argparse.Namespace

Return a copy of args with None fields filled from pbs_cfg then cluster defaults.

credit.cli._submit._build_pbs_script(args: argparse.Namespace, config: str, repo: str, account: str = None, depend_on: str = None, save_loc: str = None) → str

Return a PBS batch script string for the given args and config path.

credit.cli._submit._qsub(script: str, save_loc: str | None = None) → str

Write script to save_loc/pbs_scripts/, call qsub, and return the job ID string.

credit.cli._submit._compute_chain(args: argparse.Namespace) → int

Return the number of jobs to chain.

credit.cli._submit._print_job_plan(args: argparse.Namespace, n_jobs: int) → None

Print a human-readable summary of what is about to be submitted.

credit.cli._submit._build_realtime_pbs_script(args: argparse.Namespace, config: str, repo: str, init_time: str, steps: int, save_loc: str = None) → str

Return a PBS script that runs a single realtime forecast.

credit.cli._submit._do_submit_realtime(args: argparse.Namespace) → None

Submit a single PBS job for a realtime forecast.

credit.cli._submit._submit(args: argparse.Namespace) → None

Generate and optionally submit PBS batch scripts, with optional chaining.

credit.cli._submit._build_rollout_pbs_script(args: argparse.Namespace, config: str, repo: str, subset: int, n_subsets: int, save_loc: str = None) → str

Return a PBS script for one subset of an ensemble rollout.

credit.cli._submit._print_ensemble_rollout_plan(args: argparse.Namespace, n_jobs: int, n_forecasts: int, ensemble_size: int) → None

Print a human-readable summary of an ensemble rollout submission.

credit.cli._submit._rollout_ensemble(args: argparse.Namespace) → None

Deprecated: use credit submit --mode rollout instead.

credit.cli._submit._do_submit_rollout(args: argparse.Namespace) → None

Submit N parallel PBS rollout jobs to cover all init times.