-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a small tutorial on submitting jobs to Flux. To start, just add a simple example of submitting jobs to Flux using the command line. This tutorial can be expanded later to show how to submit jobs to Flux using its job submission API.
- Loading branch information
Showing
2 changed files
with
58 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
.. _job-submit: | ||
|
||
========================== | ||
How to Submit Jobs in Flux | ||
========================== | ||
|
||
Do you want to submit a job to Flux? Here's a short tutorial on how to do so! | ||
|
||
---------------------------- | ||
Submit Jobs Using Flux's CLI | ||
---------------------------- | ||
|
||
From within a Flux instance, you can submit your job on the command line with | ||
optional arguments, resource options, per task options, and per resource | ||
options: | ||
|
||
.. code-block:: sh | ||
$ flux mini submit --nodes=2 --ntasks=4 --cores-per-task=2 ./my_compute_script.lua 120 | ||
ƒM5k8m7m | ||
$ flux mini submit --nodes=1 --ntasks=1 --cores-per-task=2 ./my_other_script.lua 120 | ||
ƒSUEFPDH | ||
A jobID is returned for every job submitted. You can view the status of your | ||
running jobs with ``flux jobs``: | ||
|
||
.. code-block:: sh | ||
$ flux jobs | ||
JOBID USER NAME ST NTASKS NNODES TIME INFO | ||
ƒSUEFPDH fluxuser my_other_s R 1 1 1.842s | ||
ƒM5k8m7m fluxuser my_compute R 4 2 3.255s | ||
You can also get information about your job by passing in the jobID and a key. | ||
For example, to get resource information about your job: | ||
|
||
.. code-block:: sh | ||
$ flux job info ƒM5k8m7m R | ||
{"version":1,"execution":{"R_lite":[{"rank":"0-1","children":{"core":"0-3"}}]}} | ||
There are a number of keys you can pass to get various information about your job: | ||
|
||
.. code-block:: sh | ||
J | ||
R | ||
eventlog | ||
jobspec | ||
guest.exec.eventlog | ||
guest.input | ||
guest.output | ||
And that's it! If you have any questions, please | ||
`let us know <https://github.com/flux-framework/flux-docs/issues>`_. |