Class AMSJob

Inheritance Relationships

Derived Types

Class Documentation

class AMSJob
Class Modeling a Job scheduled by AMS. This is a convenience layer on top of a flux JobspecV1
and provides less features than the flux one. We use this abstraction to describe the job specification
in the json file.

Subclassed by ams_jobs.AMSDomainJob, ams_jobs.AMSFSTempStageJob, ams_jobs.AMSMLJob, ams_jobs.AMSOrchestratorJob, ams_jobs.AMSStageJob

Public Functions

__init__(self, str name, str executable, Optional[Mapping[str, str]] environ={}, Optional[AMSJobResources] resources=None, Optional[str] stdout=None, Optional[str] stderr=None, bool ams_log=False, str ams_log_dir="", str ams_log_prefix="", bool is_mpi=False, Optional[List[str]] cli_args=[], Optional[Dict[str, str]] cli_kwargs={})
Attaches a callable that will be called when the future finishes.

:param name: An arbitary name for every job. This can be an arbitary string.
:param executable: A string pointing to the executable to be executed
:param environ: The environment to be used  when scheduling the job.
:param resources: The resources dedicated to this job.
:param stdout File to redirect the stdout.
:param stderr File to redirect the stderr.
:param ams_log: A boolean value to enable the logging of AMS printouts
:param is_mpi: Whether the job is an mpi job.
:param cli_args: positional arguments of the cli command
:param cli_kwargs: key-word arguments of the cli command
:return: ``self``
generate_cli_command(self)
__str__(self)
precede_deploy(self, store, rmq=None)
Will be called by the ams job scheduler just before submitting the job. If there is some modification
required to the submission environment a child class can override this method and do the modification.
resources(self)
The resources property.
resources(self, value)
executable(self)
The executable property.
executable(self, value)
environ(self)
The environ property.
environ(self, value)
stdout(self)
The stdout property.
stdout(self, value)
stderr(self)
The stderr property.
stderr(self, value)
name(self)
The name property.
name(self, value)
from_dict(cls, _dict)
to_dict(self)
to_flux_jobspec(self)

Public Members

environ
executable

Protected Attributes

_name
_executable
_resources
_stdout
_stderr
_cli_args
_cli_kwargs
_is_mpi
_ams_log
_ams_log_dir
_ams_log_prefix
_environ