Skip to content

Commit

Permalink
docs changes
Browse files Browse the repository at this point in the history
  • Loading branch information
bpuchala committed Oct 17, 2017
1 parent 021b908 commit df26998
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
4 changes: 3 additions & 1 deletion doc/source/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ Some configuration is possible:
|"default" (or null)| Select jobs with jobstatus != 'C' |
+-------------------+------------------------------------------------+
|"check_hostname" | Select jobs with jobstatus != 'C' and matching |
| | hostname |
| | hostname. This is useful on compute clusters |
| | where multiple machines with different queues |
| | share the same ``PRISMS_JOBS_DIR``. |
+-------------------+------------------------------------------------+

- ``"taskmaster_job_kwargs"``: (JSON object, optional)
Expand Down
4 changes: 3 additions & 1 deletion doc/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@ Example screen shot:

Additionally, when scheduling periodic jobs is not allowed other ways, the
``taskmaster`` script can fully automate this process. ``taskmaster`` executes
``pstat --continue`` and then resubmits itself to execute again periodically.
``pstat --continue`` and then resubmits itself to execute again periodically. As
not all compute resources allow this behavior, remember check the policy prior
to using ``taskmaster`` on a new compute resource.

A script marked 'auto' should check itself for completion and when reached execute
``pstat --complete $JOBID --force`` in bash, or ``prisms_jobs.complete_job()``
Expand Down
4 changes: 3 additions & 1 deletion doc/source/scripts/taskmaster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ Summary:
``taskmaster`` submits a job that will repeatedly resubmit any ``Auto`` jobs in
the job database that have completed but whose taskstatus is still ``'Incomplete'``
(perhaps because the jobs has hit the walltime before completing or failed to
converge) and then resubmit itself with a delay before execution.
converge) and then resubmit itself with a delay before execution. As not all
compute resources allow this behavior, remember check the policy prior to using
``taskmaster`` on a new compute resource.

The job submission options can be customized by editing the ``prisms-jobs``
`configuration file`_.
Expand Down

0 comments on commit df26998

Please sign in to comment.