qcg.pilotjob.environment module¶
-
class
qcg.pilotjob.environment.
Environment
¶ Bases:
object
Base class for setting job’s environment variables.
-
NAME
¶ name of environment class
Type: str
All parent classes must implement
update_env
method.-
NAME
= 'abstract'
-
update_env
(job, env, opts=None)¶ Update job environment.
Parameters: - job (ExecutionJob) – job data
- env (dict(str,str)) – environment to update
- opts (dict(str,str), optional) – optional preferences for generating environment
-
-
class
qcg.pilotjob.environment.
CommonEnvironment
¶ Bases:
qcg.pilotjob.environment.Environment
The common environment for all execution schemas.
-
NAME
= 'common'¶
-
update_env
(job, env, opts=None)¶ Update job environment.
Parameters: - job (ExecutionJob) – job data
- env (dict(str,str)) – environment to update
- opts (dict(str,str), optional) – optional preferences for generating environment
-
-
class
qcg.pilotjob.environment.
SlurmEnvironment
¶ Bases:
qcg.pilotjob.environment.Environment
The environment compatible with Slurm execution environments.
-
NAME
= 'slurm'¶
-
update_env
(job, env, opts=None)¶ Update job environment.
Parameters: - job (ExecutionJob) – job data
- env (dict(str,str)) – environment to update
- opts (dict(str,str), optional) – optional preferences for generating environment
-
-
qcg.pilotjob.environment.
get_environment
(env_name)¶ Return job execution environment based on the name.
Parameters: env_name (str) – environment name Returns: the environment with selected name Return type: Environment Raises: ValueError
– if environment with given name is not available