HPS-MC
Pool Class Reference

Run a set of jobs in a local multiprocessing pool using Python's multiprocessing module. More...

Inheritance diagram for Pool:
Batch

Public Member Functions

def __init__ (self)
 
def submit_job (self, job_id)
 Make this a no-op as we do not implement single job submission for the processing pool. More...
 
def parse_args (self, args)
 Parse command line arguments and perform setup. More...
 
def submit (self)
 Submit jobs to a local processing pool. More...
 
- Public Member Functions inherited from Batch
def default_rundir (self, job_id=None)
 
def build_cmd (self, job_id)
 This is the basic implementation of building a command to run the job from a batch system. More...
 

Public Attributes

 pool_size
 
- 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 Public Attributes

int max_wait = 999999
 

Detailed Description

Run a set of jobs in a local multiprocessing pool using Python's multiprocessing module.

The number of processes to spawn can be provided using the '-p' argument.

Definition at line 806 of file batch.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self)

Reimplemented from Batch.

Definition at line 816 of file batch.py.

Member Function Documentation

◆ parse_args()

def parse_args (   self,
  args 
)

Parse command line arguments and perform setup.

Reimplemented from Batch.

Definition at line 828 of file batch.py.

◆ submit()

def submit (   self)

Submit jobs to a local processing pool.

   This method will not return until all jobs are finished or execution
   is interrupted.

Reimplemented from Batch.

Definition at line 833 of file batch.py.

◆ submit_job()

def submit_job (   self,
  job_id 
)

Make this a no-op as we do not implement single job submission for the processing pool.

Reimplemented from Batch.

Definition at line 822 of file batch.py.

Member Data Documentation

◆ max_wait

int max_wait = 999999
static

Definition at line 814 of file batch.py.

◆ pool_size

pool_size

Definition at line 830 of file batch.py.


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