gemseo / wrappers / job_schedulers

Show inherited members

schedulers_factory module

A factory to instantiate job scheduler interfaes from their class names.

class gemseo.wrappers.job_schedulers.schedulers_factory.SchedulersFactory[source]

Bases: BaseFactory

Job schedulers factory to create job scheduler interfaces from a name.

Return type:

BaseFactory

wrap_discipline(discipline, scheduler_name, workdir_path, **options)[source]

Wrap the discipline within another one to delegate its execution to a job scheduler.

The discipline is serialized to the disk, its input too, then a job file is created from a template to execute it with the provided options. The submission command is launched, it will setup the environment, deserialize the discipline and its inputs, execute it and serialize the outputs. Finally, the deserialized outputs are returned by the wrapper.

All process classes MDOScenario, or MDA, inherit from MDODiscipline so can be sent to HPCs this way.

The job scheduler template script can be provided directly or the predefined templates file names in gemseo.wrappers.job_schedulers.template can be used. SLURM and LSF templates are provided, but one can use other job schedulers or to customize the scheduler commands according to the user needs and infrastructure requirements.

The command to submit the job can also be overloaded.

Parameters:
  • discipline (MDODiscipline) – The discipline to wrap in the job scheduler.

  • scheduler_name (str) – The name of the job scheduler (for instance LSF, SLURM, PBS).

  • workdir_path (Path) – The path to the workdir

  • **options (dict[str, Any]) – The submission options.

Raises:

OSError – If the job template does not exist.

Return type:

JobSchedulerDisciplineWrapper

Warnings: This method serializes the passed discipline so it has to be serializable. All disciplines provided in GEMSEO are serializable but it is possible that custom ones are not and this will make the submission process fail.

failed_imports: dict[str, str]

The class names bound to the import errors.

property scheduler_names: list[str]

The names of the available job scheduler interfaces.