Section FARMING

• Describes a farming job, in which multiple inputs are executed. The RUN_TYPE in the global section has to be set to NONE for FARMING. The different groups are executed in parallel. The jobs inside the same groups in series.

• Section path: CP2K_INPUT / FARMING

• This section cannot be repeated.

• Subsections

  • JOB
  • PROGRAM_RUN_INFO
  • RESTART

• Keywords

  • CAPTAIN_MINION
  • CYCLE
  • DO_RESTART
  • GROUP_PARTITION
  • GROUP_SIZE
  • MAX_JOBS_PER_GROUP
  • NGROUPS
  • RESTART_FILE_NAME
  • STRIDE
  • WAIT_TIME

• Keyword descriptions

  CAPTAIN_MINION
  	CAPTAIN_MINION {Logical}
  	If a captain/minion setup should be employed, in which one process (captain) is used to distribute the tasks. This is most useful to load-balance if not all jobs have the same length, and a lot of CPUs/groups are available.
  	This keyword cannot be repeated and it expects precisely one logical.
  	The lone keyword behaves as a switch to .TRUE.
  	Default value: .FALSE.

  CYCLE
  	CYCLE {Logical}
  	If farming should process all jobs in a cyclic way, stopping only if MAX_JOBS_PER_GROUP is exceeded.
  	This keyword cannot be repeated and it expects precisely one logical.
  	The lone keyword behaves as a switch to .TRUE.
  	Default value: .FALSE.

  DO_RESTART
  	DO_RESTART {Logical}
  	Restart a farming job (and should pick up where the previous left off)
  	This keyword cannot be repeated and it expects precisely one logical.
  	The lone keyword behaves as a switch to .TRUE.
  	Default value: .FALSE.

  GROUP_PARTITION
  	GROUP_PARTITION {Integer} ...
  	gives the exact number of processors for each group.
  	This keyword cannot be repeated and it expects a list of integers.

  GROUP_SIZE
  	GROUP_SIZE {Integer}
  	Gives the preferred size of a working group, groups will always be equal or larger than this size.
  	This keyword cannot be repeated and it expects precisely one integer.
  	Default value: 8

  MAX_JOBS_PER_GROUP
  	MAX_JOBS_PER_GROUP {Integer}
  	maximum number of jobs executed per group
  	This keyword cannot be repeated and it expects precisely one integer.
  	Default value: 65535
  	Alias names for this keyword: MAX_JOBS

  NGROUPS
  	NGROUPS {Integer}
  	Gives the preferred number of working groups.
  	This keyword cannot be repeated and it expects precisely one integer.
  	Alias names for this keyword: NGROUP

  RESTART_FILE_NAME
  	RESTART_FILE_NAME {String}
  	Name of the restart file to use for restarting a FARMING run. If not specified the name is determined from PROJECT name.
  	This keyword cannot be repeated and it expects precisely one string.

  STRIDE
  	STRIDE {Integer}
  	Stride to be used when building working groups from the parent MPI comm.Can be used to layout minion groups over nodes in advanced ways (1 rank per node / 2 groups per node).
  	This keyword cannot be repeated and it expects precisely one integer.
  	Default value: 1

  WAIT_TIME
  	WAIT_TIME {Real}
  	Time to wait [s] for a new task if no task is currently available, make this zero if no clock is available
  	This keyword cannot be repeated and it expects precisely one real.
  	Default value: 5.00000000E-001