HPS-MC
 
Loading...
Searching...
No Matches
BatchSystem Class Reference

Represents a batch processing system that requires submission like Slurm or Auger. More...

Inheritance diagram for BatchSystem:
Batch Auger LSF Slurm Swif

Public Member Functions

 __init__ (self)
 
 parse_args (self, args)
 Parse command line arguments and perform setup.
 
- Public Member Functions inherited from Batch
 submit_job (self, job_id)
 Submit a single batch job and return the batch ID.
 
 submit (self)
 This is the generic batch submission function which gets a list of jobs to run based on command line arguments and submits them individually.
 
 default_rundir (self, job_id=None)
 
 build_cmd (self, job_id)
 This is the basic implementation of building a command to run the job from a batch system.
 

Public Attributes

 site
 
 email
 
 queue
 
 os
 
 memory
 
 diskspace
 
 job_length
 
- Public Attributes inherited from Batch
 parser
 
 script_name
 
 script
 
 jobstore
 
 debug
 
 log_dir
 
 run_dir
 
 check_output
 
 job_ids
 
 job_steps
 
 start_job_num
 
 end_job_num
 
 config_files
 

Static Protected Member Functions

 _site ()
 
- Static Protected Member Functions inherited from Batch
 _outputs_exist (job)
 Check if all output files exist for the given job.
 

Additional Inherited Members

- Protected Member Functions inherited from Batch
 _logfile (self, job_id)
 Get the base name of a log file for the job.
 
 _get_filtered_job_ids (self)
 Get a list of job IDs to submit based on parsed command line options and whether output files are being checked.
 
 _job_ids_missing_output (self, job_ids)
 Get a list of IDs for jobs that are missing output files.
 

Detailed Description

Represents a batch processing system that requires submission like Slurm or Auger.

This subclasses Batch because it adds a number of different parameters which do not apply to all the batch system types (namely Pool and Local).

Definition at line 231 of file batch.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ (   self)

Reimplemented from Batch.

Reimplemented in LSF, Slurm, Auger, and Swif.

Definition at line 239 of file batch.py.

Member Function Documentation

◆ _site()

_site ( )
staticprotected

Definition at line 271 of file batch.py.

◆ parse_args()

parse_args (   self,
  args 
)

Parse command line arguments and perform setup.

Reimplemented from Batch.

Reimplemented in LSF, Slurm, and Swif.

Definition at line 256 of file batch.py.

Member Data Documentation

◆ diskspace

diskspace

Definition at line 265 of file batch.py.

◆ email

email

Definition at line 261 of file batch.py.

◆ job_length

job_length

Definition at line 266 of file batch.py.

◆ memory

memory

Definition at line 264 of file batch.py.

◆ os

os

Definition at line 263 of file batch.py.

◆ queue

queue

Definition at line 262 of file batch.py.

◆ site

site

Definition at line 254 of file batch.py.


The documentation for this class was generated from the following file: