1CAFRUN(1)         cafrun coarray Fortran job launcher manual         CAFRUN(1)
2
3
4

NAME

6       cafrun - Coarray Fortran executable launcher for OpenCoarrays
7

SYNOPSIS

9       cafrun [-s] -np <N> </path/to/coarray-executable> [arg1 [arg2 ...]]
10

DESCRIPTION

12       cafrun  is wrapper script which will launch Coarray Fortran executables
13       across <N> images using the appropriate parallel runtime that OpenCoar‐
14       rays was compiled against, (e.g., mpiexec(1)).  cafrun ensures the cor‐
15       rect flags are passed to the parallel runtime job launcher,  as  deter‐
16       mined  by  system  introspection  at  OpenCoarrays build time. Advanced
17       users may compile their Coarray Fortran code however they  please,  but
18       we recommend using the caf(1)
19
20       compiler wrapper script for a more user friendly experience.
21
22       To  see  the default command run by cafrun, add the -s or --show flags.
23       To see how a specific command would be executed, simply  construct  the
24       command you plan to use to launch your job, and add -s or --show as the
25       very first flag after cafrun, e.g., cafrun -s ... to see how cafrun  is
26       translating  your  invocation  for  the  parallel  runtime job launcher
27       (e.g., mpiexec(1)).
28

OPTIONS

30       --help, -h
31              Print a brief help/usage message and return  without  performing
32              any substantive action.
33
34       -np <N>
35              Mandatory  flag  with  argument to specify the number of Coarray
36              Fortran images to be spawned. <N> must be a positive integer.
37
38       --reenable-auto-cleanup
39              If  OpenCoarrays  is  built  supporting  failed  images,   which
40              requires  GFortran  >=  7.0  and an MPI implementation with user
41              level failure mitigation support (ULFM) and NOT disabling it  at
42              build  time, then cafrun turns OFF mpi auto cleanup, and handles
43              cleanup in the OpenCoarrays library. This is required  to  prop‐
44              erly  support  failed images. --reenable-auto-cleanup re-enables
45              the parallel runtime's auto cleanup features  which  breaks  the
46              failed  images  functionality  but  provides  more  robust error
47              detection and application aborting. If failed images support was
48              not  enabled  at  OpenCoarrays  build  time, then this flag is a
49              noop.
50
51       --show, -s
52              Print the default invocation of  the  underlying  parallel  run‐
53              time's  job  launcher  (e.g., mpiexec), including what flags are
54              passed, etc. This also functions as a dry-run  for  executing  a
55              specific cafrun command, showing the user how the compiler would
56              be called with the additional files and arguments passed by  the
57              user.
58
59       --version, -V, -v
60              Print OpenCoarrays version and copyright information and exit.
61
62       --wrapping, --wraps, -w
63              Report  the  version  of the parallel runtime cafrun is wrapping
64              and exit.
65

BUGS

67       For a list of bugs currently affecting OpenCoarrays, or to report a new
68       one,   please   report   any   bugs  to  the  OpenCoarrays  project  at
69       ⟨https://github.com/sourceryinstitute/OpenCoarrays/issues⟩
70

AUTHOR

72       Izaak Beekman ⟨izaak@izaakbeekman.com⟩
73

SEE ALSO

75       caf(1),   mpiexec(1),   gfortran(1),    OpenCoarrays    project    page
76       ⟨https://github.com/sourceryinstitute/OpenCoarrays#readme⟩,   OpenCoar‐
77       rays website ⟨http://www.opencoarrays.org⟩
78
79
80
81OpenCoarrays-1.9.1                2017-09-12                         CAFRUN(1)